Difference between revisions of "Location keyword"

Revision as of 01:13, 3 August 2011

The location type is a structure which consists of three members: an area object, a position vector and a facing float.

Constructor

A constructor is a function that creates an instance of a data type.

The constructor for a location is the Location function.

Literals

A literal is a textual representation of a particular value of a type.

There is no literal for a location.

Conversion

There is no explicit or implicit conversion to or from a location.

Persistence

The following functions allow a location to exist outside of the scope of the current script by storing it on an object or event:

• SetLocalLocation
• SetEventLocation

The following functions allow a location which exists outside of the scope of the current script to be used in the current script by retrieving it from an object or event:

• GetLocalLocation
• GetEventLocation

Examples

void main()
{
    // uninitialised
    location lDefault;
 
    // initialised using the constructor
    location lConstructed = Location(oArea, vPosition, fFacing);
 
    // assigned using the Player's location
    location lAssigned = GetLocation(GetHero());    
}

See Also

GetLocation