Resource:Interiors - Revision history

Awwu at 13:09, 3 September 2009

2009-09-03T13:09:57Z

← Older revision		Revision as of 13:09, 3 September 2009
Line 4:		Line 4:

	=Loading interiors from the resource=		=Loading interiors from the resource=
	By default, the interiors resource offers over 200 of single player's own interior locations. Coupled with [[dimension~~\|dimensions~~]], each and every warp point offers a unique location - with a total of over 450 locations.		By default, the interiors resource offers over 200 of single player's own interior locations. Coupled with [[dimension]]s, each and every warp point offers a unique location - with a total of over 450 locations.

	Loading these interiors is easy. Starting the ''interiors'' resource will auto load all these preset warp points and will be ready to use out of the box.		Loading these interiors is easy. Starting the ''interiors'' resource will auto load all these preset warp points and will be ready to use out of the box.
Line 58:		Line 58:
	====Syntax====		====Syntax====
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	marker ~~getInteriorName~~ ( element interiorEntry/InteriorReturn )		marker getInteriorMarker ( element interiorEntry/InteriorReturn )
	</syntaxhighlight>		</syntaxhighlight>

Line 104:		Line 104:
	====Parameters====		====Parameters====
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	~~player~~ hitInterior		element hitInterior
	</syntaxhighlight>		</syntaxhighlight>

Line 122:		Line 122:
	====Parameters====		====Parameters====
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	~~player~~ warpedInterior		element warpedInterior
	</syntaxhighlight>		</syntaxhighlight>

Divine at 14:23, 31 August 2009

2009-08-31T14:23:11Z

← Older revision		Revision as of 14:23, 31 August 2009
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Resource page}}		{{Resource page}}
	The interiors resource provides a generic system for use of the single player's interiors system, which is included in the MTASA~~:DM DP2~~ server package onwards. This means placing warp points where when players hit the marker, they are set into the appropriate interior.		The interiors resource provides a generic system for use of the single player's interiors system, which is included in the MTASA 1.0 server package onwards. This means placing warp points where when players hit the marker, they are set into the appropriate interior.

	=Loading interiors from the resource=		=Loading interiors from the resource=
Line 134:		Line 134:
	===Examples===		===Examples===
	'''Coming soon'''		'''Coming soon'''
			[[ru:Resource:Interiors]]

EAi at 00:53, 9 January 2008

2008-01-09T00:53:02Z

← Older revision		Revision as of 00:53, 9 January 2008
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	~~=Introduction=~~		{{Resource page}}
	The interiors resource provides a generic system for use of the single player's interiors system, which is included in the MTASA:DM DP2 server package onwards. This means placing warp points where when players hit the marker, they are set into the appropriate interior.		The interiors resource provides a generic system for use of the single player's interiors system, which is included in the MTASA:DM DP2 server package onwards. This means placing warp points where when players hit the marker, they are set into the appropriate interior.

Talidan at 21:42, 8 January 2008

2008-01-08T21:42:28Z

← Older revision		Revision as of 21:42, 8 January 2008
Line 51:		Line 51:
	====Returns====		====Returns====
	Returns a string of the interior name, or false if it could not be retrieved.		Returns a string of the interior name, or false if it could not be retrieved.
			----


	~~----~~
	===getInteriorMarker===		===getInteriorMarker===
	This function retrieves the [[marker]] element associated to the interior. This will allow you to modify the visibility of interior markers using the [[setElementVisibleTo]] function.		This function retrieves the [[marker]] element associated to the interior. This will allow you to modify the visibility of interior markers using the [[setElementVisibleTo]] function.
