Map Points - Revision history

Darksun84: /* Properties and Functions */

2023-02-09T17:55:57Z

‎Properties and Functions

Darksun84: /* Properties and Functions */

2023-02-09T17:55:38Z

‎Properties and Functions

Sirius: Added languagemenue

2010-11-26T20:49:41Z

Added languagemenue

MrSugarCube at 21:09, 7 June 2009

2009-06-07T21:09:22Z

MrSugarCube at 17:56, 7 June 2009

2009-06-07T17:56:01Z

MrSugarCube at 15:42, 7 June 2009

2009-06-07T15:42:23Z

MrSugarCube: Created page with '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...'

2009-06-07T14:16:28Z

Created page with '__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...'

New page

__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 [[Characters|character]]/[[Items|item]] object and ''MAP(x,y,map)'' from the [[Server|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==
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 [[Regions|region]] that contains the map point.
|-
| [[ROOM]] || R || Gets the [[Regions|room]] that contains the map point.
|-
| [[SECTOR]] || R || Gets the [[Sectors|sector]] 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. If an attempt is made to access a property that does not exist on the item, the property from the [[ITEMDEF]] will be accessed instead.

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Read/Write''' || '''Description'''
|-
| [[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]]<br />[[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.
|-
| [[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]]

← Older revision		Revision as of 20:49, 26 November 2010
Line 1:		Line 1:
		+	{{Languages\|Map_Points}}
		+
	__FORCETOC__		__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 [[Characters\|character]]/[[Items\|item]] object and ''MAP(x,y,map)'' from the [[Server\|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:		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 [[Characters\|character]]/[[Items\|item]] object and ''MAP(x,y,map)'' from the [[Server\|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:

@@ Line 34: / Line 34: @@
 |-
 | [[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.
 |-

@@ Line 25: / Line 25: @@
 | '''Name''' || '''Read/Write''' || '''Description'''
 |-
 | [[ISNEARTYPE]] ''type, distance, check_multis'' || R || Returns 1 if an item exists within ''distance'' tiles of the location whose [[TYPE]] matches a specified type.
 |-

@@ Line 38: / Line 38: @@
 |-
 | [[TERRAIN]] || R || Gets the terrain's ID at the location.
 |-
 | [[TYPE]] || R || Gets the terrain's TYPE at the location.

@@ Line 11: / Line 11: @@
 | [[REGION]] || R || Gets the [[Regions|region]] that contains the map point.
 |-
-| [[ROOM]] || R || Gets the [[Regions|room]] that contains the map point.
+| [[ROOM]] || R || Gets the [[Rooms|room]] that contains the map point.
 |-
 | [[SECTOR]] || R || Gets the [[Sectors|sector]] that contains the map point.

@@ Line 18: / Line 18: @@
 ==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. If an attempt is made to access a property that does not exist on the item, the property from the [[ITEMDEF]] will be accessed instead.
+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"

Map Points - Revision history

Darksun84: /* Properties and Functions */

Darksun84: /* Properties and Functions */

Sirius: Added languagemenue

MrSugarCube at 21:09, 7 June 2009

MrSugarCube at 17:56, 7 June 2009

MrSugarCube at 15:42, 7 June 2009

MrSugarCube: Created page with '__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...'

MrSugarCube: Created page with '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...'