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

Arena

The Arena is where the players effectively play the game you are making.
You can divide the game in several arenas or you can make it in just one arena. Remember that the more people are playing your game in the same arena, the more bandwith is needed to maintain persistence between every player.
We recomend that you divide your game in several levels, areas, rooms, etc., and make of each of these spaces an arena.
There is a global flag in listeners that you can set. If you set this flag to 'true' it means that when triggered, the listener will sent a message to the other players to also trigger the listener. If you have a listener that should only be treated locally you should set it to 'false'. This is a good way to save network resources so use it wisely.
There is an update flag in attributes, representations, objects, that you can set. If you set this flag to 'true' it means that that attribute, representation, etc., are in persistent mode. This means that any change will be saved in the server and its values loaded when the arena is back online. This is also a good way to save network resources so use it wisely.

Method Summary
`nil`	`addObject (Object original)`
`nil`	`addSongToPlaylist (string name, MediaItem song)`
`Object`	`copyObject (Object original)`
`Object`	`copyObject (Object original, string name)`
`representation`	`copyRepresentation (representation original)`
`representation`	`copyRepresentation (representation original, string name)`
`AnimationTrack`	`createAnimationTrack (string name)`
`BillBoard`	`createBillboard (string name)`
`Camera`	`createCamera (string cameraName)`
`Effect`	`createEffect (string name)`
`HighlightDecal`	`createHighlightDecal (string name, number x, number z, number w, number l, MediaItem mediaitem)`
`Light`	`createLight (string name)`
`Material`	`createMaterial (string name)`
`Material`	`createMaterial (string name, MediaItem mediaItem, string materialName)`
`Matrix`	`createMatrixBool (string matrixName, number w, number h)`
`Matrix`	`createMatrixMaterial (string matrixName, number w, number h)`
`Matrix`	`createMatrixMediaItem (string matrixName, number w, number h)`
`Matrix`	`createMatrixNumber (string matrixName, number w, number h)`
`Matrix`	`createMatrixObject (string matrixName, number w, number h)`
`Matrix`	`createMatrixRepresentation (string matrixName, number w, number h)`
`Matrix`	`createMatrixString (string matrixName, number w, number h)`
`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`	`getActiveCamera ()`
`string, InterModel`	`getAIMovementOnStartListener ()`
`string, InterModel`	`getAIMovementOnStopListener ()`
`MediaItem`	`getAmbientSound ()`
`float`	`getAmbientSoundVolume ()`
`AnimationTrack`	`getAnimationTrack (string name)`
`array{}`	`getAnimationTracks ()`
`string`	`getAttribute (string name)`
`hastable{string,string}`	`getAttributes ()`
`BillBoard`	`getBillboard (string name)`
`array{BillBoard}`	`getBillboards ()`
`Camera`	`getCamera (string cameraName)`
`array{Camera}`	`getCameras ()`
`string`	`getDescription ()`
`Effect`	`getEffect (string name)`
`array{Effect}`	`getEffects ()`
`number, number, number, number, number, number, number`	`getFog ()`
`HighlightDecal`	`getHighlightDecal (string name)`
`array{HighlightDecal}`	`getHighlightDecals ()`
`string`	`getID ()`
`Object, string, InterModel, boolean, string`	`getKeyPressedListener (string key)`
`Object, string, InterModel, boolean, string`	`getKeyPressedListener (string key, boolean ctrl, boolean alt, boolean shift)`
`Object, string, InterModel, boolean, string`	`getKeyReleasedListener (string key)`
`Object, string, InterModel, boolean, string`	`getKeyReleasedListener (string key, boolean ctrl, boolean alt, boolean shift)`
`Light`	`getLight (string name)`
`number, number, number`	`getLightColour ()`
`array{Light}`	`getLights ()`
`Material`	`getMaterial (string name)`
`array{Material}`	`getMaterials ()`
`array{Matrix}`	`getMatrices ()`
`Matrix`	`getMatrix (string matrixName)`
`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)`
`Presence`	`getMyPresence ()`
`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 ()`
`Presence`	`getPresence (string objectID)`
`array{Presence}`	`getPresences ()`
`array{Presence}`	`getPresencesByName (string name)`
`array{Presence}`	`getPresencesByTemplate (string class)`
`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 ()`
`number`	`getShadowAdjustFactor ()`
`integer`	`getShadowBlurSize ()`
`integer`	`getShadowColour ()`
`integer`	`getShadowFarDistance ()`
`number`	`getShadowTechnique ()`
`integer`	`getShadowTextureCount ()`
`integer`	`getShadowTextureSize ()`
`boolean, string, string, string, string, string, string, number`	`getSkyBox ()`
`string, number, number, number`	`getSkyPlane ()`
`meditaitem`	`getSongFromPlaylist (string name)`
`hashtable{string,mediaitem}`	`getSongsFromPlaylist ()`
`Sound`	`getSound (string name)`
`array{Sound}`	`getSounds ()`
`StaticFlora`	`getStaticFlora (string name)`
`array{StaticFlora}`	`getStaticFloras ()`
`string, number, number`	`getTimerListener (number codeID, string objectID)`
`number`	`getType ()`
`boolean`	`hasAIMovementOnStartListener ()`
`boolean`	`hasAIMovementOnStopListener ()`
`boolean`	`hasAnimationTrack (string name)`
`boolean`	`hasAttribute (string name)`
`boolean`	`hasCamera (string cameraName)`
`boolean`	`hasKeyPressedListener (string key)`
`boolean`	`hasKeyPressedListener (string key, boolean ctrl, boolean alt, boolean shift)`
`boolean`	`hasKeyReleasedListener (string key)`
`boolean`	`hasKeyReleasedListener (string key, boolean ctrl, boolean alt, boolean shift)`
`boolean`	`hasMaterial (string name)`
`boolean`	`hasMatrix (string matrixName)`
`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`	`hasRayHitListener ()`
`boolean`	`hasRiver (string name)`
`boolean`	`hasRoad (string name)`
`boolean`	`hasStaticFlora (string name)`
`boolean`	`hasTimerListener (unsigned char)`
`boolean`	`isAmbientSoundOnLoad ()`
`boolean`	`isPersistent ()`
`boolean`	`isShadowRenderBackfaces ()`
`boolean`	`isSkyBoxEnabled ()`
`boolean`	`isSkyDomeEnabled ()`
`boolean`	`isSkyPlaneEnabled ()`
`boolean`	`isVisible ()`
`nil`	`pauseAmbientSound ()`
`nil`	`pausePlaylist ()`
`nil`	`playAmbientSound ()`
`nil`	`playPlaylist ()`
`nil`	`playSongFromPlaylist (string name)`
`nil`	`print ()`
`nil`	`removeAIMovementOnStartListener ()`
`nil`	`removeAIMovementOnStopListener ()`
`nil`	`removeAllAnimationTracks ()`
`nil`	`removeAllAttributes ()`
`nil`	`removeAllBillboards ()`
`nil`	`removeAllCameras ()`
`nil`	`removeAllEffects ()`
`nil`	`removeAllHighlightDecals ()`
`nil`	`removeAllLights ()`
`nil`	`removeAllMatrices ()`
`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`	`removeAllSongsFromPlaylist ()`
`nil`	`removeAllSounds ()`
`nil`	`removeAllStaticFloras ()`
`nil`	`removeAnimationTrack (string name)`
`nil`	`removeAttribute (string name)`
`nil`	`removeBillboard (string name)`
`nil`	`removeCamera (string cameraName)`
`nil`	`removeEffect (string name)`
`nil`	`removeFog ()`
`nil`	`removeHighlightDecal (string name)`
`nil`	`removeKeyPressedListener (string key)`
`nil`	`removeKeyPressedListener (string key, boolean ctrl, boolean alt, boolean shift)`
`nil`	`removeKeyReleasedListener (string key)`
`nil`	`removeKeyReleasedListener (string key, boolean ctrl, boolean alt, boolean shift)`
`nil`	`removeLight (string name)`
`nil`	`removeMaterial (string materialName)`
`nil`	`removeMatrix (string matrixName)`
`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`	`removeOverlay (string name)`
`nil`	`removePlane (string name)`
`nil`	`removeRayHitListener ()`
`nil`	`removeRepresentation (string name, number type)`
`nil`	`removeRiver (string name)`
`nil`	`removeRoad (string name)`
`nil`	`removeSongFromPlaylist (string name)`
`nil`	`removeSound (string name)`
`nil`	`removeStaticFlora (string name)`
`nil`	`removeTimerListener (number codeID)`
`nil`	`setActiveCamera (string cameraName)`
`nil`	`setActiveCameraEdit ()`
`nil`	`setAIMovementOnStartListener (string name, InterModel interactionModel)`
`nil`	`setAIMovementOnStopListener (string name, InterModel interactionModel)`
`nil`	`setAmbientSound (MediaItem sound)`
`nil`	`setAmbientSoundOnLoad (boolean enable)`
`nil`	`setAmbientSoundVolume (float volume)`
`nil`	`setAttribute (string name, string value)`
`nil`	`setDescription (string description)`
`nil`	`setFogExp (number r, number g, number b, number opacity)`
`nil`	`setFogExp2 (number r, number g, number b, number opacity)`
`nil`	`setFogLinear (number r, number g, number b, number near, number far)`
`nil`	`setKeyPressedListener (string key, Object target, string name, InterModel interactionModel)`
`nil`	`setKeyPressedListener (string key, Object target, string name, InterModel interactionModel, boolean ctrl, boolean alt, boolean shift, boolean global, string channel)`
`nil`	`setKeyReleasedListener (string key, Object target, string name, InterModel interactionModel)`
`nil`	`setKeyReleasedListener (string key, Object target, string name, InterModel interactionModel, boolean ctrl, boolean alt, boolean shift, boolean global, string channel)`
`nil`	`setLightColour (number Red, number Green, number Blue)`
`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`	`setPersistent (boolean isPersistent)`
`nil`	`setPlaylistLoop (boolean loop)`
`nil`	`setPlaylistShuffle (boolean loop)`
`nil`	`setPlaylistVolume (number volume)`
`nil`	`setRayHitListener (Object target, string name, InterModel interactionModel)`
`nil`	`setRayHitListener (Object target, string name, InterModel interactionModel, boolean global, string channel)`
`nil`	`setShadowAdjustFactor (number factor)`
`nil`	`setShadowBlurSize (integer size)`
`nil`	`setShadowColour (integer colour)`
`nil`	`setShadowFarDistance (integer distance)`
`nil`	`setShadowRenderBackfaces (boolean renderbackfaces)`
`nil`	`setShadowTechnique (number technique)`
`nil`	`setShadowTextureCount (integer count)`
`nil`	`setShadowTextureSize (integer size)`
`nil`	`setSkyBox (string upMaterial, string frontMaterial, string backMaterial, string leftMaterial, string rightMaterial, string downMaterial, number distance)`
`nil`	`setSkyBoxEnabled (boolean enabled)`
`nil`	`setSkyDome (string material, number curvature, number tiling, number distance)`
`nil`	`setSkyDomeEnabled (boolean enabled)`
`nil`	`setSkyPlane (string material, number scale, number tiling, number distance)`
`nil`	`setSkyPlaneEnabled (boolean enable)`
`nil`	`setTimerListener (number codeID, Object target, string name, InterModel interactionModel, number type, number deltaT)`
`nil`	`setVisible (boolean visible)`
`nil`	`startPlaylist ()`
`nil`	`stopAmbientSound ()`
`nil`	`stopPlaylist ()`

