ludiloom

Ludiloom API

last updated on 2009, May 22nd

Base Concepts	Scene Objects		Data Interface	Gui Overlays
Arena Object ObjectTemplate Presence PresenceTemplate RuleBook System	BillBoard Camera Effect HighlightDecal Light Material MeshDecal	Model Plane River Road Sound StaticFlora Terrain	HashTable InterModel Matrix MediaItem Vector	Button Checkbox CodeEditbox ComboBox Editbox Listbox MenuBar MenuItem	MenuPopup MultiColumn MultilineEditbox ProgressBar RadioButton ScrollBar ScrollPane SliderBar	Spinner StaticImage StaticText TabPane ToggleButton Tree Window

Object

Objects are ... objects.
By default objects don't have any representation so they are 'invisible'. If you want to make a street lamp object you may add to your object a Model representation of a street lamp and a Light reprresentation to project light.
Objects can have representations, attributes, interactions, listeners and other objects.

Representations can be 3D models, lights, sounds, overlays, etc..
Attributes are pairs of strings, name and value, that can be used in the game's simulation to store state, etc.
Interactions are methods that you can program and that are executed when listeners are triggered.
Listeners can be installed in objects or in single representations and trigger interactions. They hierarchical, i.e., if you install a ButtonClicked Listener in the object, and you click in any representation of the object the listener will be triggered. If the representation has a listener of the same type installed is the listener of the representation that is triggered.

Method Summary
`nil`	`addObject (Object original)`
`Object`	`copyObject (Object original)`
`Object`	`copyObject (Object original, string name)`
`representation`	`copyRepresentation (representation original)`
`representation`	`copyRepresentation (representation original, string name)`
`BillBoard`	`createBillboard (string name)`
`Effect`	`createEffect (string name)`
`Light`	`createLight (string name)`
`MeshDecal`	`createMeshDecal (string name, array{} points, string material)`
`Model`	`createModel (string name, MediaItem mediaItem)`
`Object`	`createObject (string templateName, string name, string description)`
`overlay`	`createOverlay (string name, number type, MediaItem mediaitem, number x, number y, number sx, number sy)`
`Plane`	`createPlane (string name)`
`River`	`createRiver (string name)`
`Road`	`createRoad (string name)`
`Sound`	`createSound (string name, MediaItem mediaitem)`
`StaticFlora`	`createStaticFlora (string name, MediaItem densityMap)`
`<type>,...,<type>`	`exec (string name, string args)`
`string, InterModel`	`getAIMovementOnStartListener ()`
`string, InterModel`	`getAIMovementOnStopListener ()`
`string`	`getAttribute (string name)`
`hastable{string,string}`	`getAttributes ()`
`BillBoard`	`getBillboard (string name)`
`array{BillBoard}`	`getBillboards ()`
`Object`	`getContainer ()`
`string`	`getDescription ()`
`Effect`	`getEffect (string name)`
`array{Effect}`	`getEffects ()`
`string`	`getID ()`
`Light`	`getLight (string name)`
`array{Light}`	`getLights ()`
`MeshDecal`	`getMeshDecal (string name)`
`array{}`	`getMeshDecals ()`
`Model`	`getModel (string name)`
`array{Model}`	`getModels ()`
`Object, string, InterModel, boolean, string`	`getMouseButtonClickedListener (number mousekey)`
`Object, string, InterModel, boolean, string`	`getMouseButtonClickedListener (number mousekey, boolean ctrl, boolean alt, boolean shift)`
`Object, string, InterModel, boolean, string`	`getMouseButtonDoubleClickedListener (number mousekey)`
`Object, string, InterModel, boolean, string`	`getMouseButtonDoubleClickedListener (number mousekey, boolean ctrl, boolean alt, boolean shift)`
`Object, string, InterModel, boolean, string`	`getMouseButtonPressedListener (number mousekey)`
`Object, string, InterModel, boolean, string`	`getMouseButtonPressedListener (number mousekey, boolean ctrl, boolean alt, boolean shift)`
`Object, string, InterModel, boolean, string`	`getMouseButtonReleasedListener (number mousekey)`
`Object, string, InterModel, boolean, string`	`getMouseButtonReleasedListener (number mousekey, boolean ctrl, boolean alt, boolean shift)`
`Object, string, InterModel, boolean, string`	`getMouseEnteredListener ()`
`Object, string, InterModel, boolean, string`	`getMouseEnteredListener (boolean ctrl, boolean alt, boolean shift)`
`Object, string, InterModel, boolean, string`	`getMouseMovedListener ()`
`Object, string, InterModel, boolean, string`	`getMouseMovedListener (boolean ctrl, boolean alt, boolean shift)`
`Object, string, InterModel, boolean, string`	`getMouseWheelMovedListener (number mousekey)`
`Object, string, InterModel, boolean, string`	`getMouseWheelMovedListener (number mousekey, boolean ctrl, boolean alt, boolean shift)`
`string`	`getName ()`
`Object`	`getObject (string objectID)`
`array{Object}`	`getObjects ()`
`array{Object}`	`getObjectsByName (string Name)`
`array{Object}`	`getObjectsByTemplate (string templateName)`
`string`	`getOnLoadListener ()`
`string`	`getOnUnloadListener ()`
`Overlay`	`getOverlay (string name)`
`array{}`	`getOverlays ()`
`Plane`	`getPlane (string name)`
`array{Plane}`	`getPlanes ()`
`Object, string, InterModel, boolean, string`	`getRayHitListener ()`
`representation`	`getRepresentation (string name, number type)`
`array{}`	`getRepresentations ()`
`River`	`getRiver (string name)`
`array{River}`	`getRivers ()`
`Road`	`getRoad (string name)`
`array{Road}`	`getRoads ()`
`Sound`	`getSound (string name)`
`array{Sound}`	`getSounds ()`
`StaticFlora`	`getStaticFlora (string name)`
`array{StaticFlora}`	`getStaticFloras ()`
`objectTemplate`	`getTemplate ()`
`string, number, number`	`getTimerListener (number codeID, string objectID)`
`number`	`getType ()`
`boolean`	`hasAIMovementOnStartListener ()`
`boolean`	`hasAIMovementOnStopListener ()`
`boolean`	`hasAttribute (string name)`
`boolean`	`hasModel (string name)`
`boolean`	`hasMouseButtonClickedListener (number mousekey)`
`boolean`	`hasMouseButtonClickedListener (number mousekey, boolean ctrl, boolean alt, boolean shift)`
`boolean`	`hasMouseButtonDoubleClickedListener (number mousekey)`
`boolean`	`hasMouseButtonDoubleClickedListener (number mousekey, boolean ctrl, boolean alt, boolean shift)`
`boolean`	`hasMouseButtonPressedListener (number mousekey)`
`boolean`	`hasMouseButtonPressedListener (number mousekey, boolean ctrl, boolean alt, boolean shift)`
`boolean`	`hasMouseButtonReleasedListener (number mousekey)`
`boolean`	`hasMouseButtonReleasedListener (number mousekey, boolean ctrl, boolean alt, boolean shift)`
`boolean`	`hasMouseEnteredListener ()`
`boolean`	`hasMouseEnteredListener (boolean ctrl, boolean alt, boolean shift)`
`boolean`	`hasMouseMovedListener ()`
`boolean`	`hasMouseMovedListener (boolean ctrl, boolean alt, boolean shift)`
`boolean`	`hasMouseWheelMovedListener (number mousekey)`
`boolean`	`hasMouseWheelMovedListener (number mousekey, boolean ctrl, boolean alt, boolean shift)`
`boolean`	`hasObject (string objectID)`
`boolean`	`hasOnLoadListener ()`
`boolean`	`hasOnUnloadListener ()`
`boolean`	`hasRayHitListener ()`
`boolean`	`hasRiver (string name)`
`boolean`	`hasRoad (string name)`
`boolean`	`hasStaticFlora (string name)`
`boolean`	`hasTimerListener (unsigned char)`
`boolean`	`isPersistent ()`
`boolean`	`isVisible ()`
`nil`	`print ()`
`nil`	`removeAIMovementOnStartListener ()`
`nil`	`removeAIMovementOnStopListener ()`
`nil`	`removeAllAttributes ()`
`nil`	`removeAllBillboards ()`
`nil`	`removeAllEffects ()`
`nil`	`removeAllLights ()`
`nil`	`removeAllMeshDecals ()`
`nil`	`removeAllModels ()`
`nil`	`removeAllObjects ()`
`nil`	`removeAllObjectsByName (string name)`
`nil`	`removeAllObjectsByTemplate (string templateName)`
`nil`	`removeAllOverlays ()`
`nil`	`removeAllPlanes ()`
`nil`	`removeAllRepresentations ()`
`nil`	`removeAllRivers ()`
`nil`	`removeAllRoads ()`
`nil`	`removeAllSounds ()`
`nil`	`removeAllStaticFloras ()`
`nil`	`removeAttribute (string name)`
`nil`	`removeBillboard (string name)`
`nil`	`removeEffect (string name)`
`nil`	`removeLight (string name)`
`nil`	`removeMeshDecal (string name)`
`nil`	`removeModel (string name)`
`nil`	`removeMouseButtonClickedListener (number mousekey)`
`nil`	`removeMouseButtonClickedListener (number mousekey, boolean ctrl, boolean alt, boolean shift)`
`nil`	`removeMouseButtonDoubleClickedListener (number mousekey)`
`nil`	`removeMouseButtonDoubleClickedListener (number mousekey, boolean ctrl, boolean alt, boolean shift)`
`nil`	`removeMouseButtonPressedListener (number mousekey)`
`nil`	`removeMouseButtonPressedListener (number mousekey, boolean ctrl, boolean alt, boolean shift)`
`nil`	`removeMouseButtonReleasedListener (number mousekey)`
`nil`	`removeMouseButtonReleasedListener (number mousekey, boolean ctrl, boolean alt, boolean shift)`
`nil`	`removeMouseEnteredListener ()`
`nil`	`removeMouseEnteredListener (boolean ctrl, boolean alt, boolean shift)`
`nil`	`removeMouseMovedListener ()`
`nil`	`removeMouseMovedListener (boolean ctrl, boolean alt, boolean shift)`
`nil`	`removeMouseWheelMovedListener (number mousekey)`
`nil`	`removeMouseWheelMovedListener (number mousekey, boolean ctrl, boolean alt, boolean shift)`
`nil`	`removeObject (string objectID)`
`nil`	`removeOnLoadListener ()`
`nil`	`removeOnUnloadListener ()`
`nil`	`removeOverlay (string name)`
`nil`	`removePlane (string name)`
`nil`	`removeRayHitListener ()`
`nil`	`removeRepresentation (string name, number type)`
`nil`	`removeRiver (string name)`
`nil`	`removeRoad (string name)`
`nil`	`removeSound (string name)`
`nil`	`removeStaticFlora (string name)`
`nil`	`removeTimerListener (number codeID)`
`nil`	`setAIMovementOnStartListener (string name, InterModel interactionModel)`
`nil`	`setAIMovementOnStopListener (string name, InterModel interactionModel)`
`nil`	`setAttribute (string name, string value)`
`nil`	`setDescription (string description)`
`nil`	`setMouseButtonDoubleClickedListener (number mousekey, Object target, string name, InterModel interactionModel)`
`nil`	`setMouseButtonDoubleClickedListener (number mousekey, Object target, string name, InterModel interactionModel, boolean ctrl, boolean alt, boolean shift, boolean global, string channel)`
`nil`	`setMouseButtonPressedListener (number mousekey, Object target, string name, InterModel interactionModel)`
`nil`	`setMouseButtonPressedListener (number mousekey, Object target, string name, InterModel interactionModel, boolean ctrl, boolean alt, boolean shift, boolean global, string channel)`
`nil`	`setMouseButtonReleasedListener (number mousekey, Object target, string name, InterModel interactionModel)`
`nil`	`setMouseButtonReleasedListener (number mousekey, Object target, string name, InterModel interactionModel, boolean ctrl, boolean alt, boolean shift, boolean global, string channel)`
`nil`	`setMouseEnteredListener (Object target, string name, InterModel interactionModel)`
`nil`	`setMouseEnteredListener (Object target, string name, InterModel interactionModel, boolean ctrl, boolean alt, boolean shift, boolean global, string channel)`
`nil`	`setMouseMovedListener (Object target, string name, InterModel interactionModel)`
`nil`	`setMouseMovedListener (Object target, string name, InterModel interactionModel, boolean ctrl, boolean alt, boolean shift, boolean global, string channel)`
`nil`	`setMouseWheelMovedListener (number mousekey, Object target, string name, InterModel interactionModel)`
`nil`	`setMouseWheelMovedListener (number mousekey, Object target, string name, InterModel interactionModel, boolean ctrl, boolean alt, boolean shift, boolean global, string channel)`
`nil`	`setName (string name)`
`nil`	`setOnLoadListener (string name)`
`nil`	`setOnUnloadListener (string name)`
`nil`	`setPersistent (boolean isPersistent)`
`nil`	`setRayHitListener (Object target, string name, InterModel interactionModel)`
`nil`	`setRayHitListener (Object target, string name, InterModel interactionModel, boolean global, string channel)`
`nil`	`setTimerListener (number codeID, Object target, string name, InterModel interactionModel, number type, number deltaT)`
`nil`	`setVisible (boolean visible)`

