monkeyresponse attribute

Member of

<checkboxes> <dropdown> <image> <listbox> <radiobuttons> <slider> <textbox> <trial> <likert> <openended> <slidertrial>

Syntax

/ monkeyresponse = (character, character,...)

or

/ monkeyresponse = (scancode, scancode, ...)

or

/ monkeyresponse = (anyResponse, noResponse, ...)

or

/ monkeyresponse = (stimulusname, stimulusname, ...)

or

/ monkeyresponse = (mouseevent, mouseevent, ...)

or

/ monkeyresponse = (gamepadevent, gamepadevent, ...)

or

/ monkeyresponse = (joystickevent, joystickevent, ...)

or

/ monkeyresponse = (word, word, ...)

or

/ monkeyresponse = (keyword)

or

/ monkeyresponse = (expression, expression, ...)

Parameters

Name	Type	Description
character	string	A character indicating a valid keyboard response.
scancode	integer	An integer specifying the scancode of a valid keyboard response. To determine the scancode of a given key, use the "Keyboard Scancode..." command on Inquisit's Tools menu, or see the scancodes table for corresponding key value assignments.
mouseevent	mouseeventenum	Value Description dragDrop Dragging and dropping a stimulus lButtonDblClk Left button double-click. lButtonDown Left button press. lButtonUp Left button release. mButtonDblClk Middle button double-click. mButtonDown Middle button press. mButtonUp Middle button release. mouseMove Moving the mouse mouseWheel Moving the mouse wheel rButtonDblClk Right button double-click. rButtonDown Right button press. rButtonUp Right button release. xButton1DblClk xButton1Down xButton1Up xButton2DblClk xButton2Down xButton2Up xButtonNDblClk xButtonNDown xButtonNUp
gamepadevent	gamepadeventenum	Value Description buttonA Button a. buttonB Button b. buttonCenter Center button. buttonDown Down button. buttonGuide Guide button. buttonL1 Button 1. buttonL2 Button 2. buttonL3 Button 3. buttonLeft Left direction button. buttonR1 Right shoulder button. buttonR2 Right trigger button. buttonR3 Right stick button. buttonRight Right direction button. buttonSelect Selection button. buttonStart Start button. buttonUp Up direction button. buttonX X button. buttonY Y button. change Any change in the gamepad controls. leftThumbstickBack Left thumbstick back value. leftThumbstickForward Left thumbstick forward value. leftThumbstickLeft Left thumbstick left value. leftThumbstickRight Left thumbstick right value. rightThumbstickBack Right thumbstick back value. rightThumbstickForward Right thumbstick forward value. rightThumbstickLeft Right thumbstick left value. rightThumbstickRight Right thumbstick right value.
joystickevent	joystickeventenum	Value Description back Joystick moved back. button1 Button 1 was pressed. button10 Button 10 was pressed. button11 Button 11 was pressed. button12 Button 12 was pressed. button13 Button 13 was pressed. button14 Button 14 was pressed. button15 Button 15 was pressed. button16 Button 16 was pressed. button17 Button 17 was pressed. button18 Button 18 was pressed. button19 Button 19 was pressed. button2 Button 2 was pressed. button20 Button 20 was pressed. button21 Button 21 was pressed. button22 Button 22 was pressed. button23 Button 23 was pressed. button24 Button 24 was pressed. button25 Button 25 was pressed. button26 Button 26 was pressed. button27 Button 27 was pressed. button28 Button 28 was pressed. button29 Button 29 was pressed. button3 Button 3 was pressed. button30 Button 30 was pressed. button31 Button 31 was pressed. button32 Button 32 was pressed. button4 Button 4 was pressed. button5 Button 5 was pressed. button6 Button 6 was pressed. button7 Button 7 was pressed. button8 Button 8 was pressed. button9 Button 9 was pressed. change The state of a button, slider, or joystick changed. down Joystick moved down. forward Joystick moved forward. left Joystick moved left. pov1Back Point of view 1 moved back. pov1Forward Point of view 1 moved forward. pov1Left Point of view 1 moved left. pov1Right Point of view 1 moved right. pov2Back Point of view 2 moved back. pov2Forward Point of view 2 moved forward. pov2Left Point of view 2 moved left. pov2Right Point of view 2 moved right. pov3Back Point of view 3 moved back. pov3Forward Point of view 3 moved forward. pov3Left Point of view 3 moved left. pov3Right Point of view 3 moved right. pov4Back Point of view 4 moved back. pov4Forward Point of view 4 moved forward. pov4Left Point of view 4 moved left. pov4Right Point of view 4 moved right. rBack Rotate back. rDown Rotate down. rForward Rotate forward. right Joystick moved right. rLeft Rotate left. rRight Rotate right. rUp Rotate up. slider1Left Slider 1 moved left. slider1Right Slider 1 moved right. slider2Left Slider 2 moved left. slider2Right Slider 2 moved right. up Joystick moved up.
response	responseenum	Value Description anyResponse Any response. noResponse No response.
stimulusname	visualstimulus	The name of a stimulus element defined elsewhere in the script.
word	string	A string (in quotes) indicating a valid spoken or openended response.
keyword	responseenum	Value Description anyResponse Any response. noResponse No response.
expression	value	A dynamic expression that resolves to response value.

Remarks

This attribute specifies a set of responses considered valid for the test monkey when performing this trial. The set can consist of any valid expression, including numbers, strings, and properties. When the test monkey is run and Inquisit encounters this attribute on a given trial, it will randomly select from the responses listed in the attribute. Controlling the monkey's response is useful for testing scripts that behave very differently depending on responding, or that allow the participant to abort the experiment with a particular response. For example, if a script includes an informed consent trial, the monkeyresponse attribute can be used to make sure that the monkey always gives consent.

Examples

The following trial makes sure the monkey always consents to participate:

<trial consent>
/ stimulusTimes=[0=consentform, agreeButton, disagreeButton]
/ inputDevice=mouse
/ validResponse=(agreeButton, disagreeButton)
/ monkeyResponse=("agreeButton")
/ onTrialEnd=[if (trial.consent.response == "disagreeButton") script.abort()]
</trial>

The following trial makes sure the monkey always consents to participate:

<trial example>
/ stimulusTimes=[0=target]
/ inputDevice=keyboard
/ validResponse=("e", "i")
/ monkeyResponse=(values.monkeyresponse)
</trial>