-
Notifications
You must be signed in to change notification settings - Fork 0
Map_Points
{{Languages|Map_Points}}
FORCETOC A map point is a specific location on a world map, defined by X, Y, Z and M coordinates. Map point references, such as P from the character/item object and MAP(x,y,map) from the server object can be used to access additional information about a map point such as what static items exist at the location. The following tables detail the various properties of map points in SphereServer:
References return pointers to other objects (e.g. the REGION reference allows you to access the region that contains the map point). These can either be accessed by using <REFNAME> to return the UID (1 for object types that don't have UIDs) of the object or 0 if it doesn't exist, or by using <REFNAME.KEY> where KEY is a valid property/function/reference for the REFNAME object. Click on the name for more detailed information such as usage and examples.
{| border="1" cellspacing="4" cellpadding="4" | Name || Read/Write || Description |- | REGION || R || Gets the region that contains the map point. |- | ROOM || R || Gets the room that contains the map point. |- | SECTOR || R || Gets the sector that contains the map point. |}
Here is a list of all map point properties and functions. If a function is marked as readable then it can return a value when used as . Click on the name for more detailed information such as usage and examples.
{| border="1" cellspacing="4" cellpadding="4"
| Name || Read/Write || Description
|-
| COMPONENTS || R || Gets the number of components of the MULTI at the location.
|-
| COMPONENTS.n.ID || R || Gets the ID of the nth component at the location. (zero-based)
|-
| COMPONENTS.n.MULTI || R || Gets the UID of the MULTI item.
|-
| COMPONENTS.n.Z || R || Gets the Z level of the nth component at the location. (zero-based)
|-
| COMPONENTS.n.KEY || R || Gets the KEY property from the ITEMDEF of the nth component at the location. (zero-based)
|-
| ISNEARTYPE type, distance, check_multis || R || Returns 1 if an item exists within distance tiles of the location whose TYPE matches a specified type.
|-
| M
MAP || R || Gets the location's map number.
|-
| STATICS || R || Gets the number of static items at the location.
|-
| STATICS.n.ID || R || Gets the ID of the nth item at the location. (zero-based)
|-
| STATICS.n.COLOR || R || Gets the hue of the nth item at the location. (zero-based)
|-
| STATICS.n.Z || R || Gets the Z level of the nth item at the location. (zero-based)
|-
| STATICS.n.KEY || R || Gets the KEY property from the ITEMDEF of the nth item at the location. (zero-based)
|-
| TERRAIN || R || Gets the terrain's ID at the location.
|-
| TERRAIN.Z || R || Gets the terrain's Z level at the location.
|-
| TYPE || R || Gets the terrain's TYPE at the location.
|-
| X || R || Gets the X coordinate of the location.
|-
| Y || R || Gets the Y coordinate of the location.
|-
| Z || R || Gets the Z coordinate of the location.
|}
Category: Reference Compendium Category: Objects