Method Detail

addObject

nil addObject (Object original)

Adds an Object to this Object.

Parameters:: Object original - Object to add.

copyObject

Object copyObject (Object original)

Clones an object in this Object.

Parameters:: Object original - Object to clone.

Returns:: Object - The cloned object.

copyObject

Object copyObject (Object original, string name)

Clones an object in this Object with the specified name.

Parameters:: Object original - Object to clone.; string name - Name of the cloned object.

Returns:: Object - The cloned object.

copyRepresentation

representation copyRepresentation (representation original)

Clones a representation in the arena.

Parameters:: representation original - Representation to clone.

Returns:: representation - The cloned representation.

copyRepresentation

representation copyRepresentation (representation original, string name)

Clones a representation in the arena with the specified name.

Parameters:: representation original - Representation to clone.; string name - Name of the cloned representation.

Returns:: representation - The cloned representation.

createBillboard

BillBoard createBillboard (string name)

Creates a billboard in the Object with the specified name. The other values will be set to default.

Parameters:: string name - Name of the Billbloard

Returns:: BillBoard - The new billboard.

createEffect

Effect createEffect (string name)

Creates an effect in the Object with the specified name. The other values will be set to default.

Parameters:: string name - Name that identifies the effect.

Returns:: Effect - New effect with the specified name.

createLight

Light createLight (string name)

Creates a light in the Object with the specified name.

Parameters:: string name - Name that identifies the light.

Returns:: Light - New light with the specified name.

createMeshDecal

MeshDecal createMeshDecal (string name, array{} points, string material)

Creates an mesh decal in the arena.

Parameters:: string name - Name of the mesh decal.; array{} points - The points (x,z) that define the perimeter of the Mesh Decal.; string material - Name of the material to be used on the decal

Returns:: MeshDecal - The new MeshDecal.

createModel

Model createModel (string name, MediaItem mediaItem)

Creates a model in the Object with the specified name.

Parameters:: string name - Name that identifies the model.; MediaItem mediaItem - MediaItem of the mesh.

Returns:: Model - New model with the specified name.

createObject

Object createObject (string templateName, string name, string description)

Creates an object in this Object.

Parameters:: string templateName - Name of the object template.; string name - Name of the object.; string description - Description of the object.

Returns:: Object - The new object.

createOverlay

overlay createOverlay (string name, number type, MediaItem mediaitem, number x, number y, number sx, number sy)

Adds an overlay to the Object.