Method Detail

addObject

nil addObject (Object original)

Adds an Object to this Arena.

Parameters:: Object original - Object to add.

addSongToPlaylist

nil addSongToPlaylist (string name, MediaItem song)

Adds a song to the playlist of the arena.

Parameters:: string name - Name of the song.; MediaItem song - Media Item containing the song.

copyObject

Object copyObject (Object original)

Clones an object in this Arena.

Parameters:: Object original - Object to clone.

Returns:: Object - The cloned object.

copyObject

Object copyObject (Object original, string name)

Clones an object in this Arena 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.

createAnimationTrack

AnimationTrack createAnimationTrack (string name)

Creates an animation track in the Arena with the specified name.

Parameters:: string name - Name that identifies the animation track.

Returns:: AnimationTrack - New animation track with the specified name.

createBillboard

BillBoard createBillboard (string name)

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

Parameters:: string name - Name of the Billbloard

Returns:: BillBoard - The new billboard.

createCamera

Camera createCamera (string cameraName)

Creates a new camera with the specified name.

Parameters:: string cameraName - Name of the new camera.

Returns:: Camera - The new camera.

createEffect

Effect createEffect (string name)

Creates an effect in the Arena 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.

createHighlightDecal

HighlightDecal createHighlightDecal (string name, number x, number z, number w, number l, MediaItem mediaitem)