Line 82:		Line 82:
	====Cancel effect====		====Cancel effect====
	If this event is [[Event system#Canceling\|canceled]], the player will not be warped to his destination point.		If this event is [[Event system#Canceling\|canceled]], the player will not be warped to his destination point.
			----


	~~----~~
	===onInteriorWarped===		===onInteriorWarped===
	This event is triggered when an interior destination has successfully been warped to.		This event is triggered when an interior destination has successfully been warped to.
Line 97:		Line 97:
	====Source====		====Source====
	The [[event system#Event source\|source]] of this event is the interior element which was warped '''to'''.		The [[event system#Event source\|source]] of this event is the interior element which was warped '''to'''.
			----


	~~----~~
	===onPlayerInteriorHit===		===onPlayerInteriorHit===
	This event is triggered when a player hits an interior warp point, prior to him reaching his destination		This event is triggered when a player hits an interior warp point, prior to him reaching his destination
Line 114:		Line 114:
	====Cancel effect====		====Cancel effect====
	If this event is [[Event system#Canceling\|canceled]], the player will not be warped to his destination point.		If this event is [[Event system#Canceling\|canceled]], the player will not be warped to his destination point.
			----


	~~----~~
	===onPlayerInteriorWarped===		===onPlayerInteriorWarped===
	This event is triggered when a player successfully warps to his destination interior.		This event is triggered when a player successfully warps to his destination interior.

Talidan at 21:40, 8 January 2008

2008-01-08T21:40:09Z

← Older revision		Revision as of 21:40, 8 January 2008
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	=Introduction=		=Introduction=
	The interiors resource provides a generic system for use of the single player's interiors system, which is included in the MTASA:DM DP2 server package onwards.. This means placing warp points where when players hit the marker, they are set into the appropriate interior.		The interiors resource provides a generic system for use of the single player's interiors system, which is included in the MTASA:DM DP2 server package onwards. This means placing warp points where when players hit the marker, they are set into the appropriate interior.

	=Loading interiors from the resource=		=Loading interiors from the resource=

Talidan at 21:37, 8 January 2008

2008-01-08T21:37:08Z

← Older revision		Revision as of 21:37, 8 January 2008
Line 11:		Line 11:
	The interiors resource supports a flexible .map based element system to add your own interiors. The syntax follows an ''entry'' and ''return'' system. An ''interiorEntry'' element must have a unique id, and the ''interiorReturn'' element uses the "refid" attribute to link them together.		The interiors resource supports a flexible .map based element system to add your own interiors. The syntax follows an ''entry'' and ''return'' system. An ''interiorEntry'' element must have a unique id, and the ''interiorReturn'' element uses the "refid" attribute to link them together.
	<syntaxhighlight lang="xml">		<syntaxhighlight lang="xml">
	<interiorEntry id="" posX="" posY="" posZ="" rotation="" dimension="" interior="" />		<interiorEntry id="" posX="" posY="" posZ="" rotation="" dimension="" interior="" oneway="" />
	<interiorReturn refid="" posX="" posY="" posZ="" rotation="" dimension="" interior="" />		<interiorReturn refid="" posX="" posY="" posZ="" rotation="" dimension="" interior="" />
	</syntaxhighlight>		</syntaxhighlight>
Line 21:		Line 21:
	* '''dimension''': An integer representing the dimension of the player when he '''reaches''' the interior warp in the specified element. In other words, which dimension the warp point exists.		* '''dimension''': An integer representing the dimension of the player when he '''reaches''' the interior warp in the specified element. In other words, which dimension the warp point exists.
	* '''interior''': An integer representing the interior world of the player when he '''reaches''' the interior warp in the specified element. In other words, which interior the warp point exists.		* '''interior''': An integer representing the interior world of the player when he '''reaches''' the interior warp in the specified element. In other words, which interior the warp point exists.

			==Optional Arguments==
			* '''oneway''': If set to ''true'', a interiorReturn marker will not be created, and the warp point will be one-way - from the interiorEntry to the interiorReturn with no way back.

	==Example==		==Example==

Talidan at 21:33, 8 January 2008

2008-01-08T21:33:17Z

← Older revision		Revision as of 21:33, 8 January 2008
Line 11:		Line 11:
	The interiors resource supports a flexible .map based element system to add your own interiors. The syntax follows an ''entry'' and ''return'' system. An ''interiorEntry'' element must have a unique id, and the ''interiorReturn'' element uses the "refid" attribute to link them together.		The interiors resource supports a flexible .map based element system to add your own interiors. The syntax follows an ''entry'' and ''return'' system. An ''interiorEntry'' element must have a unique id, and the ''interiorReturn'' element uses the "refid" attribute to link them together.
	<syntaxhighlight lang="xml">		<syntaxhighlight lang="xml">
	<interiorEntry id="" posX="" posY="" posZ="" rotation="" dimension="" interior="" />		<interiorEntry id="" posX="" posY="" posZ="" rotation="" dimension="" interior="" />
	<interiorReturn refid="" posX="" posY="" posZ="" rotation="" dimension="" interior="" />		<interiorReturn refid="" posX="" posY="" posZ="" rotation="" dimension="" interior="" />
	</syntaxhighlight>		</syntaxhighlight>
	==Required Arguments==		==Required Arguments==

Talidan at 21:32, 8 January 2008

2008-01-08T21:32:25Z

← Older revision		Revision as of 21:32, 8 January 2008
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	=Introduction=		=Introduction=
	The interiors resource provides a generic system for use of the single player's interiors system. This means placing warp points where when players hit the marker, they are set into the appropriate interior.		The interiors resource provides a generic system for use of the single player's interiors system, which is included in the MTASA:DM DP2 server package onwards.. This means placing warp points where when players hit the marker, they are set into the appropriate interior.

	=Loading interiors from the resource=		=Loading interiors from the resource=

Talidan at 21:31, 8 January 2008

2008-01-08T21:31:18Z

← Older revision		Revision as of 21:31, 8 January 2008
Line 1:		Line 1:
			__NOTOC__
	=Introduction=		=Introduction=
	The interiors resource provides a generic system for use of the single player's interiors system. This means placing warp points where when players hit the marker, they are set into the appropriate interior.		The interiors resource provides a generic system for use of the single player's interiors system. This means placing warp points where when players hit the marker, they are set into the appropriate interior.
Line 34:		Line 35:
	==Exported functions==		==Exported functions==
	Please remember that [[call]] must be used to call functions of another resource.		Please remember that [[call]] must be used to call functions of another resource.
			----
	===getInteriorName===		===getInteriorName===
	This function retrieves the overall name of an interior. This means it is the id or the overall refid.		This function retrieves the overall name of an interior. This means it is the id or the overall refid.
Line 47:		Line 49:
	Returns a string of the interior name, or false if it could not be retrieved.		Returns a string of the interior name, or false if it could not be retrieved.


			----
	===getInteriorMarker===		===getInteriorMarker===
	This function retrieves the [[marker]] element associated to the interior. This will allow you to modify the visibility of interior markers using the [[setElementVisibleTo]] function.		This function retrieves the [[marker]] element associated to the interior. This will allow you to modify the visibility of interior markers using the [[setElementVisibleTo]] function.
Line 76:		Line 80:
	If this event is [[Event system#Canceling\|canceled]], the player will not be warped to his destination point.		If this event is [[Event system#Canceling\|canceled]], the player will not be warped to his destination point.


			----
	===onInteriorWarped===		===onInteriorWarped===
	This event is triggered when an interior destination has successfully been warped to.		This event is triggered when an interior destination has successfully been warped to.
Line 89:		Line 95:
	The [[event system#Event source\|source]] of this event is the interior element which was warped '''to'''.		The [[event system#Event source\|source]] of this event is the interior element which was warped '''to'''.


			----
	===onPlayerInteriorHit===		===onPlayerInteriorHit===
	This event is triggered when a player hits an interior warp point, prior to him reaching his destination		This event is triggered when a player hits an interior warp point, prior to him reaching his destination
Line 104:		Line 112:
	If this event is [[Event system#Canceling\|canceled]], the player will not be warped to his destination point.		If this event is [[Event system#Canceling\|canceled]], the player will not be warped to his destination point.


			----
	===onPlayerInteriorWarped===		===onPlayerInteriorWarped===
	This event is triggered when a player successfully warps to his destination interior.		This event is triggered when a player successfully warps to his destination interior.
Line 117:		Line 127:
	The [[event system#Event source\|source]] of this event is the player who was warped to his destination point.		The [[event system#Event source\|source]] of this event is the player who was warped to his destination point.


			----
	===Examples===		===Examples===
	'''Coming soon'''		'''Coming soon'''

Talidan at 21:28, 8 January 2008

2008-01-08T21:28:50Z

@@ Line 1: / Line 1: @@
-==Introduction==
+=Introduction=
 The interiors resource provides a generic system for use of the single player's interiors system.  This means placing warp points where when players hit the marker, they are set into the appropriate interior.
-==Loading interiors from the resource==
+=Loading interiors from the resource=
 By default, the interiors resource offers over 200 of single player's own interior locations.  Coupled with [[dimension|dimensions]], each and every warp point offers a unique location - with a total of over 450 locations.
 Loading these interiors is easy.  Starting the ''interiors'' resource will auto load all these preset warp points and will be ready to use out of the box.
-==Adding your own interiors==
+=Adding your own interiors=
 The interiors resource supports a flexible .map based element system to add your own interiors. The syntax follows an ''entry'' and ''return'' system.  An ''interiorEntry'' element must have a unique id, and the ''interiorReturn'' element uses the "refid" attribute to link them together.
 <syntaxhighlight lang="xml">
@@ Line 13: / Line 13: @@
 <interiorReturn	refid=""	posX=""	posY=""	posZ=""	rotation=""	dimension=""	interior=""	/>
 </syntaxhighlight>
-''All attributes are required else the interior will not function properly.''
+==Required Arguments==
 * '''posX''': A float representing the X position of the interior warp.
 * '''posY''': A float representing the Y position of the interior warp.
@@ Line 21: / Line 21: @@
 * '''interior''': An integer representing the interior world of the player when he '''reaches''' the interior warp in the specified element.  In other words, which interior the warp point exists.
-===Example===
+==Example==
 <syntaxhighlight lang="xml">
 <interiorEntry	id="AMMUN1"	posX="1368.35"	posY="-1279.06"	posZ="12.55"	rotation="-0.100006"	dimension="0"	interior="0"	/>
@@ Line 27: / Line 27: @@
 </syntaxhighlight>
 The interiorEntry element here is located at 1368.35,-1279.06,12.55.  When the player reaches this location, he will be warped to the attributes specified in the linked interiorReturn element - 286.15,-41.54,1000.57 with a rotation of 90 degrees, into the new interior world 1.  When the player hits this marker again, the transverse will happen.