Skip to content

Mouse Reset Response

A mouse_reset response displays an element that participants must interact with to advance the trial. That element is either a button or a bullseye icon that participants must hover the mouse over before it turns into a button. This is most useful in mouse-tracking studies in order to force the participant's mouse to begin at a certain point. (See also the mouse_reset trial template.)

Required Properties

type

  • Definition: The type of response
  • Possible values: For a mouse position response, type must be specified as "mouse_reset".
1
2
3
{
    "type": "mouse_reset"
}

Optional Properties

alignment

  • Definition: shorthand for the combined properties "button_alignment" and "instruction_alignment"
  • Possible values: "left","right","center"
  • Default: "center"
  • See also: button_alignment, instruction_alignment
1
2
3
4
5
6
{
    "type": "mouse_reset",
    "button_content": "The text in these quotation marks will be displayed.",
    "instruction": "The text in these quotation marks will be displayed.",
    "alignment": "right"
}

button_alignment

  • Definition: Indicates how the button should be aligned (justified). Interactions with the "reset_location" property of the "mouse_reset" trial template to allow for precise placement. For example, if the button is placed in the center right of the screen, setting "button_alignment" to "right" will ensure the button is rendered as close to the right edge of the trial window as possible.
  • Possible values: "left","right","center"
  • Default: "center"
  • See also: alignment
1
2
3
4
5
{
    "type": "mouse_reset",
    "button_content": "The text in these quotation marks will be displayed.",
    "button_alignment": "right"
}

button_content

  • Definition: the text content of the final button
  • Possible values: Any text is allowable.
  • Default: "CONTINUE"
1
2
3
4
{
    "type": "mouse_reset",
    "button_content": "The text in these quotation marks will be displayed."
}

delay

  • Definition: delay the displaying of a response (relative to the latest onset of all stimuli on a given trial) by a certain number of seconds. This setting can be useful for forcing participants to read some text before making a response.
  • Default: 0 (or omission)
  • Possible values: Any numeric value. Decimals are supported.
1
2
3
4
{
    "type": "mouse_reset",
    "delay": 1.2
}

duration_timer

  • Definition: Whether to show a duration timer that indicates the time elapsed since the reponse becomes visible.
  • Possible values: true,false
  • Default: false
1
2
3
4
{
  "type": "mouse_reset",
  "duration_timer": true
}

duration_timer_onset

Dependencies

Requires duration_timer to be set to "true".

  • Definition: When to show the duration timer. When set to "start", the timer will appear as soon as the response is displayed and animate a stopwatch effect. When set to "end", the duration timer will only appear once the participant has made a reponse with no stopwatch effect.
  • Possible values: "start", "end"
  • Default: start
1
2
3
4
5
{
  "type": "mouse_reset",
  "duration_timer": true,
  "duration_timer_onset": "start"
}

hover_required

  • Definition: The property that determines whether or not the participant must hover their mouse in a position for a designated amount of time before the button appears. When set to true, a bullseye icon will indicate where participants must hover their mouse cursor.
  • Default: false
  • Possible values: true, false
1
2
3
4
{
    "type": "mouse_reset",
    "hover_required": true
}

hover_time

  • Definition: The number of seconds for which the participant's mouse must hover over the bullseye icon when "hover_required" is set to true.
  • Possible values: Any numerical value. Decimals are supported.
  • Default: 2
  • See also: hover_required
1
2
3
4
5
{
    "type": "mouse_reset",
    "hover_required": true,
    "hover_time": 4
}

instruction

  • Definition: short text providing the necessary instructions for participants about the current responses. Use empty quotes "" to remove the instruction
  • Possible values: Any text is allowable.
  • Default: "Click the [button_content] button to advance."
1
2
3
4
{
    "type": "mouse_reset",
    "instruction": "The text in these quotation marks will be displayed."
}

instruction_alignment

  • Definition: Indicates how the response instruction should be aligned (justified)
  • Possible values: "left","right","center"
  • Default: "center"
1
2
3
4
5
{
    "type": "mouse_reset",
    "instruction": "The text in these quotation marks will be displayed.",
    "instruction_alignment": "right"
}

parent

  • Definition: If specified, this response will inherit all properties from another defined response (aka, the parent), unless the same property is explicitly defined in this response.
  • Possible values: The name of another defined response.

Given a response named "response1" defined as follows:

1
2
3
4
5
{
  "type": "mouse_reset",
  "alignment": "center",
  "delay": 1.5
}

We can create a child response "response2", that inherits the alignment and delay properties of "response1":

1
2
3
4
{
  "type": "mouse_reset",
  "parent": "response1"
}

Recorded Data

No data is recorded for mouse_reset responses. For duration, see the trial duration.