Parameters:: string name - Name of the Object; number type - Type of the Overlay: OVT_WINDOW, OVT_BUTTON, OVT_CHECK_BOX, OVT_COMBO_BOX, OVT_EDIT_BOX, OVT_MULTILINE_EDIT_BOX, OVT_PROGRESS_BAR, OVT_SPINNER, OVT_RADIO_BUTTON, OVT_SCROLL_BAR_VERT, OVT_SCROLL_BAR_HORZ, OVT_SLIDER_BAR, OVT_STATIC_TEXT, OVT_STATIC_IMAGE, OVT_TAB_PANE, OVT_LIST_BOX, OVT_MENU_BAR, OVT_MENU_ITEM, OVT_MENU_POPUP, OVT_MULTICOLUMN_LIST, OVT_CODE_EDIT_BOX, OVT_SCROLL_PANE, OVT_TOGGLE_BUTTON or OVT_TREE.; MediaItem mediaitem - Media Item of the look n' feel to be applied to the Object.; number x - X coordinate of the position of the Object.; number y - Y coordinate of the position of the Object.; number sx - Width of the Object.; number sy - Height of the Object.

Returns:: overlay - The new overlay.

createPlane

Plane createPlane (string name)

Creates a plane in the Object with the specified name.

Parameters:: string name - Name that identifies the plane.

Returns:: Plane - plane New plane with the specified name.

createRiver

River createRiver (string name)

Creates a river in the Object with the specified name.

Parameters:: string name - Name that identifies the river.

Returns:: River - river New river with the specified name.

createRoad

Road createRoad (string name)

Creates a road in the Object with the specified name.

Parameters:: string name - Name that identifies the road.

Returns:: Road - road New road with the specified name.

createSound

Sound createSound (string name, MediaItem mediaitem)

Creates a sound in the Object with the specified name.

Parameters:: string name - Name that identifies the sound.; MediaItem mediaitem - Media Item of the sound.

Returns:: Sound - New sound with the specified name.

createStaticFlora

StaticFlora createStaticFlora (string name, MediaItem densityMap)

Creates a static flora in the Object with the specified name.

Parameters:: string name - Name that identifies the static flora.; MediaItem densityMap - MediaItem of the density map to be used

Returns:: StaticFlora - New static flora with the specified name.

exec

<type>,...,<type> exec (string name, string args)

Executes the specified interaction on the Object.

Parameters:: string name - Name of the interaction.; string args - Arguments of the interaction. This function can have zero or more arguments.

Returns:: <type>,...,<type> - Return values.

getAIMovementOnStartListener

string, InterModel getAIMovementOnStartListener ()

Returns the listener information of the 'pathfind started' event of the Object.

Returns:: string - Name of the interaction.; InterModel - Arguments of the interaction that will be executed when this listener is activated.

getAIMovementOnStopListener

string, InterModel getAIMovementOnStopListener ()

Returns the listener information of the 'pathfind stopped' event of the Object.

Returns:: string - Name of the interaction.; InterModel - Arguments of the interaction that will be executed when this listener is activated.

getAttribute

string getAttribute (string name)

Returns the value of the attribute of the specified name.

Parameters:: string name - Name of the attribute.

Returns:: string - Value of the attribute.

getAttributes

hastable{string,string} getAttributes ()

Returns an hashtable containg pairs of attribute name and attribute value.

Returns:: hastable{string,string} - Hashtable containg pairs of attribute name and attribute value.

getBillboard

BillBoard getBillboard (string name)

Returns the billboard with name 'name'.

Parameters:: string name - Name of the billboard you are seaching for.

Returns:: BillBoard - Billboard you are searching for.

getBillboards

array{BillBoard} getBillboards ()

Returns all billboards available in the Object.

Returns:: array{BillBoard} - Billboards available in the Object.

getContainer

Object getContainer ()

Returns the object that contains this object.

Returns:: Object - Object that contains this object. Can be of type presence, object or arena.

getDescription

string getDescription ()

Returns the description of the Object.

Returns:: string - Description if the Object.

getEffect

Effect getEffect (string name)

Returns the material with name 'name'.

Parameters:: string name - Name of the effect you are searching for.

Returns:: Effect - The effect you are searching for.

getEffects

array{Effect} getEffects ()

Returns the effects available in the Object.

Returns:: array{Effect} - Effects available in the Object.

getID

string getID ()

Returns the object ID.

Returns:: string - Object ID.

getLight

Light getLight (string name)

Returns a light in the Object with the specified name.

Parameters:: string name - Name that identifies the light.

Returns:: Light - Light with the specified name.

getLights

array{Light} getLights ()

Returns an array containig the lights of the Object.

Returns:: array{Light} - Array containig the lights of the object.

getMeshDecal

MeshDecal getMeshDecal (string name)

Returns the mesh decal of the specified name.

Parameters:: string name - Name of the mesh decal to return.

Returns:: MeshDecal - The mesh decal of the specified name.

getMeshDecals

array{} getMeshDecals ()

Returns an array of the mesh decals in the arena.

Returns:: array{} - Array of the mesh decals in the arena.

getModel

Model getModel (string name)

Returns the model with name 'name'

Parameters:: string name - Name of the model you want to get.

Returns:: Model - The model you are searching for.

getModels

array{Model} getModels ()

Returns an array of models available in the Object.

Returns:: array{Model} - Models of the Object

getMouseButtonClickedListener

Object, string, InterModel, boolean, string getMouseButtonClickedListener (number mousekey)

Returns the 'mouse button clicked' listener of the Object.

Parameters:: number mousekey - Mouse key that will trigger the event: MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE or MOUSE_BUTTON_RIGHT.

Returns:: Object - The object that contains the interaction that will be executed.; string - Name of the interaction.; InterModel - Arguments of the interaction that will be executed when this listener is activated.; boolean - 'True' if this listener is executed globally, 'false' if it is executed only locally.; string - The channel of the listener.

getMouseButtonClickedListener

Object, string, InterModel, boolean, string getMouseButtonClickedListener (number mousekey, boolean ctrl, boolean alt, boolean shift)

Returns the 'mouse button clicked' listener of the Object.

Parameters:: number mousekey - Mouse key that will trigger the event: MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE or MOUSE_BUTTON_RIGHT.; boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.; boolean alt - Whether the key combination includes the 'alt' modifier key.; boolean shift - Whether the key combination includes the 'shift' modifier key.

Returns:: Object - The object that contains the interaction that will be executed.; string - Name of the interaction.; InterModel - Arguments of the interaction that will be executed when this listener is activated.; boolean - 'True' if this listener is executed globally, 'false' if it is executed only locally.; string - The channel of the listener.

getMouseButtonDoubleClickedListener

Object, string, InterModel, boolean, string getMouseButtonDoubleClickedListener (number mousekey)

Returns the 'mouse button double clicked' listener of the Object.

Parameters:: number mousekey - Mouse key that will trigger the event: MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE or MOUSE_BUTTON_RIGHT.

Returns:: Object - The object that contains the interaction that will be executed.; string - Name of the interaction.; InterModel - Arguments of the interaction that will be executed when this listener is activated.; boolean - 'True' if this listener is executed globally, 'false' if it is executed only locally.; string - The channel of the listener.

getMouseButtonDoubleClickedListener

Object, string, InterModel, boolean, string getMouseButtonDoubleClickedListener (number mousekey, boolean ctrl, boolean alt, boolean shift)

Returns the 'mouse button double clicked' listener of the Object.

Parameters:: number mousekey - Mouse key that will trigger the event: MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE or MOUSE_BUTTON_RIGHT.; boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.; boolean alt - Whether the key combination includes the 'alt' modifier key.; boolean shift - Whether the key combination includes the 'shift' modifier key.

Returns:: Object - The object that contains the interaction that will be executed.; string - Name of the interaction.; InterModel - Arguments of the interaction that will be executed when this listener is activated.; boolean - 'True' if this listener is executed globally, 'false' if it is executed only locally.; string - The channel of the listener.

getMouseButtonPressedListener

Object, string, InterModel, boolean, string getMouseButtonPressedListener (number mousekey)

Returns the 'mouse button pressed' listener of the Object.

Parameters:: number mousekey - Mouse key that will trigger the event: MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE or MOUSE_BUTTON_RIGHT.

