Next Previous Contents

8. Internal TMObject reference

The following objects are used only internally or in saved games. They are of no use in creating plugins or scenarios of your own. These should not be placed in a .tmd or .tml file. They are presented here for completeness' sake only.

8.1 control

This represents an action (key down, joystick movement, etc) that's bound to a certain event ('fire primary weapons', 'return to title screen', etc).

Fields:

empty

A flag indicating that this is an empty event.

event

A number uniquely identifying this event

eventname

A textual name for the event, automatically generated from the SDL function SDL_GetKeyName()

number

A generic numeric indicator. For joystick, it's an axis or button number, for the keyboard it's the key, the button number for a mouse button press, and upon mouse movement it's 0 for the x-axis and 1 for the y-axis.

on

A generic "on/off" indicator - whether the button is pressed or not, etc. Also used for positive/negative.

type

The SDL type of the event (i.e. SDL_MOUSEMOTION, SDL_JOYBUTTONDOWN, etc)

which

Generic 'which' indicator. Joystick number for joysticks.

zero

Special flag indicating that the value is exactly zero.

This object has no children or lists.

8.2 options

These are the player's stored options.

Fields:

width

The width of the screen

height

The height of the screen

fullscreen

Whether or not we're running fullscreen

Children:

directories

The directories to search when loading data. These are string( reference) objects

controls

The player's controls( reference).

This object has no lists.

8.3 string

This exists for when there is a need to have a list of strings. Currently its only use is in the directories child of options( reference).

Fields:

string

The string itself.

This object has no children or lists.

8.4 placeholder

If, in a .tmd/.tms/.tml file, an object references another object which has not yet been created, a placeholder object is given to it instead. This placeholder is then removed when the referenced object is created.

This object has no fields, children, or lists.


Next Previous Contents