Creates a highlight decal for the arena.

Parameters:: string name - Name of the highlight decal.; number x - Position in the X coordinate.; number z - Position in the Z coordinate; number w - Width of the highlight decal.; number l - Length of the highlight decal.; MediaItem mediaitem - MediaItem containing the image of the decal.

Returns:: HighlightDecal - The new HighlightDecal.

createLight

Light createLight (string name)

Creates a light in the Arena with the specified name.

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

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

createMaterial

Material createMaterial (string name)

Creates a new material with the specified name.

Parameters:: string name - Name of the material to create.

Returns:: Material - New material with the specified name.

createMaterial

Material createMaterial (string name, MediaItem mediaItem, string materialName)

Creates a new material with the specified name.

Parameters:: string name - Name of the material to create.; MediaItem mediaItem - MediaItem of the Material.; string materialName - Name on the Material in the Media Item.

Returns:: Material - New material with the specified name.

createMatrixBool

Matrix createMatrixBool (string matrixName, number w, number h)

Creates a matrix of booleans with the specified dimensions (width and height).

Parameters:: string matrixName - Name of the matrix.; number w - Width of the matrix.; number h - Height of the matrix.

Returns:: Matrix - The new Matrix.

createMatrixMaterial

Matrix createMatrixMaterial (string matrixName, number w, number h)

Creates a matrix of materials with the specified dimensions (width and height).

Parameters:: string matrixName - Name of the matrix.; number w - Width of the matrix.; number h - Height of the matrix.

Returns:: Matrix - The new Matrix.

createMatrixMediaItem

Matrix createMatrixMediaItem (string matrixName, number w, number h)

Creates a matrix of media items with the specified dimensions (width and height).

Parameters:: string matrixName - Name of the matrix.; number w - Width of the matrix.; number h - Height of the matrix.

Returns:: Matrix - The new Matrix.

createMatrixNumber

Matrix createMatrixNumber (string matrixName, number w, number h)

Creates a matrix of numbers with the specified dimensions (width and height).

Parameters:: string matrixName - Name of the matrix.; number w - Width of the matrix.; number h - Height of the matrix.

Returns:: Matrix - The new Matrix.

createMatrixObject

Matrix createMatrixObject (string matrixName, number w, number h)

Creates a matrix of objects with the specified dimensions (width and height).

Parameters:: string matrixName - Name of the matrix.; number w - Width of the matrix.; number h - Height of the matrix.

Returns:: Matrix - The new Matrix.

createMatrixRepresentation

Matrix createMatrixRepresentation (string matrixName, number w, number h)

Creates a matrix of representations with the specified dimensions (width and height).

Parameters:: string matrixName - Name of the matrix.; number w - Width of the matrix.; number h - Height of the matrix.

Returns:: Matrix - The new Matrix.

createMatrixString

Matrix createMatrixString (string matrixName, number w, number h)

Creates a matrix of strings with the specified dimensions (width and height).

Parameters:: string matrixName - Name of the matrix.; number w - Width of the matrix.; number h - Height of the matrix.

Returns:: Matrix - The new Matrix.

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

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

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

