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

Presence

Presences are objects that represent the players.
As objects, presences share the same base: both can have representations, attributes, interactions, etc., but presences can also have abilities. Abilities are similar to attributes (pairs of strings name-value).

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)`
`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)`
`Sound`	`createSound (string name, MediaItem mediaitem)`
`<type>,...,<type>`	`exec (string name, string args)`
`array{}`	`getAbilities ()`
`string`	`getAbility (string name)`
`string, InterModel`	`getAIMovementOnStartListener ()`
`string, InterModel`	`getAIMovementOnStopListener ()`
`string`	`getAttribute (string name)`
`hastable{string,string}`	`getAttributes ()`
`BillBoard`	`getBillboard (string name)`
`array{BillBoard}`	`getBillboards ()`
`string`	`getDescription ()`
`Effect`	`getEffect (string name)`
`array{Effect}`	`getEffects ()`
`string`	`getID ()`
`Light`	`getLight (string name)`
`array{Light}`	`getLights ()`
`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`	`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 ()`
`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 ()`
`Sound`	`getSound (string name)`
`array{Sound}`	`getSounds ()`
`objectTemplate`	`getTemplate ()`
`string, number, number`	`getTimerListener (number codeID, string objectID)`
`number`	`getType ()`
`boolean`	`hasAbility (string name)`
`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`	`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`	`hasRayHitListener ()`
`boolean`	`hasTimerListener (unsigned char)`
`boolean`	`isDefault ()`
`boolean`	`isPersistent ()`
`boolean`	`isVisible ()`
`nil`	`print ()`
`nil`	`removeAbility (string name)`
`nil`	`removeAIMovementOnStartListener ()`
`nil`	`removeAIMovementOnStopListener ()`
`nil`	`removeAllAbilities ()`
`nil`	`removeAllAttributes ()`
`nil`	`removeAllBillboards ()`
`nil`	`removeAllEffects ()`
`nil`	`removeAllLights ()`
`nil`	`removeAllModels ()`
`nil`	`removeAllObjects ()`
`nil`	`removeAllObjectsByName (string name)`
`nil`	`removeAllObjectsByTemplate (string templateName)`
`nil`	`removeAllOverlays ()`
`nil`	`removeAllPlanes ()`
`nil`	`removeAllRepresentations ()`
`nil`	`removeAllSounds ()`
`nil`	`removeAttribute (string name)`
`nil`	`removeBillboard (string name)`
`nil`	`removeEffect (string name)`
`nil`	`removeLight (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`	`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`	`removeOverlay (string name)`
`nil`	`removePlane (string name)`
`nil`	`removeRayHitListener ()`
`nil`	`removeRepresentation (string name, number type)`
`nil`	`removeSound (string name)`
`nil`	`removeTimerListener (number codeID)`
`nil`	`setAbility (string name, string value)`
`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`	`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`	`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 Presence.

Parameters:: Object original - Object to add.

copyObject

Object copyObject (Object original)

Clones an object in this Presence.

Parameters:: Object original - Object to clone.

Returns:: Object - The cloned object.

copyObject

Object copyObject (Object original, string name)

Clones an object in this Presence 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 Presence 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 Presence 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 Presence with the specified name.

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

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

createModel

Model createModel (string name, MediaItem mediaItem)

Creates a model in the Presence 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 Presence.

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 Presence.

Parameters:: string name - Name of the Presence; 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 Presence.; number x - X coordinate of the position of the Presence.; number y - Y coordinate of the position of the Presence.; number sx - Width of the Presence.; number sy - Height of the Presence.

Returns:: overlay - The new overlay.

createPlane

Plane createPlane (string name)

Creates a plane in the Presence with the specified name.

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

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

createSound

Sound createSound (string name, MediaItem mediaitem)

Creates a sound in the Presence 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.

exec

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

Executes the specified interaction on the Presence.

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.

getAbilities

array{} getAbilities ()

Returns the abilities available in this presence.

Returns:: array{} - Abilities available in this presence.

getAbility

string getAbility (string name)

Returns the value of the ability with name 'name'.

Parameters:: string name - Name of the ability to be returned.

Returns:: string - Value of the ability.

getAIMovementOnStartListener

string, InterModel getAIMovementOnStartListener ()

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

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 Presence.

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 Presence.

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

getDescription

string getDescription ()

Returns the description of the Presence.

Returns:: string - Description if the Presence.

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 Presence.

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

getID

string getID ()

Returns the object ID.

Returns:: string - Object ID.

getLight

Light getLight (string name)

Returns a light in the Presence 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 Presence.

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

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 Presence.

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

getMouseButtonClickedListener

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

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

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 Presence.

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 Presence.

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 Presence.

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 Presence.

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 Presence.

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 Presence.

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 Presence.

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.

getMouseMovedListener

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

Returns the 'mouse moved' listener of the Presence.

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 Presence.

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 Presence.

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 Presence.

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 Presence.

Returns:: string - Name of the Presence.

getObject

Object getObject (string objectID)

Returns the object with the specified ID from this Presence.

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 Presence.

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

getObjectsByName

array{Object} getObjectsByName (string Name)

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

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

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

getObjectsByTemplate

array{Object} getObjectsByTemplate (string templateName)

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

Parameters:: string templateName - Name of the template.

Returns:: array{Object} - Array containg all objects in this Presence 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.

getOverlay

Overlay getOverlay (string name)

Returns an Overlay identified by name contained in this Presence.

Parameters:: string name - Name of the Overlay.

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

getOverlays

array{} getOverlays ()

Returns the Overlays contained in this Presence.

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

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 Presence.

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

getRayHitListener

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

Returns the 'mouse entered' listener of the Presence.

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.

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 Presence.

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

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 Presence.

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.

hasAbility

boolean hasAbility (string name)

Returns whether there is an ability in the presence with name 'name' or not.

Parameters:: string name - Name of the ability to be checked.

Returns:: boolean - 'True' if the Presence has an ability with name 'name', otherwise 'false'.

hasAIMovementOnStartListener

boolean hasAIMovementOnStartListener ()

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

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

hasAIMovementOnStopListener

boolean hasAIMovementOnStopListener ()

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

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

hasAttribute

boolean hasAttribute (string name)

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

Parameters:: string name - Name of the attribute

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

hasModel

boolean hasModel (string name)

Checks if the Presence 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 Presence 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 Presence 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 Presence 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 Presence has a listener for the 'button clicked' event, otherwise 'false'.

hasMouseButtonDoubleClickedListener

boolean hasMouseButtonDoubleClickedListener (number mousekey)

Returns 'true' if the Presence 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 Presence 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 Presence 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 Presence has a listener for the 'button double clicked' event, otherwise 'false'.

hasMouseButtonPressedListener

boolean hasMouseButtonPressedListener (number mousekey)

Returns 'true' if the Presence 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 Presence 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 Presence 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 Presence has a listener for the 'button pressed' event, otherwise 'false'.

hasMouseButtonReleasedListener

boolean hasMouseButtonReleasedListener (number mousekey)

Returns 'true' if the Presence 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 Presence 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 Presence 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 Presence has a listener for the 'button released' event, otherwise 'false'.

hasMouseMovedListener

boolean hasMouseMovedListener ()

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

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

hasMouseMovedListener

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

Returns 'true' if the Presence 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 Presence has a listener for the 'mouse moved' event, otherwise 'false'.

hasMouseWheelMovedListener

boolean hasMouseWheelMovedListener (number mousekey)

Returns 'true' if the Presence 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 Presence 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 Presence 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 Presence 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 Presence has a listener for the 'on load' event, otherwise 'false'.

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

hasRayHitListener

boolean hasRayHitListener ()

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

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

hasTimerListener

boolean hasTimerListener (unsigned char)

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

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

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

isDefault

boolean isDefault ()

Returns Whether this presence is a default presence, i.e. one created automatically and without an actual precence template.

Returns:: boolean - Whether this presence is a default presence.

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 presence information to the console.

removeAbility

nil removeAbility (string name)

Removes the ability with name 'name'.

Parameters:: string name - Name of the ability to be removed.

removeAIMovementOnStartListener

nil removeAIMovementOnStartListener ()

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

removeAIMovementOnStopListener

nil removeAIMovementOnStopListener ()

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

removeAllAbilities

nil removeAllAbilities ()

Removes all abilities.

removeAllAttributes

nil removeAllAttributes ()

Removes all attributes of the Presence.

removeAllBillboards

nil removeAllBillboards ()

Removes all billboards of the Presence.

removeAllEffects

nil removeAllEffects ()

Removes all effects of the Presence.

removeAllLights

nil removeAllLights ()

Removes all lights from the Presence.

removeAllModels

nil removeAllModels ()

Removes all models of the Presence.

removeAllObjects

nil removeAllObjects ()

Removes all objects from this Presence.

removeAllObjectsByName

nil removeAllObjectsByName (string name)

Removes all objects with the specified name from this Presence.

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

removeAllObjectsByTemplate

nil removeAllObjectsByTemplate (string templateName)

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

Parameters:: string templateName - Name of the template.

removeAllOverlays

nil removeAllOverlays ()

Removes all Overlays contained in this Presence.

removeAllPlanes

nil removeAllPlanes ()

Removes all planes of the Presence.

removeAllRepresentations

nil removeAllRepresentations ()

Removes all representations from the Presence.

removeAllSounds

nil removeAllSounds ()

Removes all sounds available in Presence.

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 Presence.

Parameters:: string name - Name of the light 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 Presence.

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 Presence.

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 Presence.

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 Presence.

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 Presence.

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 Presence.

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 Presence.

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 Presence.

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.

removeMouseMovedListener

nil removeMouseMovedListener ()

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

removeMouseMovedListener

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

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

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 Presence.

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 Presence.

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 Presence.

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

removeOnLoadListener

nil removeOnLoadListener ()

Removes the specified 'on load' listener.

removeOverlay

nil removeOverlay (string name)

Removes an Overlay identified by name contained in this Presence.

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 Presence.

removeRepresentation

nil removeRepresentation (string name, number type)

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

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

removeSound

nil removeSound (string name)

Removes the sound with name 'name'.

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

removeTimerListener

nil removeTimerListener (number codeID)

Removes a the specified 'timer' listener .

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

setAbility

nil setAbility (string name, string value)

Sets or adds an ability with name 'name' and value 'value'.
If an ability with name 'name' doesn't exist, adds one.

Parameters:: string name - Name of the ability to be added/changed.; string value - Value of the ability.

setAIMovementOnStartListener

nil setAIMovementOnStartListener (string name, InterModel interactionModel)

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

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 Presence.

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 Presence. 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 Presence.

Parameters:: string description - Description of the Presence.

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 Presence.

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 Presence.

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 Presence.

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 Presence.

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 Presence.

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 Presence.

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.

setMouseMovedListener

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

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

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 Presence.

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 Presence.

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 Presence.

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 Presence.

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

setOnLoadListener

nil setOnLoadListener (string name)

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

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

setPersistent

nil setPersistent (boolean isPersistent)

Sets the persistency of the Presence.

Parameters:: boolean isPersistent - Whether the Presence 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 Presence.

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 Presence.

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 Presence.

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 Presence.

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