NDOII

[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

IsBeingCarriedBy() Params gameobject - carrier Returns bool - If the object is being carried by the specified object, true. Otherwise false

Is this object currently in the carry slot for this mobile. The carry slot is used when a user has picked up an object but not dropped it..

Example

 CODE EXAMPLE BLOCK

IsCloaked() Returns bool - is cloaked true/false

Is the object cloaked.

Example

 CODE EXAMPLE BLOCK

IsContainedBy() Params gameobject - container object if its contained, nil if not bool - should we check multiple levles up Returns bool - is the object inside the specified target

Returns true if the object is inside the specified container.

Example

 CODE EXAMPLE BLOCK

IsContainer() Returns bool - true if this object is a container

Returns if its a container object.

Example

 CODE EXAMPLE BLOCK

IsEquipped() Returns bool - true if item is equipped, false if not

Checks to see if the object is equipped by anyone.

Example

 CODE EXAMPLE BLOCK

IsEquippedOn() Params gameobject - equipper object Returns bool - true if this object is equipped on a given object

Checks to see if the object is equipped on the specified object.

Example

 CODE EXAMPLE BLOCK

IsFull() Returns bool - true if full, false if not

Determine if this container is full and cannot accept more items.

Example

 CODE EXAMPLE BLOCK

IsInContainer() Returns bool - true if object is inside a container

Returns if the object is inside a contianer.

Example

 CODE EXAMPLE BLOCK

IsInRegion() Params regionname - the name of the region Returns bool - true if is in the specified region

Is the object in the specified region.

Example

 CODE EXAMPLE BLOCK

IsMobile() Returns bool - true if the object is a mobile object

Returns if its a mobile object. A mobile is a special class of object that can travel around fluidly.

Example

 CODE EXAMPLE BLOCK

IsMobileFrozen() Params bool - true if frozem, false if not

Is the mobile object frozen. This only works for Mobiles. The argument is always set to true,OptionaL check if the mobs turn is frozen also (default true) meaning the argument is unused.

Example

 CODE EXAMPLE BLOCK

IsMoving() Returns bool - true if moving, false if not

Returns true if a mobile is currently moving.

Example

 CODE EXAMPLE BLOCK

IsPathingToTarget() Returns bool - true if is pathing, false if not

Returns if the current mobile has a PathToTarget set on it or not.

Example

 CODE EXAMPLE BLOCK

IsPermanent() Returns ???????

Returns if this object is a permanent, static object or a dynamic, nonpermanent object. Defined under dynamic objects as well.

Example

 CODE EXAMPLE BLOCK

IsPlayer() Returns bool - true if a player false if not

Is this object a player.

Example

 CODE EXAMPLE BLOCK

IsRegeneratingStat() Params statname - stat name Returns bool - true if regenerating stat

Returns true if the specified stat support regen and max value.

Example

 CODE EXAMPLE BLOCK

IsUser() Returns bool - has a user attached to, if so true, if not then false

Returns if object has a user attached to it.

Example

 CODE EXAMPLE BLOCK

IsValid()

.

Example

 CODE EXAMPLE BLOCK