Returns:: Object - The object that contains the interaction that will be executed.; string - Name of the interaction.; InterModel - Arguments of the interaction that will be executed when this listener is activated.; boolean - 'True' if this listener is executed globally, 'false' if it is executed only locally.; string - The channel of the listener.

getMouseButtonPressedListener

Object, string, InterModel, boolean, string getMouseButtonPressedListener (number mousekey, boolean ctrl, boolean alt, boolean shift)

Returns the 'mouse button pressed' listener of the Object.

Parameters:: number mousekey - Mouse key that will trigger the event: MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE or MOUSE_BUTTON_RIGHT.; boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.; boolean alt - Whether the key combination includes the 'alt' modifier key.; boolean shift - Whether the key combination includes the 'shift' modifier key.

Returns:: Object - The object that contains the interaction that will be executed.; string - Name of the interaction.; InterModel - Arguments of the interaction that will be executed when this listener is activated.; boolean - 'True' if this listener is executed globally, 'false' if it is executed only locally.; string - The channel of the listener.

getMouseButtonReleasedListener

Object, string, InterModel, boolean, string getMouseButtonReleasedListener (number mousekey)

Returns the 'mouse button released' listener of the Object.

Parameters:: number mousekey - Mouse key that will trigger the event: MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE or MOUSE_BUTTON_RIGHT.

Returns:: Object - The object that contains the interaction that will be executed.; string - name of the interaction.; InterModel - Arguments of the interaction that will be executed when this listener is activated.; boolean - 'True' if this listener is executed globally, 'false' if it is executed only locally.; string - The channel of the listener.

getMouseButtonReleasedListener

Object, string, InterModel, boolean, string getMouseButtonReleasedListener (number mousekey, boolean ctrl, boolean alt, boolean shift)

Returns the 'mouse button released' listener of the Object.

Parameters:: number mousekey - Mouse key that will trigger the event: MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE or MOUSE_BUTTON_RIGHT.; boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.; boolean alt - Whether the key combination includes the 'alt' modifier key.; boolean shift - Whether the key combination includes the 'shift' modifier key.

Returns:: Object - The object that contains the interaction that will be executed.; string - Name of the interaction.; InterModel - Arguments of the interaction that will be executed when this listener is activated.; boolean - 'True' if this listener is executed globally, 'false' if it is executed only locally.; string - The channel of the listener.

getMouseEnteredListener

Object, string, InterModel, boolean, string getMouseEnteredListener ()

Returns the 'mouse left' listener of the Object.

Returns:: Object - The object that contains the interaction that will be executed.; string - Name of the interaction.; InterModel - Arguments of the interaction that will be executed when this listener is activated.; boolean - 'True' if this listener is executed globally, 'false' if it is executed only locally.; string - The channel of the listener.

getMouseEnteredListener

Object, string, InterModel, boolean, string getMouseEnteredListener (boolean ctrl, boolean alt, boolean shift)

Returns the 'mouse left' listener of the Object.

Parameters:: boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.; boolean alt - Whether the key combination includes the 'alt' modifier key.; boolean shift - Whether the key combination includes the 'shift' modifier key.

Returns:: Object - The object that contains the interaction that will be executed.; string - Name of the interaction.; InterModel - Arguments of the interaction that will be executed when this listener is activated.; boolean - 'True' if this listener is executed globally, 'false' if it is executed only locally.; string - The channel of the listener.

getMouseMovedListener

Object, string, InterModel, boolean, string getMouseMovedListener ()

Returns the 'mouse moved' listener of the Object.

Returns:: Object - The object that contains the interaction that will be executed.; string - Name of the interaction.; InterModel - Arguments of the interaction that will be executed when this listener is activated.; boolean - 'True' if this listener is executed globally, 'false' if it is executed only locally.; string - The channel of the listener.

getMouseMovedListener

Object, string, InterModel, boolean, string getMouseMovedListener (boolean ctrl, boolean alt, boolean shift)

Returns the 'mouse moved' listener of the Object.

Parameters:: boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.; boolean alt - Whether the key combination includes the 'alt' modifier key.; boolean shift - Whether the key combination includes the 'shift' modifier key.

Returns:: Object - The object that contains the interaction that will be executed.; string - Name of the interaction.; InterModel - Arguments of the interaction that will be executed when this listener is activated.; boolean - 'True' if this listener is executed globally, 'false' if it is executed only locally.; string - The channel of the listener.

getMouseWheelMovedListener

Object, string, InterModel, boolean, string getMouseWheelMovedListener (number mousekey)

Returns the 'mouse wheel moved' listener of the Object.

Parameters:: number mousekey - Mouse wheel movement that will trigger the event: MOUSE_WHEEL_DOWN or MOUSE_WHEEL_DOWN.

Returns:: Object - The object that contains the interaction that will be executed.; string - Name of the interaction.; InterModel - Arguments of the interaction that will be executed when this listener is activated.; boolean - 'True' if this listener is executed globally, 'false' if it is executed only locally.; string - The channel of the listener.

getMouseWheelMovedListener

Object, string, InterModel, boolean, string getMouseWheelMovedListener (number mousekey, boolean ctrl, boolean alt, boolean shift)

Returns the 'mouse wheel moved' listener of the Object.

Parameters:: number mousekey - Mouse wheel movement that will trigger the event: MOUSE_WHEEL_DOWN or MOUSE_WHEEL_DOWN.; boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.; boolean alt - Whether the key combination includes the 'alt' modifier key.; boolean shift - Whether the key combination includes the 'shift' modifier key.

Returns:: Object - The object that contains the interaction that will be executed.; string - Name of the interaction.; InterModel - Arguments of the interaction that will be executed when this listener is activated.; boolean - 'True' if this listener is executed globally, 'false' if it is executed only locally.; string - The channel of the listener.

getName

string getName ()

Returns the name of the Object.

Returns:: string - Name of the Object.

getObject

Object getObject (string objectID)

Returns the object with the specified ID from this Object.

Parameters:: string objectID - Identifier of the object.

Returns:: Object - Object with the specified ID.

getObjects

array{Object} getObjects ()

Returns an array containing all objects in this Object.

Returns:: array{Object} - Array containing all objects in this Object.

getObjectsByName

array{Object} getObjectsByName (string Name)

Returns an array containg all objects in this Object with the specified name.

Parameters:: string Name - of the objects to return.

Returns:: array{Object} - Array containg all objects in this Object with the specified name.

getObjectsByTemplate

array{Object} getObjectsByTemplate (string templateName)

Returns an array containg all objects in this Object that follow the specified template.

Parameters:: string templateName - Name of the template.

Returns:: array{Object} - Array containg all objects in this Object that follow the specified template.

getOnLoadListener

string getOnLoadListener ()

Returns the name of the interaction to be called upon a 'on load' event.

Returns:: string - Interaction to be called upon a 'on load' event.

getOnUnloadListener

string getOnUnloadListener ()

Returns the name of the interaction to be called upon a 'on unload' event.

Returns:: string - Interaction to be called upon a 'on unload' event.

getOverlay

Overlay getOverlay (string name)

Returns an Overlay identified by name contained in this Object.

Parameters:: string name - Name of the Overlay.

Returns:: Overlay - The child Overlay identified by name.

getOverlays

array{} getOverlays ()

Returns the Overlays contained in this Object.

Returns:: array{} - Overlays contained in this Object.

getPlane

Plane getPlane (string name)

Returns the plane with name 'name'

Parameters:: string name - Name of the plane you want to get.

Returns:: Plane - The plane you are searching for.

getPlanes

array{Plane} getPlanes ()

Returns all planes of the Object.

Returns:: array{Plane} - Planes of the Object.

getRayHitListener

Object, string, InterModel, boolean, string getRayHitListener ()

Returns the 'mouse entered' listener of the Object.

Returns:: Object - The object that contains the interaction that will be executed.; string - Name of the interaction.; InterModel - Arguments of the interaction that will be executed when this listener is activated.; boolean - 'True' if this listener is executed globally, 'false' if it is executed only locally.; string - The channel of the listener.

