# 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](Characters.md)/[item](Items.md) object and *MAP(x,y,map)* from the [server](Server.md) 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
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](UID.md) (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](REGION.md) || R || Gets the [region](Regions.md) that contains the map point.
|-
| [ROOM](ROOM.md) || R || Gets the [room](Rooms.md) that contains the map point.
|-
| [SECTOR](SECTOR.md) || R || Gets the [sector](Sectors.md) that contains the map point.
|}


## Properties and Functions
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 <KEY>. Click on the name for more detailed information such as usage and examples.

{| border="1" cellspacing="4" cellpadding="4"
| **Name** || **Read/Write** || **Description**
|-
| [COMPONENTS](COMPONENTS.md) || R || Gets the number of components of the [MULTI](MULTI.md) at the location.
|-
| [COMPONENTS](COMPONENTS.md)*.n.ID* || R || Gets the ID of the nth component at the location. (zero-based)
|-
| [COMPONENTS](COMPONENTS.md)*.n.MULTI* || R || Gets the UID of the MULTI item. 
|-
| [COMPONENTS](COMPONENTS.md)*.n.Z* || R || Gets the Z level of the nth component at the location. (zero-based)
|-
| [COMPONENTS](COMPONENTS.md)*.n.KEY* || R || Gets the *KEY* property from the [ITEMDEF](ITEMDEF.md) of the nth component at the location. (zero-based)
|-
| [ISNEARTYPE](ISNEARTYPE.md) *type, distance, check_multis* || R || Returns 1 if an item exists within *distance* tiles of the location whose [TYPE](TYPE.md) matches a specified type.
|-
| [M](M.md)<br />[MAP](MAP.md) || R || Gets the location's map number.
|-
| [STATICS](STATICS.md) || R || Gets the number of static items at the location.
|-
| [STATICS](STATICS.md)*.n.ID* || R || Gets the ID of the nth item at the location. (zero-based)
|-
| [STATICS](STATICS.md)*.n.COLOR* || R || Gets the hue of the nth item at the location. (zero-based)
|-
| [STATICS](STATICS.md)*.n.Z* || R || Gets the Z level of the nth item at the location. (zero-based)
|-
| [STATICS](STATICS.md)*.n.KEY* || R || Gets the *KEY* property from the [ITEMDEF](ITEMDEF.md) of the nth item at the location. (zero-based)
|-
| [TERRAIN](TERRAIN.md) || R || Gets the terrain's ID at the location.
|-
| [TERRAIN](TERRAIN.md).Z || R || Gets the terrain's Z level at the location.
|-
| [TYPE](TYPE.md) || R || Gets the terrain's TYPE at the location.
|-
| [X](X.md) || R || Gets the X coordinate of the location.
|-
| [Y](Y.md) || R || Gets the Y coordinate of the location.
|-
| [Z](Z.md) || R || Gets the Z coordinate of the location.
|}

[Category: Reference Compendium](Category:_Reference_Compendium.md)
[Category: Objects](Category:_Objects.md)