Difference between revisions of "LUA:Zone"

Revision as of 11:56, 8 February 2022

LUA:AllFunctions - Zone

Zone Spawn to another location the the game.

Syntax

Zone(param1, param2, param3, param4, param5, param6)

Required - param1 (Zone name), param2 (Spawn), param3 (float), param4 (float), param5 (float), param6 (float): param1 name of the zone you wish to sned spawn to; param2 is the spawn pointer of the spawn you wish to zone; param3 is X of location; param4 is Y of location; param5 is Z of location; param6 is Heading of location

function hailed(NPC, Player)
    Zone(GetZone(184), Player, 9.65, 17.21, -68.72, 184)
end

When the NPC is hailed it will zone the player to zone 184 at the list coordinates

@@ Line 1: / Line 1: @@
-== Usage ==
+{{LUAFunction
+|Name = Zone
-[http://www.eq2emulator.net/phpBB3/viewtopic.php?f=54&t=1416 Read a post regarding the Zone() function]
+|Description = Zone Spawn to another location the the game.
+|Param1 = Zone name
-Zone(Name, Object, [X], [Y], [Z], [Heading])
+|Param1Desc = name of the zone you wish to sned spawn to
+|Param2 = Spawn
-X, Y, Z and Heading are optional
+|Param2Desc = is the spawn pointer of the spawn you wish to zone
+|Param3 = float
-=== Examples ===
+|Param3Desc = is X of location
+|Param4 = float
-Zone(GetZone(184), spawn, 9.65, 17.21, -68.72, 184)
+|Param4Desc = is Y of location
+|Param5 = float
+|Param5Desc = is Z of location
+|Param6 = float
+|Param6Desc = is Heading of location
+|Example =
+<pre>
+function hailed(NPC, Player)
+    Zone(GetZone(184), Player, 9.65, 17.21, -68.72, 184)
+end
+</pre>
+|ExampleDesc = When the NPC is hailed it will zone the player to zone 184 at the list coordinates
+|Notes =
+}}