getRepresentation

representation getRepresentation (string name, number type)

Returns the representation with the specified name and type.

Parameters:: string name - Name of the representation.; number type - Type of the representation.

Returns:: representation - The representation with the specified name and type.

getRepresentations

array{} getRepresentations ()

Returns an array containing all representations in the arena.

Returns:: array{} - Array containing all representations in the arena.

getRiver

River getRiver (string name)

Returns the river with name 'name'

Parameters:: string name - Name of the river you want to get.

Returns:: River - The river you are searching for.

getRivers

array{River} getRivers ()

Returns all rivers of the Object.

Returns:: array{River} - Rivers of the Object.

getRoad

Road getRoad (string name)

Returns the road with name 'name'

Parameters:: string name - Name of the road you want to get.

Returns:: Road - The road you are searching for.

getRoads

array{Road} getRoads ()

Returns all roads of the Object.

Returns:: array{Road} - Roads of the Object.

getSound

Sound getSound (string name)

Returns the sound with name 'name'

Parameters:: string name - Name of the sound you want to get.

Returns:: Sound - Sound you want to search for.

getSounds

array{Sound} getSounds ()

Returns the sounds available in the Object.

Returns:: array{Sound} - Sounds of the Object .

getStaticFlora

StaticFlora getStaticFlora (string name)

Returns the static flora with name 'name'

Parameters:: string name - Name of the static flora you want to get.

Returns:: StaticFlora - The static flora you are searching for.

getStaticFloras

array{StaticFlora} getStaticFloras ()

Returns all static floras of the Object.

Returns:: array{StaticFlora} - Static Floras of the Object.

getTemplate

objectTemplate getTemplate ()

Returns the template of this object.

Returns:: objectTemplate - Template of this object. Can be of type presence template or object.

getTimerListener

string, number, number getTimerListener (number codeID, string objectID)

Gets a 'timer' listener of the Object.

Parameters:: number codeID - Identifier of the 'timer' listener.; string objectID - Object ID of the object that contains the interaction that will be executed.

Returns:: string - Name of the interaction.; number - Type of timer: TT_ONE_TIME_EVENT or TT_CYCLE_EVENT.; number - Time interval between 'timer' events

getType

number getType ()

Returns the type of the object.

Returns:: number - The object type: OT_OBJECT, OT_PRESENCE, ARENA, RULEBOOK, OBJECT_TEMPLATE or PRESENCE_TEMPLATE.

hasAIMovementOnStartListener

boolean hasAIMovementOnStartListener ()

Returns 'true' if the Object has a 'pathfind started' Listener, otherwise 'false'.

Returns:: boolean - 'True' if the Object has a 'pathfind started' Listener, otherwise 'false'.

hasAIMovementOnStopListener

boolean hasAIMovementOnStopListener ()

Returns 'true' if the Object has a 'pathfind stopped' Listener, otherwise 'false'.

Returns:: boolean - 'True' if the Object has a 'pathfind stopped' Listener, otherwise 'false'.

hasAttribute

boolean hasAttribute (string name)

'true' if the Object has an attribute with the specified name, otherwise 'false'.

Parameters:: string name - Name of the attribute

Returns:: boolean - 'True' if the Object has an attribute with the specified name, otherwise 'false'.

hasModel

boolean hasModel (string name)

Checks if the Object has a model with name 'name'

Parameters:: string name - Name of the model you want to check.

Returns:: boolean - 'True' if the model is found, 'false' otherwise.

hasMouseButtonClickedListener

boolean hasMouseButtonClickedListener (number mousekey)

Returns 'true' if the Object has a listener for the 'button clicked' event, otherwise 'false'.

Parameters:: number mousekey - Mouse key that will trigger the event: MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE or MOUSE_BUTTON_RIGHT.

Returns:: boolean - 'True' if the Object has a listener for the 'button clicked' event, otherwise 'false'.

hasMouseButtonClickedListener

boolean hasMouseButtonClickedListener (number mousekey, boolean ctrl, boolean alt, boolean shift)

Returns 'true' if the Object has a listener for the 'button clicked' event, otherwise 'false'.

Parameters:: number mousekey - Mouse key that will trigger the event: MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE or MOUSE_BUTTON_RIGHT.; boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.; boolean alt - Whether the key combination includes the 'alt' modifier key.; boolean shift - Whether the key combination includes the 'shift' modifier key.

Returns:: boolean - 'True' if the Object has a listener for the 'button clicked' event, otherwise 'false'.

hasMouseButtonDoubleClickedListener

boolean hasMouseButtonDoubleClickedListener (number mousekey)

Returns 'true' if the Object has a listener for the 'button double clicked' event, otherwise 'false'.

Parameters:: number mousekey - Mouse key that will trigger the event: MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE or MOUSE_BUTTON_RIGHT.

Returns:: boolean - 'True' if the Object has a listener for the 'button double clicked' event, otherwise 'false'.

hasMouseButtonDoubleClickedListener

boolean hasMouseButtonDoubleClickedListener (number mousekey, boolean ctrl, boolean alt, boolean shift)

Returns 'true' if the Object has a listener for the 'button double clicked' event, otherwise 'false'.

Parameters:: number mousekey - Mouse key that will trigger the event: MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE or MOUSE_BUTTON_RIGHT.; boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.; boolean alt - Whether the key combination includes the 'alt' modifier key.; boolean shift - Whether the key combination includes the 'shift' modifier key.

Returns:: boolean - 'True' if the Object has a listener for the 'button double clicked' event, otherwise 'false'.

hasMouseButtonPressedListener

boolean hasMouseButtonPressedListener (number mousekey)

Returns 'true' if the Object has a listener for the 'button pressed' event, otherwise 'false'.

Parameters:: number mousekey - Mouse key that will trigger the event: MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE or MOUSE_BUTTON_RIGHT.

Returns:: boolean - 'True' if the Object has a listener for the 'button pressed' event, otherwise 'false'.

hasMouseButtonPressedListener

boolean hasMouseButtonPressedListener (number mousekey, boolean ctrl, boolean alt, boolean shift)

Returns 'true' if the Object has a listener for the 'button pressed' event, otherwise 'false'.

Parameters:: number mousekey - Mouse key that will trigger the event: MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE or MOUSE_BUTTON_RIGHT.; boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.; boolean alt - Whether the key combination includes the 'alt' modifier key.; boolean shift - Whether the key combination includes the 'shift' modifier key.

Returns:: boolean - 'True' if the Object has a listener for the 'button pressed' event, otherwise 'false'.

hasMouseButtonReleasedListener

boolean hasMouseButtonReleasedListener (number mousekey)

Returns 'true' if the Object has a listener for the 'button released' event, otherwise 'false'.

Parameters:: number mousekey - Mouse key that will trigger the event: MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE or MOUSE_BUTTON_RIGHT.

Returns:: boolean - 'True' if the Object has a listener for the 'button released' event, otherwise 'false'.

hasMouseButtonReleasedListener

boolean hasMouseButtonReleasedListener (number mousekey, boolean ctrl, boolean alt, boolean shift)

Returns 'true' if the Object has a listener for the 'button released' event, otherwise 'false'.

Parameters:: number mousekey - Mouse key that will trigger the event: MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE or MOUSE_BUTTON_RIGHT.; boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.; boolean alt - Whether the key combination includes the 'alt' modifier key.; boolean shift - Whether the key combination includes the 'shift' modifier key.

Returns:: boolean - 'True' if the Object has a listener for the 'button released' event, otherwise 'false'.

hasMouseEnteredListener

boolean hasMouseEnteredListener ()

Returns 'true' if the Object has a listener for the 'mouse left' event, otherwise 'false'.

Returns:: boolean - 'True' if the Object has a listener for the 'mouse left' event, otherwise 'false'.

hasMouseEnteredListener

boolean hasMouseEnteredListener (boolean ctrl, boolean alt, boolean shift)

Returns 'true' if the Object has a listener for the 'mouse left' event, otherwise 'false'.