Returns:: overlay - The new overlay.

createPlane

Plane createPlane (string name)

Creates a plane in the Arena 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 Arena 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 Arena 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 Arena 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 Arena 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 Arena.

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.

getActiveCamera

string getActiveCamera ()

Returns the name of the active camera.

Returns:: string - Name of the active camera.

getAIMovementOnStartListener

string, InterModel getAIMovementOnStartListener ()

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

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

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

getAmbientSound

MediaItem getAmbientSound ()

Returns the Media Item containing the ambient sound set to be played in the arena.

Returns:: MediaItem - Media Item containing the ambient sound set to be played in the arena.

getAmbientSoundVolume

float getAmbientSoundVolume ()

Returns the ambient sound volume in the arena.

Returns:: float - ambient sound volume in the arena.

getAnimationTrack

AnimationTrack getAnimationTrack (string name)

Returns the animation track with name 'name'

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

Returns:: AnimationTrack - The animation track you are searching for.

getAnimationTracks

array{} getAnimationTracks ()

Returns an array of animation tracks available in the Arena.

Returns:: array{} - AnimationTracks of the Arena

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

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

getCamera

Camera getCamera (string cameraName)

Returns the camera with the specified name from the arena.

Parameters:: string cameraName - Name of the camera to return.

Returns:: Camera - Camera with the specified name.

getCameras

array{Camera} getCameras ()

Returns an array containing the cameras in the arena.

Returns:: array{Camera} - Array containing the cameras in the arena.

getDescription

string getDescription ()

Returns the description of the Arena.

Returns:: string - Description if the Arena.

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

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

getFog

number, number, number, number, number, number, number getFog ()

Returns the fog type and parameters.

Returns:: number - The fog mode: FM_FOG_MODE_NONE, FM_FOG_MODE_LINEAR, FM_FOG_MODE_EXP or FM_FOG_MODE_EXP2.; number - Red Colour value (between 0 and 255).; number - Green Colour value (between 0 and 255).; number - Blue Colour value (between 0 and 255).; number - Distance radius where the fog density is null (0%). Applicable only to linear fog mode (FM_FOG_MODE_LINEAR), otherwise returns 0.; number - Distance where the fog density is full (100%). Applicable only to linear fog mode (FM_FOG_MODE_LINEAR), otherwise returns 0.; number - The level of opacity of the fog. Applicable only to exponential fog modes (FM_FOG_MODE_EXP or FM_FOG_MODE_EXP2), otherwise returns 0.

getHighlightDecal

HighlightDecal getHighlightDecal (string name)

Returns the highlight decal of the specified name.

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

Returns:: HighlightDecal - The highlight decal of the specified name.

getHighlightDecals

array{HighlightDecal} getHighlightDecals ()

Returns an array of the highlight decals in the arena.

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

getID

string getID ()

Returns the object ID.

Returns:: string - Object ID.

getKeyPressedListener

Object, string, InterModel, boolean, string getKeyPressedListener (string key)

Returns the 'key pressed' listener of the Arena.

Parameters:: string key - The key that will trigger the event.

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.

getKeyPressedListener

Object, string, InterModel, boolean, string getKeyPressedListener (string key, boolean ctrl, boolean alt, boolean shift)

Returns the 'key pressed' listener of the Arena.

Parameters:: string key - The key that will trigger the event.; 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.

getKeyReleasedListener

Object, string, InterModel, boolean, string getKeyReleasedListener (string key)

Returns the 'key released' listener of the Arena.

Parameters:: string key - The key that will trigger the event.

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.

getKeyReleasedListener

Object, string, InterModel, boolean, string getKeyReleasedListener (string key, boolean ctrl, boolean alt, boolean shift)

Returns the 'key released' listener of the Arena.

Parameters:: string key - The key that will trigger the event.; 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.

getLight

Light getLight (string name)

Returns a light in the Arena with the specified name.

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

Returns:: Light - Light with the specified name.

getLightColour

number, number, number getLightColour ()

Returns the ambient light colour.

Returns:: number - Red Colour value (between 0 and 255).; number - Green Colour value (between 0 and 255).; number - Blue Colour value (between 0 and 255).

getLights

array{Light} getLights ()

Returns an array containig the lights of the Arena.

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

getMaterial

Material getMaterial (string name)

Returns the material with the specified name from the arena.

Parameters:: string name - Name of the material.

Returns:: Material - Material with the specified name.

getMaterials

array{Material} getMaterials ()

Returns an array containing all the materials in the arena.

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

getMatrices

array{Matrix} getMatrices ()

Returns an array containing the matrices in the arena.

Returns:: array{Matrix} - Array containing the matrices in the arena.

getMatrix

Matrix getMatrix (string matrixName)

Returns a matrix with the specified name from the arena.

Parameters:: string matrixName - Name of the matrix.

Returns:: Matrix - Matrix with the specified name.

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

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

getMouseButtonClickedListener

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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.

getMyPresence

Presence getMyPresence ()

Returns the presence that represents the player of this simulation..

Returns:: Presence - The presence that represents the player of this simulation.

getName

string getName ()

Returns the name of the Arena.

Returns:: string - Name of the Arena.

getObject

Object getObject (string objectID)

Returns the object with the specified ID from this Arena.

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

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

getObjectsByName

array{Object} getObjectsByName (string Name)

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

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

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

