EgoWiki > Documentation > MakingZippyObjects > ZippyKeysyms	EgoWiki webs: Main | TWiki | Know | Sandbox
	Documentation . { Changes | Index | Search | Go }

SDL Keysyms in Zippy

Zippy (as of 0.0.5) defines a number of methods and constants for using the SDLK_ and SDLM_ constants (see the SDL documentation at http://sdldoc.csn.ul.ie/sdlkey.php#AEN4743 on these constants). The constants have the same names as those in the above-mentioned document. In addition, the following methods exist to work with them:

key_to_char(key)
key_to_string(key)
key_to_constant(key)

These functions each return a string with the corresponding character (if applicable), key name, or constant name, respectively, for key. If key_to_char() is called with a key that does not have a corresponding ASCII symbol, nil is returned.

has_num(mod)
has_caps(mod)
has_left_control(mod)
has_right_control(mod)
has_left_shift(mod)
has_right_shift(mod)
has_left_alt(mod)
has_right_alt(mod)
has_control(mod)
has_alt(mod)
has_shift(mod)

These functions return true if mod includes the named modifier. has_control(), has_shift(), and has_alt() return true if mod has either the left-hand version of the modifier or the right-hand version.

Because the value of a modifier may not be one of the global constants (for example, if multiple modifier keys are pressed at once), you should use these functions rather than a straight comparison to determine if a modifier is pressed. A conditional such as:

if mod == SDLM_LCONTROL then
  -- do something...
end

Will only apply if only the left control key was pressed to produce mod.

EgoCodes

EgoCodes represent the range of possible user inputs to Zippy. EgoCode events may be generated with the following function:

generate_egocode(player, egocode, state)

A call to this function generates an egocode event for the numbered player (acceptable values are from one to four) using the given egocode (see below). The event generated is that the given egocode has transitioned to the given state, which is interpreted as a Lua boolean value (either nil or non-nil).

The following "constants" are defined for use with this function:

• EGOBOO_NOINPUT
• EGOBOO_JUMP
• EGOBOO_LEFT_USE
• EGOBOO_LEFT_GET
• EGOBOO_LEFT_PACK
• EGOBOO_RIGHT_USE
• EGOBOO_RIGHT_GET
• EGOBOO_RIGHT_PACK
• EGOBOO_RESPAWN
• EGOBOO_MESSAGE
• EGOBOO_CAMERA_LEFT
• EGOBOO_CAMERA_RIGHT
• EGOBOO_CAMERA_IN
• EGOBOO_CAMERA_OUT
• EGOBOO_ARROWUP
• EGOBOO_ARROWDOWN
• EGOBOO_ARROWLEFT
• EGOBOO_ARROWRIGHT
• EGOBOO_CAMERAMODE
• EGOBOO_SHOWSTAT0
• EGOBOO_SHOWSTAT1
• EGOBOO_SHOWSTAT2
• EGOBOO_SHOWSTAT3
• EGOBOO_SHOWSTAT4
• EGOBOO_SHOWSTAT5
• EGOBOO_SHOWSTAT6
• EGOBOO_SHOWSTAT7
• EGOBOO_GIVEEXPERIENCE
• EGOBOO_SCREENSHOT
• EGOBOO_ESCAPE
• EGOBOO_PAUSEGAME
• EGOBOO_HELPMOUSE
• EGOBOO_HELPJOYSTICK
• EGOBOO_HELPKEYBOARD
• EGOBOO_DEBUGMODE5
• EGOBOO_DEBUGMODE6
• EGOBOO_DEBUGMODE7
• EGOBOO_LEFTSHIFT
• EGOBOO_RIGHTSHIFT
• EGOBOO_INPUTCODES

-- ElminI - 28 Jan 2005