Parameters:: boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.; boolean alt - Whether the key combination includes the 'alt' modifier key.; boolean shift - Whether the key combination includes the 'shift' modifier key.

Returns:: boolean - 'True' if the Object has a listener for the 'mouse left' event, otherwise 'false'.

hasMouseMovedListener

boolean hasMouseMovedListener ()

Returns 'true' if the Object has a listener for the 'mouse moved' event, otherwise 'false'.

Returns:: boolean - 'True' if the Object has a listener for the 'mouse moved' event, otherwise 'false'.

hasMouseMovedListener

boolean hasMouseMovedListener (boolean ctrl, boolean alt, boolean shift)

Returns 'true' if the Object has a listener for the 'mouse moved' event, otherwise 'false'.

Parameters:: boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.; boolean alt - Whether the key combination includes the 'alt' modifier key.; boolean shift - Whether the key combination includes the 'shift' modifier key.

Returns:: boolean - 'True' if the Object has a listener for the 'mouse moved' event, otherwise 'false'.

hasMouseWheelMovedListener

boolean hasMouseWheelMovedListener (number mousekey)

Returns 'true' if the Object has a listener for the 'mouse wheel moved' event, otherwise 'false'.

Parameters:: number mousekey - Mouse wheel movement that will trigger the event: MOUSE_WHEEL_DOWN or MOUSE_WHEEL_DOWN.

Returns:: boolean - 'True' if the Object has a listener for the 'mouse wheel moved' event, otherwise 'false'.

hasMouseWheelMovedListener

boolean hasMouseWheelMovedListener (number mousekey, boolean ctrl, boolean alt, boolean shift)

Returns 'true' if the Object has a listener for the 'mouse wheel moved' event, otherwise 'false'.

Parameters:: number mousekey - Mouse wheel movement that will trigger the event: MOUSE_WHEEL_DOWN or MOUSE_WHEEL_DOWN.; boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.; boolean alt - Whether the key combination includes the 'alt' modifier key.; boolean shift - Whether the key combination includes the 'shift' modifier key.

Returns:: boolean - 'True' if the Object has a listener for the 'mouse wheel moved' event, otherwise 'false'.

hasObject

boolean hasObject (string objectID)

Returns 'true' if this object contains the object with the specified ID, otherwise 'false'.

Parameters:: string objectID - Identifier of the object.

Returns:: boolean - 'True' if this object contains the object with the specified ID, otherwise 'false'.

hasOnLoadListener

boolean hasOnLoadListener ()

Returns 'true' if the Object has a listener for the 'on load' event, otherwise 'false'.

Returns:: boolean - 'True' if the Object has a listener for the 'on load' event, otherwise 'false'.

hasOnUnloadListener

boolean hasOnUnloadListener ()

Returns 'true' if the Object has a listener for the 'on unload' event, otherwise 'false'.

Returns:: boolean - 'True' if the Object has a listener for the 'on unload' event, otherwise 'false'.

hasRayHitListener

boolean hasRayHitListener ()

Returns 'true' if the Object has a listener for the 'mouse entered' event, otherwise 'false'.

Returns:: boolean - 'True' if the Object has a listener for the 'mouse entered' event, otherwise 'false'.

hasRiver

boolean hasRiver (string name)

Checks if the Object has a river with name 'name'

Parameters:: string name - Name of the river you want to check.

Returns:: boolean - 'True' if the river is found, 'false' otherwise.

hasRoad

boolean hasRoad (string name)

Checks if the Object has a road with name 'name'

Parameters:: string name - Name of the road you want to check.

Returns:: boolean - 'True' if the road is found, 'false' otherwise.

hasStaticFlora

boolean hasStaticFlora (string name)

Checks if the Object has a static flora with name 'name'

Parameters:: string name - Name of the static flora you want to check.

Returns:: boolean - 'True' if the static flora is found, 'false' otherwise.

hasTimerListener

boolean hasTimerListener (unsigned char)

Returns 'true' if the Object has a listener for the 'timer' event, otherwise 'false'.

Parameters:: unsigned char - codeID Identifier of the 'timer' listener.

Returns:: boolean - 'True' if the Object has a listener for the 'timer' event, otherwise 'false'.

isPersistent

boolean isPersistent ()

Returns 'true' if the object is set as persistent, otherwise 'false'.

Returns:: boolean - 'True' if the object is set as persistent, otherwise 'false'.

isVisible

boolean isVisible ()

Return 'true' if the object is set as visible, otherwise 'false'.

Returns:: boolean - 'True' if the object is set as visible, otherwise 'false'.

print

nil print ()

Prints the Object data and attributes to the console.

removeAIMovementOnStartListener

nil removeAIMovementOnStartListener ()

Removes the listener from the Object for the 'pathfind start' event.

removeAIMovementOnStopListener

nil removeAIMovementOnStopListener ()

Removes the listener from the Object for the 'pathfind stopped' event.

removeAllAttributes

nil removeAllAttributes ()

Removes all attributes of the Object.

removeAllBillboards

nil removeAllBillboards ()

Removes all billboards of the Object.

removeAllEffects

nil removeAllEffects ()

Removes all effects of the Object.

removeAllLights

nil removeAllLights ()

Removes all lights from the Object.

removeAllMeshDecals

nil removeAllMeshDecals ()

Removes all mesh decals from the arena.

removeAllModels

nil removeAllModels ()

Removes all models of the Object.

removeAllObjects

nil removeAllObjects ()

Removes all objects from this Object.

removeAllObjectsByName

nil removeAllObjectsByName (string name)

Removes all objects with the specified name from this Object.

Parameters:: string name - Name of the objects to remove.

removeAllObjectsByTemplate

nil removeAllObjectsByTemplate (string templateName)

Removes all objects that follow the specified template from this Object.

Parameters:: string templateName - Name of the template.

removeAllOverlays

nil removeAllOverlays ()

Removes all Overlays contained in this Object.

removeAllPlanes

nil removeAllPlanes ()

Removes all planes of the Object.

removeAllRepresentations

nil removeAllRepresentations ()

Removes all representations from the Object.

removeAllRivers

nil removeAllRivers ()

Removes all rivers of the Object.

removeAllRoads

nil removeAllRoads ()

Removes all roads of the Object.

removeAllSounds

nil removeAllSounds ()

Removes all sounds available in Object.

removeAllStaticFloras

nil removeAllStaticFloras ()

Removes all static floras of the Object.

removeAttribute

nil removeAttribute (string name)

Removes an attribute of the specified name.

Parameters:: string name - Name of the attribute.

removeBillboard

nil removeBillboard (string name)

Removes the billboard with name 'name'

Parameters:: string name - Name of the billboard you want to remove.

removeEffect

nil removeEffect (string name)

Returns the effect with name 'name'

Parameters:: string name - Name of the effect you want to remove.

removeLight

nil removeLight (string name)

Removes the designated light from the Object.

Parameters:: string name - Name of the light to remove.

removeMeshDecal

nil removeMeshDecal (string name)

Removes the mesh decal of the specified name from the arena.

Parameters:: string name - The name of the mesh decal to remove.

removeModel

nil removeModel (string name)

Removes the model with name 'name'

Parameters:: string name - Name of the model you want to remove.

removeMouseButtonClickedListener

nil removeMouseButtonClickedListener (number mousekey)

Removes the 'mouse button clicked' event listener of the Object.

Parameters:: number mousekey - Mouse key that will trigger the event: MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE or MOUSE_BUTTON_RIGHT.

removeMouseButtonClickedListener

nil removeMouseButtonClickedListener (number mousekey, boolean ctrl, boolean alt, boolean shift)

Removes the 'mouse button clicked' event listener of the Object.

Parameters:: number mousekey - Mouse key that will trigger the event: MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE or MOUSE_BUTTON_RIGHT.; boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.; boolean alt - Whether the key combination includes the 'alt' modifier key.; boolean shift - Whether the key combination includes the 'shift' modifier key.

removeMouseButtonDoubleClickedListener

nil removeMouseButtonDoubleClickedListener (number mousekey)

Removes the 'mouse button double clicked' event listener of the Object.

