Pages

Each page that your participants see is defined by a Page.

Your page_sequence gives the order of the pages.

If your game has multiple rounds, this sequence will be repeated (see Rounds).

A Page can have any of the following methods and attributes.

is_displayed()

You can define this function to return True if the page should be shown, and False if the page should be skipped. If omitted, the page will be shown.

For example, to only show the page to P2 in each group:

def is_displayed(self):
    return self.player.id_in_group == 2

Or only show the page in round 1:

def is_displayed(self):
    return self.round_number == 1

If you need to repeat the same rule for many pages, use app_after_this_page.

vars_for_template()

Use this to pass variables to the template. Example:

def vars_for_template(self):
    a = self.player.num_apples * 10
    return dict(
        a=a,
        b=1 + 1,
    )

Then in the template you can access a and b like this:

Variables {{ a }} and {{ b }} ...

oTree automatically passes the following objects to the template: player, group, subsession, participant, session, and Constants. You can access them in the template like this: {{ Constants.blah }} or {{ player.blah }}.

If you need to pass the same variables to many pages, see here.

If the user refreshes the page, vars_for_template gets re-executed. Keep this in mind before generating random values in vars_for_template.

before_next_page()

Here you define any code that should be executed after form validation, before the player proceeds to the next page.

If the page is skipped with is_displayed, then before_next_page will be skipped as well.

Example:

def before_next_page(self):
    self.player.tripled_apples = self.player.num_apples * 3

timeout_seconds

See Timeouts

Wait pages

See Wait pages

Randomizing page sequence

You can randomize the order of pages using rounds. An example is here.

app_after_this_page

To skip entire apps, you can define app_after_this_page. For example, to skip to the next app, you would do:

def app_after_this_page(self, upcoming_apps):
    if self.player.whatever:
        return upcoming_apps[0]

upcoming_apps is the remainder of the app_sequence (a list of strings). Therefore, to skip to the last app, you would return upcoming_apps[-1]. Or you could just return a hardcoded string (as long as that string is in upcoming_apps):

def app_after_this_page(self, upcoming_apps):
    print('upcoming_apps is', upcoming_apps)
    if self.player.whatever:
        return "public_goods"

If this function doesn’t return anything, the player proceeds to the next page as usual.