Language Reference Guide > Language Reference Guide > System Classes > SpriteDescriptor Class > SpriteKey Method
Was this helpful?
SpriteKey Method
The SpriteKey method creates a lookup key to store or access a response.
You use spritekeys as lookup keys when storing the sprite response objects (agents) that, when applied, will produce a particular sprite behavior. When OpenROAD subsequently responds to mouse actions on fields that support sprites, it creates the corresponding spritekey internally and uses it to find and apply any responses.
The key follows the format: action_modifierkey_responsecode
Sprite keys are a subset of event keys. For more information on event keys, see InputEvent EventKey method (see EventKey Method).
This method has the following syntax:
varchar(32) = SpriteDescriptor.SpriteKey(action = integer, modifierkey = integer,
          responsecode = integer)
This method has the following parameters:
action
(Required) Specifies the action to be responded to. Valid system-defined actions are:
IE_LMOUSEDBLCLK
IE_LMOUSEDOWN
IE_LMOUSEUP
IE_MMOUSEDBLCLK
IE_MMOUSEDOWN
IE_MMOUSEUP
IE_MOUSEENTER
IE_MOUSEEXIT
IE_MOUSEHOVER
IE_MOUSEMOVE
IE_PULSE
IE_RMOUSEDBLCLK
IE_RMOUSEDOWN
IE_RMOUSEUP
IE_TICKPOINT
For more information about system constants for these values, see Input Event Settings.
modifierkey
(Required) Specifies the key or key combination pressed during the action. Valid system-defined values are:
KB_NONE
KB_SHIFT
KB_CONTROL
KB_ALT
KB_SHIFT_LEFT
KB_SHIFT_RIGHT
KB_CONTROL_LEFT
KB_CONTROL_RIGHT
KB_ALT_LEFT
KB_ALT_RIGHT
KB_ESCAPE
KB_FUNCTION
KB_LOGO
For more information about system constants for these values, see Key State Settings.
responsecode
(Required) Specifies which built-in or user-defined behavior applies to this sprite. For sprites, this parameter is mapped to the Response.
User-defined behaviors must use Response values greater than 100.
Valid system-defined values are:
RSP_DRAG
Specifies that the sprite or field can be dragged by the mouse to another location.
RSP_DROPMENU
Specifies that a menu associated with this field is dropped down when this sprite is clicked.
RSP_DROPCHOICE
Specifies that a choicelist associated with this field is dropped down when this sprite is clicked.
For more information about system constants for these values, see Response Settings.
The method returns the spritekey.
Last modified date: 12/20/2023