Parameters:: number mousekey - Mouse key that will trigger the event: MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE or MOUSE_BUTTON_RIGHT.

removeMouseButtonDoubleClickedListener

nil removeMouseButtonDoubleClickedListener (number mousekey, boolean ctrl, boolean alt, boolean shift)

Removes the 'mouse button double clicked' event listener of the Object.

Parameters:: number mousekey - Mouse key that will trigger the event: MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE or MOUSE_BUTTON_RIGHT.; boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.; boolean alt - Whether the key combination includes the 'alt' modifier key.; boolean shift - Whether the key combination includes the 'shift' modifier key.

removeMouseButtonPressedListener

nil removeMouseButtonPressedListener (number mousekey)

Removes the 'mouse button pressed' event listener of the Object.

Parameters:: number mousekey - Mouse key that will trigger the event: MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE or MOUSE_BUTTON_RIGHT.

removeMouseButtonPressedListener

nil removeMouseButtonPressedListener (number mousekey, boolean ctrl, boolean alt, boolean shift)

Removes the 'mouse button pressed' event listener of the Object.

Parameters:: number mousekey - Mouse key that will trigger the event: MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE or MOUSE_BUTTON_RIGHT.; boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.; boolean alt - Whether the key combination includes the 'alt' modifier key.; boolean shift - Whether the key combination includes the 'shift' modifier key.

removeMouseButtonReleasedListener

nil removeMouseButtonReleasedListener (number mousekey)

Removes the 'mouse button released' event listener of the Object.

Parameters:: number mousekey - Mouse key that will trigger the event: MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE or MOUSE_BUTTON_RIGHT.

removeMouseButtonReleasedListener

nil removeMouseButtonReleasedListener (number mousekey, boolean ctrl, boolean alt, boolean shift)

Removes the 'mouse button released' event listener of the Object.

Parameters:: number mousekey - Mouse key that will trigger the event: MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE or MOUSE_BUTTON_RIGHT.; boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.; boolean alt - Whether the key combination includes the 'alt' modifier key.; boolean shift - Whether the key combination includes the 'shift' modifier key.

removeMouseEnteredListener

nil removeMouseEnteredListener ()

Removes the 'mouse left' event listener of the Object.

removeMouseEnteredListener

nil removeMouseEnteredListener (boolean ctrl, boolean alt, boolean shift)

Removes the 'mouse left' event listener of the Object.

Parameters:: boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.; boolean alt - Whether the key combination includes the 'alt' modifier key.; boolean shift - Whether the key combination includes the 'shift' modifier key.

removeMouseMovedListener

nil removeMouseMovedListener ()

Removes the 'mouse moved' event listener of the Object.

removeMouseMovedListener

nil removeMouseMovedListener (boolean ctrl, boolean alt, boolean shift)

Removes the 'mouse moved' event listener of the Object.

Parameters:: boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.; boolean alt - Whether the key combination includes the 'alt' modifier key.; boolean shift - Whether the key combination includes the 'shift' modifier key.

removeMouseWheelMovedListener

nil removeMouseWheelMovedListener (number mousekey)

Removes the 'mouse wheel moved' event listener of the Object.

Parameters:: number mousekey - Mouse wheel movement that will trigger the event: MOUSE_WHEEL_DOWN or MOUSE_WHEEL_DOWN.

removeMouseWheelMovedListener

nil removeMouseWheelMovedListener (number mousekey, boolean ctrl, boolean alt, boolean shift)

Removes the 'mouse wheel moved' event listener of the Object.

Parameters:: number mousekey - Mouse wheel movement that will trigger the event: MOUSE_WHEEL_DOWN or MOUSE_WHEEL_DOWN.; boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.; boolean alt - Whether the key combination includes the 'alt' modifier key.; boolean shift - Whether the key combination includes the 'shift' modifier key.

removeObject

nil removeObject (string objectID)

Removes an object from this Object.

Parameters:: string objectID - Identifier of the object to remove.

removeOnLoadListener

nil removeOnLoadListener ()

Removes the specified 'on load' listener.

removeOnUnloadListener

nil removeOnUnloadListener ()

Removes the specified 'on unload' listener.

removeOverlay

nil removeOverlay (string name)

Removes an Overlay identified by name contained in this Object.

Parameters:: string name - Name of the Overlay.

removePlane

nil removePlane (string name)

Removes the plane with name 'name'

Parameters:: string name - Name of the plane you want to remove.

removeRayHitListener

nil removeRayHitListener ()

Removes the 'mouse entered' event listener of the Object.

removeRepresentation

nil removeRepresentation (string name, number type)

Removes the representation with the specified name and type from the Object.

Parameters:: string name - Name of the representation.; number type - Type of the representation.

removeRiver

nil removeRiver (string name)

Removes the river with name 'name'

Parameters:: string name - Name of the river you want to remove.

removeRoad

nil removeRoad (string name)

Removes the road with name 'name'

Parameters:: string name - Name of the road you want to remove.

removeSound

nil removeSound (string name)

Removes the sound with name 'name'.

Parameters:: string name - Name of the sound you want to remove.

removeStaticFlora

nil removeStaticFlora (string name)

Removes the static flora with name 'name'

Parameters:: string name - Name of the static flora you want to remove.

removeTimerListener

nil removeTimerListener (number codeID)

Removes a the specified 'timer' listener .

Parameters:: number codeID - Identifier of the 'timer' listener.

setAIMovementOnStartListener

nil setAIMovementOnStartListener (string name, InterModel interactionModel)

Sets a listener to be invoked upon a 'pathfind started' event on a model contained in this Object.

Parameters:: string name - Name of the interaction.; InterModel interactionModel - Arguments of the interaction that will be executed when this listener is activated.

setAIMovementOnStopListener

nil setAIMovementOnStopListener (string name, InterModel interactionModel)

Sets a listener to be invoked upon a 'pathfind stopped' event on a model contained in this Object.

Parameters:: string name - Name of the interaction.; InterModel interactionModel - Arguments of the interaction that will be executed when this listener is activated.

setAttribute

nil setAttribute (string name, string value)

Sets an attribute in the Object. Creates the attribute if there is none with the same name, otherwise it updates its value.

Parameters:: string name - Name of the attribute.; string value - Value of the attribute.

setDescription

nil setDescription (string description)

Sets the description of the Object.

Parameters:: string description - Description of the Object.

setMouseButtonDoubleClickedListener

nil setMouseButtonDoubleClickedListener (number mousekey, Object target, string name, InterModel interactionModel)

Sets a listener to be invoked upon a 'mouse button double clicked' event on the Object.

Parameters:: number mousekey - Mouse key that will trigger the event: MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE or MOUSE_BUTTON_RIGHT.; Object target - The object that contains the interaction that will be executed.; string name - Name of the interaction.; InterModel interactionModel - Arguments of the interaction that will be executed when this listener is activated.

setMouseButtonDoubleClickedListener

nil setMouseButtonDoubleClickedListener (number mousekey, Object target, string name, InterModel interactionModel, boolean ctrl, boolean alt, boolean shift, boolean global, string channel)

Sets a listener to be invoked upon a 'mouse button double clicked' event on the Object.

Parameters:: number mousekey - Mouse key that will trigger the event: MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE or MOUSE_BUTTON_RIGHT.; Object target - The object that contains the interaction that will be executed.; string name - Name of the interaction.; InterModel interactionModel - Arguments of the interaction that will be executed when this listener is activated.; boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.; boolean alt - Whether the key combination includes the 'alt' modifier key.; boolean shift - Whether the key combination includes the 'shift' modifier key.; boolean global - 'true' if this listener is executed globally, 'false' if it is executed only locally.; string channel - The channel of the listener.

setMouseButtonPressedListener

nil setMouseButtonPressedListener (number mousekey, Object target, string name, InterModel interactionModel)

Sets a listener to be invoked upon a 'mouse button pressed' event on the Object.

