UOX3 Script Engine

API and Event handling

Multi Functions

FindMulti
ProtoType	multiID FindMulti( x, y, z, worldNumber );
Purpose	Finds the multi that is in the area of the coordinates (x, y, z) in world worldNumber (0 == Britannia, 2 == ilshenar)
Example of Usage	var iMulti = FindMulti( pChar.x, pChar.y, pChar.z, pChar.worldnumber ); if( iMulti ) { pChar.TextMessage( "You know, I'm standing in a house!" ); }

IsInMulti
ProtoType	bool IsInMulti( ourObj );
Purpose	Returns true if the object is in the multi.
Example of Usage	var iMulti = FindMulti( ourObj.x, ourObj.y, ourObj.z, pChar.worldnumber ); if( iMulti ) { if( iMulti.IsInMulti( ourObj ) ) { ourObj.TextMessage( "I am in a multi!" ); } {

IsMulti
ProtoType	bool IsMulti( iToCheck );
Purpose	Returns true if the item iToCheck is actually a multi
Example of Usage	if( IsMulti( GetCharPack( pTalking ) ) ) { TextMessage( pTalkingTo, "Sir, do you realize you have a house on your back?" ); }

IsOnBanList
ProtoType	bool IsOnBanList( pChar );
Purpose	Returns true if the character pChar is on the multi's ban list
Example of Usage	var iMulti = FindMulti( ourObj.x, ourObj.y, ourObj.z, pChar.worldnumber ); if( iMulti.IsOnBanList( pChar )) { pChar.TextMessage( "Oops, I appear to be on the banlist of this house!" ); }

IsOnBanList

ProtoType

bool IsOnBanList( pChar );

Purpose

Returns true if the character pChar is on the multi's ban list

Example of Usage

var iMulti = FindMulti( ourObj.x, ourObj.y, ourObj.z, pChar.worldnumber );
if( iMulti.IsOnBanList( pChar ))
{
	pChar.TextMessage( "Oops, I appear to be on the banlist of this house!" );
}

IsOnOwnerList
ProtoType	bool IsOnOwnerList( pChar );
Purpose	Returns true if the character pChar is an owner of the multi
Example of Usage	var iMulti = FindMulti( pChar.x, pChar.y, pChar.z, pChar.worldnumber ); if( iMulti.IsOnOwnerList( pChar )) { pChar.TextMessage( "Ahh, I appear to be on the owner-list of this house!" ); }

IsOnOwnerList

ProtoType

bool IsOnOwnerList( pChar );

Purpose

Returns true if the character pChar is an owner of the multi

Example of Usage

var iMulti = FindMulti( pChar.x, pChar.y, pChar.z, pChar.worldnumber );
if( iMulti.IsOnOwnerList( pChar ))
{
	pChar.TextMessage( "Ahh, I appear to be on the owner-list of this house!" );
}

AddToBanList
ProtoType	bool AddToBanList( pChar );
Purpose	Adds the character pChar to the multi's ban list. Returns true if the parameters are valid.
Example of Usage	var iMulti = FindMulti( pChar.x, pChar.y, pChar.z, pChar.worldnumber ); pChar.TextMessage( "I'm getting banned from this house!" ); iMulti.AddToBanList( pChar );

AddToOwnerList
ProtoType	bool AddToOwnerList( pChar );
Purpose	Adds the character pChar to the multi's owner list. Doesn't remove existing owners at all. Won't duplicate if already on the list.
Example of Usage	var iMulti = FindMulti( pChar.x, pChar.y, pChar.z, pChar.worldnumber ); pChar.TextMessage( "Awww, I'm being added as an owner of this house!" ); iMulti.AddToOwnerList( pChar );

AddToOwnerList

ProtoType

bool AddToOwnerList( pChar );

Purpose

Adds the character pChar to the multi's owner list. Doesn't remove existing owners at all. Won't duplicate if already on the list.

Example of Usage

var iMulti = FindMulti( pChar.x, pChar.y, pChar.z, pChar.worldnumber );
pChar.TextMessage( "Awww, I'm being added as an owner of this house!" );
iMulti.AddToOwnerList( pChar );

RemoveFromBanList
ProtoType	bool RemoveFromBanList( pChar );
Purpose	Removes pChar from the multi's ban list. Returns true on correct parameters.
Example of Usage	var iMulti = FindMulti( pChar.x, pChar.y, pChar.z, pChar.worldnumber ); pChar.TextMessage( "Yay! I've been removed from the ban-list of this house!" ); iMulti.RemoveFromBanList( pChar );

RemoveFromBanList

ProtoType

bool RemoveFromBanList( pChar );

Purpose

Removes pChar from the multi's ban list. Returns true on correct parameters.

Example of Usage

var iMulti = FindMulti( pChar.x, pChar.y, pChar.z, pChar.worldnumber );
pChar.TextMessage( "Yay! I've been removed from the ban-list of this house!" );
iMulti.RemoveFromBanList( pChar );

RemoveFromOwnerList
ProtoType	bool RemoveFromOwnerList( pChar );
Purpose	Removes pChar from the multi's owner list. Returns true on correct parameters.
Example of Usage	var iMulti = FindMulti( pChar.x, pChar.y, pChar.z, pChar.worldnumber ); pChar.TextMessage( "Oops! I am being removed as owner of this house!" ); iMulti.RemoveFromOwnerList( pChar );

RemoveFromOwnerList

ProtoType

bool RemoveFromOwnerList( pChar );

Purpose

Removes pChar from the multi's owner list. Returns true on correct parameters.

Example of Usage

var iMulti = FindMulti( pChar.x, pChar.y, pChar.z, pChar.worldnumber );
pChar.TextMessage( "Oops! I am being removed as owner of this house!" );
iMulti.RemoveFromOwnerList( pChar );