getObjectsByTemplate

array{Object} getObjectsByTemplate (string templateName)

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

Parameters:: string templateName - Name of the template.

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

Parameters:: string name - Name of the Overlay.

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

getOverlays

array{} getOverlays ()

Returns the Overlays contained in this Arena.

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

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

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

getPresence

Presence getPresence (string objectID)

Returns the presence with the specified object ID.

Parameters:: string objectID - Object ID of the Presence to return.

Returns:: Presence - Presence with the specified object ID.

getPresences

array{Presence} getPresences ()

Returns an array containing all presences in the arena.

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

getPresencesByName

array{Presence} getPresencesByName (string name)

Returns an array containing the presences with the specified name in the arena.

Parameters:: string name - Name of the presences to return.

Returns:: array{Presence} - Array containing the presences with the specified name in the arena.

getPresencesByTemplate

array{Presence} getPresencesByTemplate (string class)

Returns an array containing the presences with the specified class name in the arena.

Parameters:: string class - Class name of the presences to return.

Returns:: array{Presence} - Array containing the presences with the specified class name in the arena.

getRayHitListener

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

Returns the 'mouse entered' listener of the Arena.

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

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

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

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

getShadowAdjustFactor

number getShadowAdjustFactor ()

Gets the shadows adjustment factor.

Returns:: number - factor The shadows adjustment factor.

getShadowBlurSize

integer getShadowBlurSize ()

Gets the size of the shadow edges blur.

Returns:: integer - size The size of the shadow edges blur

getShadowColour

integer getShadowColour ()

Gets the colour of the shadows.

Returns:: integer - colour The colour of the shadows.

getShadowFarDistance

integer getShadowFarDistance ()

Gets the maximum distance at which the shadows are visible.

Returns:: integer - distance The maximum distance at which the shadows are visible.

getShadowTechnique

number getShadowTechnique ()

Gets the shadow technique currently beeing used by the system. Available shadow techniques: STENCIL,TEXTURE,DEPTH MAPPING

Returns:: number - technique The shadow technique currently in use.

getShadowTextureCount

integer getShadowTextureCount ()

Gets the maximum number of visible shadows.

Returns:: integer - count The maximum number of shadow textures.

getShadowTextureSize

integer getShadowTextureSize ()

Gets the size of the shadow texture.

Returns:: integer - size The size of the shadow texture.

getSkyBox

boolean, string, string, string, string, string, string, number getSkyBox ()

Gets the sky box to the arena.

Returns:: boolean - Whether the sky box is enabled or not.; string - Name of the material to be applied on the up side of the sky box.; string - Name of the material to be applied on the front side of the sky box.; string - Name of the material to be applied on the back side of the sky box.; string - Name of the material to be applied on the left side of the sky box.; string - Name of the material to be applied on the right side of the sky box.; string - Name of the material to be applied on the down side of the sky box.; number - of the sky box to the center of the arena.

getSkyPlane

string, number, number, number getSkyPlane ()

Gets the sky plane from the arena.

Returns:: string - Name of the material to be applied on the sky plane.; number - The size of the sky plane.; number - The number of times that the material will be repeated in the sky plane.; number - The distance at which the plane is placed

getSongFromPlaylist

meditaitem getSongFromPlaylist (string name)

Returns the Media Item containing the song of the specified name from the playlist of the arena.

Parameters:: string name - Name of the song.

Returns:: meditaitem - Media Item containing the song.

getSongsFromPlaylist

hashtable{string,mediaitem} getSongsFromPlaylist ()

Retuerns an hashtable containg the playlist in pairs of song name and song mediaitem.

Returns:: hashtable{string,mediaitem} - Hashtable containg pairs of song name and song mediaitem.

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

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

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

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

getTimerListener

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

Gets a 'timer' listener of the Arena.

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 Arena has a 'pathfind started' Listener, otherwise 'false'.

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

hasAIMovementOnStopListener

boolean hasAIMovementOnStopListener ()

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

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

hasAnimationTrack

boolean hasAnimationTrack (string name)

Checks if the Arena has an animation track with name 'name'

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

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

hasAttribute

boolean hasAttribute (string name)

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

Parameters:: string name - Name of the attribute

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

hasCamera

boolean hasCamera (string cameraName)

Returns 'true' if there is a camera with the specified name in the arena, otherwise 'false'.

Parameters:: string cameraName - Name of the camera

Returns:: boolean - 'True' if there is a camera with the specified name in the arena, otherwise 'false'.

hasKeyPressedListener

boolean hasKeyPressedListener (string key)

Returns 'true' if the Arena has a listener for the 'key pressed' event, otherwise 'false'.

Parameters:: string key - The key that will trigger the event.

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

hasKeyPressedListener

boolean hasKeyPressedListener (string key, boolean ctrl, boolean alt, boolean shift)

Returns 'true' if the Arena has a listener for the 'key pressed' event, otherwise 'false'.

Parameters:: string key - The key that will trigger the event.; 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 Arena has a listener for the 'key pressed' event, otherwise 'false'.

hasKeyReleasedListener

boolean hasKeyReleasedListener (string key)

Returns 'true' if the Arena has a listener for the 'key released' event, otherwise 'false'.

Parameters:: string key - The key that will trigger the event when released.

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

hasKeyReleasedListener

boolean hasKeyReleasedListener (string key, boolean ctrl, boolean alt, boolean shift)

