NDOID

From Legends of Aria Admin and Modding Wiki
Jump to: navigation, search

[Main] [Lua Examples]

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

Object Functions & Examples

DecayScheduled()

Returns
bool - true if has decay scheduled or note
Returns true/false if the object has decay schedule on it.

Example

 CODE EXAMPLE BLOCK

DelModule()

Params
filename - filename to the given script
Returns
bool - returns ture if worked, false if not existing
Removes a script module, preventing it from executing any more code. Removes all event handlers code as well from this object.

Example

 CODE EXAMPLE BLOCK

DelObjVar()

Params
objvar - name of the variable to delete
Returns
bool - true if worked, false if not
Removes a given object variable from an object. Remember to make sure it exists first.

Example

 CODE EXAMPLE BLOCK

DeleteCharacter()

Permanentely deletes the character record associated with this object. This user will be kicked when complete.

Example

 CODE EXAMPLE BLOCK

Destroy()

Params
eventid - identifier for event response
(...) - extra args for the event
Returns
bool - true if worked, false if not
Destroy this object. You can not destroy an object that is attached to a user.

Example

 CODE EXAMPLE BLOCK

DistanceFrom()

Params
gameobject - other object
Returns
number - distance from object
Distance from specified object.

Example

 CODE EXAMPLE BLOCK

DistanceFromSquared()

Params
gameobject - other game object
Returns
nummber - distance squared between the two game object vectors
Distance from specified object multiplied by itself. Used for speedy comparisons.

Example

 CODE EXAMPLE BLOCK