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

MeshDecal

Method Summary
`int`	`getDetailLevel ()`
`string`	`getID ()`
`string`	`getMaterial ()`
`array{}`	`getPoints ()`
`number, number, number`	`getPosition ()`
`number, number`	`getScale ()`
`number`	`getType ()`
`boolean`	`isVisible ()`
`nil`	`print ()`
`nil`	`setDetailLevel (int level)`
`nil`	`setMaterial (string material)`
`nil`	`setPoints (array{} points)`
`nil`	`setPosition (number x, number y, number z)`
`nil`	`setScale (number x, number z)`
`nil`	`setVisible (boolean visible)`

Method Detail

getDetailLevel

int getDetailLevel ()

Gets the Mesh Decal detail level

Returns:: int - level Mesh Decal level of detail

getID

string getID ()

Returns the representation ID.

Returns:: string - Representation ID.

getMaterial

string getMaterial ()

Gets the material of the MeshDecal

Returns:: string - Material name.

getPoints

array{} getPoints ()

Gets the perimeter of the Mesh Decal.

Returns:: array{} - The array of points that define the perimeter of the Mesh Decal.

getPosition

number, number, number getPosition ()

Returns the position of the MeshDecal.

Returns:: number - The position of the MeshDecal in the X coordinate.; number - The position of the MeshDecal in the Y coordinate.; number - The position of the MeshDecal in the Z coordinate.

getScale

number, number getScale ()

Returns the scale of the Mesh Decal

Returns:: number - The scale ratio of the Mesh Decal in the X coordinate.; number - The scale ratio of the Mesh Decal in the Z coordinate.

getType

number getType ()

Returns the representation type:
2 - MODEL,
3 - LIGHT,
4 - EFFECT,
5 - PLANE,
6 - WATER,
7 - SOUND,
8 - TERRAIN_MESH_DECAL,
9 - TERRAIN_HIGHLIGHTING_DECAL,
10 - BILLBOARD,
11 - OVERLAY

Returns:: number - The type of the representation.

isVisible

boolean isVisible ()

Returns 'true' if the representation is visible, 'false' otherwise.

Returns:: boolean - Whether the MeshDecal is visible or not.

print

nil print ()

Prints the MeshDecal data and attributes to the console.

setDetailLevel

nil setDetailLevel (int level)

Sets the detail level for the Mesh Decal.

Parameters:: int level - Mesh Decal detail level.

setMaterial

nil setMaterial (string material)

Sets the material for the Mesh Decal.

Parameters:: string material - Material name.

setPoints

nil setPoints (array{} points)

Sets the perimeter of the Mesh Decal.

Parameters:: array{} points - The points (x,z) that define the perimeter of the Mesh Decal.

setPosition

nil setPosition (number x, number y, number z)

Sets the position of the MeshDecal in the 3D space (x,y,z).

Parameters:: number x - New position in the X axis.; number y - New position in the Y axis.; number z - New position in the Z axis.

setScale

nil setScale (number x, number z)

Scales the Mesh Decal

Parameters:: number x - Scale ratio in the X coordinate.; number z - Scale ratio in the Z coordinate.

setVisible

nil setVisible (boolean visible)

Makes the MeshDecal visible or invisible.

Parameters:: boolean visible - Whether the MeshDecal is visible or not.