Returns 'true' if the Arena has a listener for the 'key released' event, otherwise 'false'.

Parameters:: string key - The key that will trigger the event when released.; 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 Arena has a listener for the 'key released' event, otherwise 'false'.

hasMaterial

boolean hasMaterial (string name)

Returns 'true' if there is a material with the specified name in the arena, otherwise 'false'.

Parameters:: string name - Name of the material.

Returns:: boolean - 'True' if there is a material with the specified name in the arena, otherwise 'false'.

hasMatrix

boolean hasMatrix (string matrixName)

Returns 'true' if there is a matrix with the sopecified name in the arena, otherwise 'false'.

Parameters:: string matrixName - Name of the matrix.

Returns:: boolean - 'True' if there is a matrix with the sopecified name in the arena, otherwise 'false'.

hasModel

boolean hasModel (string name)

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

hasMouseButtonDoubleClickedListener

boolean hasMouseButtonDoubleClickedListener (number mousekey)

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

hasMouseButtonPressedListener

boolean hasMouseButtonPressedListener (number mousekey)

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

hasMouseButtonReleasedListener

boolean hasMouseButtonReleasedListener (number mousekey)

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

hasMouseEnteredListener

boolean hasMouseEnteredListener ()

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

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

hasMouseEnteredListener

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

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

hasMouseMovedListener

boolean hasMouseMovedListener ()

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

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

hasMouseMovedListener

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

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

hasMouseWheelMovedListener

boolean hasMouseWheelMovedListener (number mousekey)

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

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

hasRayHitListener

boolean hasRayHitListener ()

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

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

hasRiver

boolean hasRiver (string name)

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

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

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

isAmbientSoundOnLoad

boolean isAmbientSoundOnLoad ()

Returns 'true' if the ambient sound is enabled in the arena, otherwise 'false'.

Returns:: boolean - 'True' if the ambient sound is enabled in the arena, 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'.

isShadowRenderBackfaces

boolean isShadowRenderBackfaces ()

Gets if the shadow caster is projecting the front or the back faces.

Returns:: boolean - Whether the shadow caster is projecting the front or the back faces.

isSkyBoxEnabled

boolean isSkyBoxEnabled ()

Gets if the sky box is enabled or not.

Returns:: boolean - Whether the sky box is enabled or not.

isSkyDomeEnabled

boolean isSkyDomeEnabled ()

Gets if the sky dome is enabled or not.

Returns:: boolean - Whether the sky dome is enabled or not.

isSkyPlaneEnabled

boolean isSkyPlaneEnabled ()

Gets if the sky plane is enabled or not.

Returns:: boolean - Whether the sky plane is enabled or not.

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

pauseAmbientSound

nil pauseAmbientSound ()

Pauses the ambient sound in the arena.

pausePlaylist

nil pausePlaylist ()

Pauses playing the song from the playlist.

playAmbientSound

nil playAmbientSound ()

Starts playing the ambient sound in the arena.

playPlaylist

nil playPlaylist ()

Continues playing the song of the playlist where it was last paused.

playSongFromPlaylist

nil playSongFromPlaylist (string name)

Starts to play the specified song from the playlist.

Parameters:: string name - Name of the song to play.

print

nil print ()

Prints the Arena data and attributes to the console

removeAIMovementOnStartListener

nil removeAIMovementOnStartListener ()

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

removeAIMovementOnStopListener

nil removeAIMovementOnStopListener ()

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

removeAllAnimationTracks

nil removeAllAnimationTracks ()

Removes all animation tracks of the Arena.

removeAllAttributes

nil removeAllAttributes ()

Removes all attributes of the Arena.

removeAllBillboards

nil removeAllBillboards ()

Removes all billboards of the Arena.

removeAllCameras

nil removeAllCameras ()

Removes all cameras from the arena.

removeAllEffects

nil removeAllEffects ()

Removes all effects of the Arena.

removeAllHighlightDecals

nil removeAllHighlightDecals ()

Removes all highlight decals from the arena.

removeAllLights

nil removeAllLights ()

Removes all lights from the Arena.

removeAllMatrices

nil removeAllMatrices ()

Removes all matrices from the arena.

removeAllMeshDecals

nil removeAllMeshDecals ()

Removes all mesh decals from the arena.

removeAllModels

nil removeAllModels ()

Removes all models of the Arena.

removeAllObjects

nil removeAllObjects ()

Removes all objects from this Arena.

removeAllObjectsByName

nil removeAllObjectsByName (string name)

Removes all objects with the specified name from this Arena.

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

removeAllObjectsByTemplate

nil removeAllObjectsByTemplate (string templateName)

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

Parameters:: string templateName - Name of the template.

removeAllOverlays

nil removeAllOverlays ()

Removes all Overlays contained in this Arena.

removeAllPlanes

nil removeAllPlanes ()

Removes all planes of the Arena.

removeAllRepresentations

nil removeAllRepresentations ()

Removes all representations from the Arena.

removeAllRivers

nil removeAllRivers ()

Removes all rivers of the Arena.

removeAllRoads

nil removeAllRoads ()

Removes all roads of the Arena.

removeAllSongsFromPlaylist

nil removeAllSongsFromPlaylist ()

Removes all songs from the playlist of the arena.

removeAllSounds

nil removeAllSounds ()

Removes all sounds available in Arena.

removeAllStaticFloras

nil removeAllStaticFloras ()

