NDOIC

[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

CanHold() Params gameobject - target object Returns bool - true if can hold, false if can not

Is this object a container and can it hold the object passed in. This will fail if adding this object would put the container over its capacity. This does not currently check weight limits.

Example

 CODE EXAMPLE BLOCK

CanPathTo() Params origin - the origin position destination - the destination position Returns bool - true if works, false if it does not

Checks for a valid path from the mobile's position to location using A* algorithm.

Example

 CODE EXAMPLE BLOCK

CarriedObject() Returns gameobject - carried object

Get the object this mobile is carrying. The carry slot is used when a user has picked up an object but not dropped it.

Example

 CODE EXAMPLE BLOCK

ClearCollisionBounds() Returns bool - true if successful, false if not

Remove all collision entries from the specified object.

Example

 CODE EXAMPLE BLOCK

ClearPathTarget() Returns bool - true if works, false if not

Tell the mobile to stop pathing to his target.

Example

 CODE EXAMPLE BLOCK

CloseDynamicWindow() Params windowid - dynamic window id to close

Description: Close a dynamic window on the client.

Example

 CODE EXAMPLE BLOCK

CompleteLogout() Returns bool - true if successful, false if not

Complete the logout, saving the character to the backup.

Example

 CODE EXAMPLE BLOCK

ContainedBy() Returns gameobject - container object if it is contained, null if not

Return the container this object is inside.

Example

 CODE EXAMPLE BLOCK

CopyObject() Params eventid - event identifier for the resulting createdobject event (...) One or more object arguments to be passed to the CreatedObject event. Function references are not supported

Copy this object. Once the copy is done, a CreatedObject event is fired.

Example

 CODE EXAMPLE BLOCK