MQ2PiggyZone

Plugin Info
Name	MQ2PiggyZone
Author	Cosmic
Link	Wiki Link
Commands	/zone /gate /findpath /fade /succor
Source Available	No
Uses INI File	Yes

Description

Instant zone and gate.

Features

• Zone instantly.
• Force zone into adjacent zones that you're not flagged for.
• Chain zone (from zone to zone, until you reach the end zone).
• Instantly gate.
• Fade (zone to your current zone and position).

Commands

• /zone Shows all zone names.
• /zone <zone short name> [waypoint name] Instantly zones you to the zone name of your choice. 'waypoint name' is optional, for saved waypoints (the default is 'default').
• /gate Instantly zones you to your bind.
• /findpath <zone name> Lists the path the plugin would take to get to your destination zone.
• /fade Zones you to your current zone at the same location.
• /succor Zones you to your current zone at the succor point.
• /heading Shows your toon's exact heading.
• /zone pccheck [on|off] Turns PC checking on or off, prevents zone/gate/etc. if PC in zone.
• /zone pcrange ## Sets range for PC range checking, if pccheck is on. 0=disabled.
• /zone usegate [on|off] Turns chain zone through bind point on or off.
• /zone force <zone short name> [waypoint name] Force zone attempt (crashes if not adjacent zone!). 'waypoint name' is optional, for saved waypoints (the default is 'default').
• /zone gateok <zone short name> Allow path through bind point to be considered, even if UseGate is off.
• /zone nocheck <zone short name> If pccheck and/or pcrange is on, bypass PC checks.
• /zone nogroup [on|off] Turns ignoring group members in PC checks on or off.
• /zone groupok <zone short name> If group members are NOT ignored (not ok to zone near group members for pccheck), ignore them for this zone command.
• /zone <substring> Match partial, searches zone names for substring.
• /findpath <substring> Match partial, searches zone names for substring.
• /zone setwp <name> Sets a 'waypoint' in the current zone at your current location, so you can later zone in at the defined waypoint location.
• /zone clearwp <name> Clears a previously set waypoint for current zone.

• Options can be combined, e.g.: /zone force gateok nocheck <ZoneShortName>
  
• If pccheck option is off, pcrange is ignored. If pcrange is 0, and pccheck is on, ANY pc in zone will prevent zone/gate/etc. without using the nocheck option.
  
• You cannot /zone into instances! (which is also why you cannot bind in Guild Hall, and expect /gate to work).
  
• If a route is not shown, there is no route defined to that zone in MQ2PiggyZone.ini (there is probably a good reason for this).
  
• If MQ2PiggyZone_Server_Char.ini exists, it will be used for that char on that server, instead of MQ2PiggyZone.ini. (Example of char named Bubba on Saryrn server: MQ2PiggyZone_Saryrn_Bubba.ini)
• For waypoint files, it will first look for MQ2PiggyWP_server_char.ini, if not found, will look for MQ2PiggyWP.ini, and if that is not found, will use any waypoints in MQ2PiggyZone.ini (or MQ2PiggyZone_server_char.ini if using a custom one).
  

Example Usage

This command would zone you to Cobalt Scar, utilizing chain zoning if not adjacent.

• /zone cobaltscar

This command would attempt to place you in Cobalt Scar regardless of flags.

• /zone force cobaltscar

This command would put you at your bind point.

• /gate

This command would display the path it would take to zone you to Cobalt Scar.

• /findpath cobaltscar

This command would zone you to your current zone and same location.

• /fade

This command would zone you to your current zone and put you at the succor point.

• /succor

Macro Data

This plugin adds a new TLO called Piggy.

ExampleType

• ${Piggy.LastZone} : string - Return string with last zone shortname used with the /zone command (destination).
• ${Piggy.LastWP} : string - Return string with last waypoint used.
• ${Piggy.ZoneTime} : string - Return string with formatted time in zone, e.g. 1:04:03 (hours:mins:secs).
• ${Piggy.ZoneSecs} : int - Return time in zone, in seconds.
• ${Piggy.ZoneMins} : int - Return time in zone, in minutes.
• ${Piggy.ZoneHours} : int - Return time in zone, in hours.
• ${Piggy.NoGroup} : bool - Return TRUE if NoGroup is on.
• ${Piggy.PCCheck} : bool - Return TRUE if PCCheck is on.
• ${Piggy.PCRange} : int - Return value of the PCRange option.
• ${Piggy.UseGate} : bool - Return TRUE if UseGate is on.
• ${Piggy.LastPath} : string - Return string with the path shown by the last /findpath command.
• ${Piggy.PCCount} : int - Return number of PCs in range, determined by the PCRange option.

Availability

This plugin is included with the MMOBugs Compile.