Removes all static floras of the Arena.

removeAnimationTrack

nil removeAnimationTrack (string name)

Removes the animation track with name 'name'

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

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.

removeCamera

nil removeCamera (string cameraName)

Removes the camera with the specified name.

Parameters:: string cameraName - Name of the camera to remove.

removeEffect

nil removeEffect (string name)

Returns the effect with name 'name'

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

removeFog

nil removeFog ()

Removes the fog effect from the Arena.

removeHighlightDecal

nil removeHighlightDecal (string name)

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

Parameters:: string name - Name of the highlight decal to remove.

removeKeyPressedListener

nil removeKeyPressedListener (string key)

Removes the listener for the 'key pressed' event on the Arena.

Parameters:: string key - The key that will trigger the event.

removeKeyPressedListener

nil removeKeyPressedListener (string key, boolean ctrl, boolean alt, boolean shift)

Removes the listener for the 'key pressed' event on the Arena.

Parameters:: string key - The key that will trigger the event.; 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.

removeKeyReleasedListener

nil removeKeyReleasedListener (string key)

Removes the listener for the 'key released' event on the Arena.

Parameters:: string key - The key that will trigger the event.

removeKeyReleasedListener

nil removeKeyReleasedListener (string key, boolean ctrl, boolean alt, boolean shift)

Removes the listener for the 'key released' event on the Arena.

Parameters:: string key - The key that will trigger the event.; 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.

removeLight

nil removeLight (string name)

Removes the designated light from the Arena.

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

removeMaterial

nil removeMaterial (string materialName)

Removes the material with the specified name from the arena.

Parameters:: string materialName - Name of the material to remove.

removeMatrix

nil removeMatrix (string matrixName)

Removes the matrix with the specified name.

Parameters:: string matrixName - Name of the matrix 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 Arena.

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

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

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

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

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

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

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

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

removeMouseEnteredListener

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

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

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

removeMouseMovedListener

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

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

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

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

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

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

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

removeRepresentation

nil removeRepresentation (string name, number type)

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

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.

removeSongFromPlaylist

nil removeSongFromPlaylist (string name)

Removes a song from the playlist of the arena.

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

setActiveCamera

nil setActiveCamera (string cameraName)

Activates the camera with the specified name.

Parameters:: string cameraName - Name of the camera to activate.

setActiveCameraEdit

nil setActiveCameraEdit ()

Activates the default edition camera.

setAIMovementOnStartListener

nil setAIMovementOnStartListener (string name, InterModel interactionModel)

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

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

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

setAmbientSound

nil setAmbientSound (MediaItem sound)

Sets the ambient sound for the arena. You may have to enable the ambient sound with 'setAmbientSound' enabled.

Parameters:: MediaItem sound - Media Item containing the ambient sound for the arena.

setAmbientSoundOnLoad

nil setAmbientSoundOnLoad (boolean enable)

Enables or disables the ambient sound for the arena.

Parameters:: boolean enable - Whether the ambient sound is active on load or not.

setAmbientSoundVolume

nil setAmbientSoundVolume (float volume)

Sets the ambient sound volume for the arena.

Parameters:: float volume - ambient sound volume for the arena.

setAttribute

nil setAttribute (string name, string value)

Sets an attribute in the Arena. 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 Arena.

Parameters:: string description - Description of the Arena.

setFogExp

nil setFogExp (number r, number g, number b, number opacity)

Sets a fog of the specified colour that increases its density according to an exponential function.

Parameters:: number r - Red Colour value (between 0 and 255).; number g - Green Colour value (between 0 and 255).; number b - Blue Colour value (between 0 and 255).; number opacity - The level of opacity of the fog.

setFogExp2

nil setFogExp2 (number r, number g, number b, number opacity)

Sets a fog of the specified colour that increases its density according to a quadratic exponential function.

Parameters:: number r - Red Colour value (between 0 and 255).; number g - Green Colour value (between 0 and 255).; number b - Blue Colour value (between 0 and 255).; number opacity - The level of opacity of the fog.

setFogLinear

nil setFogLinear (number r, number g, number b, number near, number far)

Sets a fog of the specified colour that increases its density linearly from the 'near' distance to the 'far' distance.

Parameters:: number r - Red Colour value (between 0 and 255).; number g - Green Colour value (between 0 and 255).; number b - Blue Colour value (between 0 and 255).; number near - Distance radius where the fog density is null (0%).; number far - Distance where the fog density is full (100%).

setKeyPressedListener

nil setKeyPressedListener (string key, Object target, string name, InterModel interactionModel)

Sets a listener to be invoked upon a 'key pressed' event on the Arena.

Parameters:: string key - The key that will trigger the event.; 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.

setKeyPressedListener

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

Sets a listener to be invoked upon a 'key pressed' event on the Arena.

Parameters:: string key - The key that will trigger the event.; 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.

setKeyReleasedListener

nil setKeyReleasedListener (string key, Object target, string name, InterModel interactionModel)

Sets a listener to be invoked upon a 'key released' event on the Arena.

Parameters:: string key - The key that will trigger the event when released.; 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.

setKeyReleasedListener

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

Sets a listener to be invoked upon a 'key released' event on the Arena.

Parameters:: string key - The key that will trigger the event when released.; 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.

setLightColour

nil setLightColour (number Red, number Green, number Blue)

Sets the colour of the ambient light.

