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

HighlightDecal

Method Summary
`string`	`getID ()`
`number, number`	`getPosition ()`
`number, number`	`getSize ()`
`string`	`getTexture ()`
`number`	`getType ()`
`boolean`	`isVisible ()`
`nil`	`print ()`
`nil`	`setPosition (number x, number z)`
`nil`	`setSize (number w, number l)`
`nil`	`setTexture (string material)`
`nil`	`setVisible (boolean visible)`

Method Detail

getID

string getID ()

Returns the representation ID.

Returns:: string - Representation ID.

getPosition

number, number getPosition ()

Gets the center of the Highlight Decal.

Returns:: number - The X coordinate of the center of the Highlight Decal.; number - The Y coordinate of the center of the Highlight Decal.

getSize

number, number getSize ()

Sets the size of the Highlight Decal.

Returns:: number - Width of the Highlight Decal.; number - Lenght of the Highlight Decal.

getTexture

string getTexture ()

Error getting the material of the HighlightDecal

Returns:: string - Texture name.

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 HighlightDecal is visible or not.

print

nil print ()

Prints the HighlightDecal data and attributes to the console.

setPosition

nil setPosition (number x, number z)

Sets the center of the Highlight Decal.

Parameters:: number x - The X coordinate of the center of the Highlight Decal.; number z - The Y coordinate of the center of the Highlight Decal.

setSize

nil setSize (number w, number l)

Gets the size of the Highlight Decal.

Parameters:: number w - Width of the Highlight Decal.; number l - Lenght of the Highlight Decal.

setTexture

nil setTexture (string material)

Sets the material for the Highlight Decal.

Parameters:: string material - Texture name.

setVisible

nil setVisible (boolean visible)

Makes the HighlightDecal visible or invisible.

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