Parameters:: number mousekey - Mouse key that will trigger the event: MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE or MOUSE_BUTTON_RIGHT.; Object target - The object that contains the interaction that will be executed.; string name - Name of the interaction.; InterModel interactionModel - Arguments of the interaction that will be executed when this listener is activated.

setMouseButtonPressedListener

nil setMouseButtonPressedListener (number mousekey, Object target, string name, InterModel interactionModel, boolean ctrl, boolean alt, boolean shift, boolean global, string channel)

Sets a listener to be invoked upon a 'mouse button pressed' event on the Object.

Parameters:: number mousekey - Mouse key that will trigger the event: MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE or MOUSE_BUTTON_RIGHT.; Object target - The object that contains the interaction that will be executed.; string name - Name of the interaction.; InterModel interactionModel - Arguments of the interaction that will be executed when this listener is activated.; boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.; boolean alt - Whether the key combination includes the 'alt' modifier key.; boolean shift - Whether the key combination includes the 'shift' modifier key.; boolean global - 'true' if this listener is executed globally, 'false' if it is executed only locally.; string channel - The channel of the listener.

setMouseButtonReleasedListener

nil setMouseButtonReleasedListener (number mousekey, Object target, string name, InterModel interactionModel)

Sets a listener to be invoked upon a 'mouse button released' event on the Object.

Parameters:: number mousekey - Mouse key that will trigger the event: MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE or MOUSE_BUTTON_RIGHT.; Object target - The object that contains the interaction that will be executed.; string name - Name of the interaction.; InterModel interactionModel - Arguments of the interaction that will be executed when this listener is activated.

setMouseButtonReleasedListener

nil setMouseButtonReleasedListener (number mousekey, Object target, string name, InterModel interactionModel, boolean ctrl, boolean alt, boolean shift, boolean global, string channel)

Sets a listener to be invoked upon a 'mouse button released' event on the Object.

Parameters:: number mousekey - Mouse key that will trigger the event: MOUSE_BUTTON_LEFT, MOUSE_BUTTON_MIDDLE or MOUSE_BUTTON_RIGHT.; Object target - The object that contains the interaction that will be executed.; string name - Name of the interaction.; InterModel interactionModel - Arguments of the interaction that will be executed when this listener is activated.; boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.; boolean alt - Whether the key combination includes the 'alt' modifier key.; boolean shift - Whether the key combination includes the 'shift' modifier key.; boolean global - 'true' if this listener is executed globally, 'false' if it is executed only locally.; string channel - The channel of the listener.

setMouseEnteredListener

nil setMouseEnteredListener (Object target, string name, InterModel interactionModel)

Sets a listener to be invoked upon a 'mouse leave' event on the Object.

Parameters:: Object target - The object that contains the interaction that will be executed.; string name - Name of the interaction.; InterModel interactionModel - Arguments of the interaction that will be executed when this listener is activated.

setMouseEnteredListener

nil setMouseEnteredListener (Object target, string name, InterModel interactionModel, boolean ctrl, boolean alt, boolean shift, boolean global, string channel)

Sets a listener to be invoked upon a 'mouse leave' event on the Object.

Parameters:: Object target - The object that contains the interaction that will be executed.; string name - Name of the interaction.; InterModel interactionModel - Arguments of the interaction that will be executed when this listener is activated.; boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.; boolean alt - Whether the key combination includes the 'alt' modifier key.; boolean shift - Whether the key combination includes the 'shift' modifier key.; boolean global - 'true' if this listener is executed globally, 'false' if it is executed only locally.; string channel - The channel of the listener.

setMouseMovedListener

nil setMouseMovedListener (Object target, string name, InterModel interactionModel)

Sets a listener to be invoked upon a 'mouse move' event on the Object.

Parameters:: Object target - The object that contains the interaction that will be executed.; string name - Name of the interaction.; InterModel interactionModel - Arguments of the interaction that will be executed when this listener is activated.

setMouseMovedListener

nil setMouseMovedListener (Object target, string name, InterModel interactionModel, boolean ctrl, boolean alt, boolean shift, boolean global, string channel)

Sets a listener to be invoked upon a 'mouse move' event on the Object.

Parameters:: Object target - The object that contains the interaction that will be executed.; string name - Name of the interaction.; InterModel interactionModel - Arguments of the interaction that will be executed when this listener is activated.; boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.; boolean alt - Whether the key combination includes the 'alt' modifier key.; boolean shift - Whether the key combination includes the 'shift' modifier key.; boolean global - 'true' if this listener is executed globally, 'false' if it is executed only locally.; string channel - The channel of the listener.

setMouseWheelMovedListener

nil setMouseWheelMovedListener (number mousekey, Object target, string name, InterModel interactionModel)

Sets a listener to be invoked upon a 'mouse wheel moved' event on the Object.

Parameters:: number mousekey - Mouse wheel movement that will trigger the event: MOUSE_WHEEL_DOWN or MOUSE_WHEEL_DOWN.; Object target - The object that contains the interaction that will be executed.; string name - Name of the interaction.; InterModel interactionModel - Arguments of the interaction that will be executed when this listener is activated.

setMouseWheelMovedListener

nil setMouseWheelMovedListener (number mousekey, Object target, string name, InterModel interactionModel, boolean ctrl, boolean alt, boolean shift, boolean global, string channel)

Sets a listener to be invoked upon a 'mouse wheel moved' event on the Object.

Parameters:: number mousekey - Mouse wheel movement that will trigger the event: MOUSE_WHEEL_DOWN or MOUSE_WHEEL_DOWN.; Object target - The object that contains the interaction that will be executed.; string name - Name of the interaction.; InterModel interactionModel - Arguments of the interaction that will be executed when this listener is activated.; boolean ctrl - Whether the key combination includes the 'ctrl' modifier key.; boolean alt - Whether the key combination includes the 'alt' modifier key.; boolean shift - Whether the key combination includes the 'shift' modifier key.; boolean global - 'true' if this listener is executed globally, 'false' if it is executed only locally.; string channel - The channel of the listener.

setName

nil setName (string name)

Sets the name of the Object.

Parameters:: string name - The name of the Object.

setOnLoadListener

nil setOnLoadListener (string name)

Sets a listener to execute a specified interaction in this Object upon an 'on load' event.

Parameters:: string name - Name of the interaction to be called.

setOnUnloadListener

nil setOnUnloadListener (string name)

Sets a listener to execute a specified interaction in this Object upon an 'on unload' event.

Parameters:: string name - Name of the interaction to be called.

setPersistent

nil setPersistent (boolean isPersistent)

Sets the persistency of the Object.

Parameters:: boolean isPersistent - Whether the Object is persistent or not.

setRayHitListener

nil setRayHitListener (Object target, string name, InterModel interactionModel)

Sets a listener to be invoked upon a physics 'ray hit' event on the Object.

Parameters:: Object target - The object that contains the interaction that will be executed.; string name - Name of the interaction.; InterModel interactionModel - Arguments of the interaction that will be executed when this listener is activated.

setRayHitListener

nil setRayHitListener (Object target, string name, InterModel interactionModel, boolean global, string channel)

Sets a listener to be invoked upon a physics 'ray hit' event on the Object.

Parameters:: Object target - The object that contains the interaction that will be executed.; string name - Name of the interaction.; InterModel interactionModel - Arguments of the interaction that will be executed when this listener is activated.; boolean global - 'true' if this listener is executed globally, 'false' if it is executed only locally.; string channel - The channel of the listener.

setTimerListener

nil setTimerListener (number codeID, Object target, string name, InterModel interactionModel, number type, number deltaT)

Sets a listener to be invoked upon a 'timer' event on the Object.

Parameters:: number codeID - Identifier of the 'timer' listener.; Object target - Object that contains the interaction that will be executed.; string name - Name of the interaction.; InterModel interactionModel - Arguments of the interaction that will be executed when this listener is activated.; number type - Type of timer: TT_ONE_TIME_EVENT or TT_CYCLE_EVENT.; number deltaT - Time interval between 'timer' events (seconds).

setVisible

nil setVisible (boolean visible)

Sets the visibility of the Object.

Parameters:: boolean visible - Whether the Object is visible or invisible.