Parameters:: number Red - Colour value (between 0 and 255).; number Green - Colour value (between 0 and 255).; number Blue - Colour value (between 0 and 255).

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

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

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

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

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

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

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

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

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

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

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

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

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

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

setOnLoadListener

nil setOnLoadListener (string name)

Sets a listener to execute a specified interaction in this Arena 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 Arena.

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

setPlaylistLoop

nil setPlaylistLoop (boolean loop)

Sets the playlist to loop after the last song or it stops the playback.

Parameters:: boolean loop - Whether the playlist loops to the beginning after the last song or it stops the playback.

setPlaylistShuffle

nil setPlaylistShuffle (boolean loop)

Sets the playlist to play shuffled or sequentially.

Parameters:: boolean loop - Whether the playlist is shuffled or sequentially.

setPlaylistVolume

nil setPlaylistVolume (number volume)

Sets the sound volume of the playlist in the arena.

Parameters:: number volume - The sound volume of the playlist.

setRayHitListener

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

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

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

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.

setShadowAdjustFactor

nil setShadowAdjustFactor (number factor)

Sets the adjustment factor value.The consequence of a low value is that the near shadows will gain quality while the far ones will lose it. This is only used for the shadow techniques TEXTURE and DEPTH MAPPING

Parameters:: number factor - The adjustment factor value.

setShadowBlurSize

nil setShadowBlurSize (integer size)

Sets the the size of the shadow edges blur This is only used for the shadow technique DEPTH MAPPING

Parameters:: integer size - The size of the shadow edges blur. Maximum 10.

setShadowColour

nil setShadowColour (integer colour)

Sets the brightness of the shadows.

Parameters:: integer colour - The brightness of the shadows. Maximum 255.

setShadowFarDistance

nil setShadowFarDistance (integer distance)

Sets the maximum distance at which the shadows are visible. This is only used for the shadow techniques TEXTURE and DEPTH MAPPING

Parameters:: integer distance - The maximum distance at which the shadows are visible. If 0 the shadows are always visible.

setShadowRenderBackfaces

nil setShadowRenderBackfaces (boolean renderbackfaces)

Enables or disables the shadow projection of the the back faces. This is only used for the shadow techniques TEXTURE and DEPTH MAPPING

Parameters:: boolean renderbackfaces - Whether the shadow caster projects the front or the back faces.

setShadowTechnique

nil setShadowTechnique (number technique)

Sets the specified shadow technique as the used by the system. Available shadow techniques: STENCIL,TEXTURE,DEPTH MAPPING

Parameters:: number technique - The selected shadow technique.

setShadowTextureCount

nil setShadowTextureCount (integer count)

Sets the maximum number of visible shadows. The shadows that are visible are sorted by light distance. This is only used for the shadow techniques TEXTURE and DEPTH MAPPING

Parameters:: integer count - The maximum number of shadow textures to be used. Maximum 4.

setShadowTextureSize

nil setShadowTextureSize (integer size)

Sets the size of the shadow texture. This is only used for the shadow techniques TEXTURE and DEPTH MAPPING

Parameters:: integer size - The size of the shadow texture. Must be 2^n. Maximum 4096.

setSkyBox

nil setSkyBox (string upMaterial, string frontMaterial, string backMaterial, string leftMaterial, string rightMaterial, string downMaterial, number distance)

Sets the sky box to the arena.

Parameters:: string upMaterial - Name of the material to be applied on the up side of the sky box.; string frontMaterial - Name of the material to be applied on the front side of the sky box.; string backMaterial - Name of the material to be applied on the back side of the sky box.; string leftMaterial - Name of the material to be applied on the left side of the sky box.; string rightMaterial - Name of the material to be applied on the right side of the sky box.; string downMaterial - Name of the material to be applied on the down side of the sky box.; number distance - of the sky box to the center of the arena.

setSkyBoxEnabled

nil setSkyBoxEnabled (boolean enabled)

Enables or disables the sky box for the arena.

Parameters:: boolean enabled - Whether the sky box is enable or not.

setSkyDome

nil setSkyDome (string material, number curvature, number tiling, number distance)

Sets the sky dome for the arena.

Parameters:: string material - Name of the material to be applied on the sky dome.; number curvature - Level of curvature of the sky dome.; number tiling - The number of times that the material will be repeated in the sky dome.; number distance - The distance of the sky dome to the center of the arena.

setSkyDomeEnabled

nil setSkyDomeEnabled (boolean enabled)

Enables or disables the sky dome for the arena.

Parameters:: boolean enabled - Whether the sky dome is enabled or not.

setSkyPlane

nil setSkyPlane (string material, number scale, number tiling, number distance)

Sets the sky plane for the arena.

Parameters:: string material - Name of the material to be applied on the sky plane.; number scale - The size of the sky plane.; number tiling - The number of times that the material will be repeated in the sky plane.; number distance - The distance at which the plane will be placed.

setSkyPlaneEnabled

nil setSkyPlaneEnabled (boolean enable)

Enables or disables the sky plane for the arena.

Parameters:: boolean enable - Whether the sky plane is enabled or not.

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

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

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

startPlaylist

nil startPlaylist ()

Starts playing the songs of the playlist in the arena.

stopAmbientSound

nil stopAmbientSound ()

Stops the ambient sound in the arena.

stopPlaylist

nil stopPlaylist ()

Stops playing the play list.