Difference between revisions of "MQ2PCCheck" - MMOBugs Wiki

Sidebar Sidebar
Page Discussion
View source History
(→‎ExampleType: added about TLO change for group/guild.)
(→‎ExampleType: TLO member updates.)
 
(5 intermediate revisions by the same user not shown)
Line 4: Line 4:
 
| author = [[user:htw|htw]]
 
| author = [[user:htw|htw]]
 
| link = [http://www.mmobugs.com/wiki/index.php/MQ2PCCheck Wiki Link]
 
| link = [http://www.mmobugs.com/wiki/index.php/MQ2PCCheck Wiki Link]
−
| commands=/pcstatus /pccheck /pcquiet /pcnogroup /pcsound /pcbeep /pcpopup /pcchat /pcsave /pcrem /pchelp
+
| commands=/pccheck
 
| source = No
 
| source = No
 
| usesini = Yes
 
| usesini = Yes
Line 15: Line 15:
  
 
==Commands==
 
==Commands==
−
* <span class="highlight2">/pcstatus</span> Show current settings/status.
+
* <span class="highlight2">/pccheck  status | on | off | quiet [on|off] | sound [on|off] | beep [on|off] | popup [on|off] | chat [on|off] | rem | group [on|off] | guild [on|off] | load</span>
−
* <span class="highlight2">/pccheck  [on/off]</span> Toggle pc checking on/off, or force on/off with parameter..
+
* <span class="highlight2">status</span> Show current settings/status.
−
* <span class="highlight2">/pcquiet</span> Turn off pc alert & reminder sounds (resets at next zone).
+
* <span class="highlight2">off</span> Turn pc checking off.
−
* <span class="highlight2">/pcnogroup [on/off]</span> Toggle excluding group members from zone in/out and reminder alerts, or force on/off with parameter.
+
* <span class="highlight2">on</span> Turn pc checking on.
−
* <span class="highlight2">/pcnoguild [on/off]</span> Toggle excluding guild members from zone in/out and reminder alerts, or force on/off with parameter.
+
* <span class="highlight2">quiet [off|on]</span> Toggle (or turn on/off) quiet mode.
−
* <span class="highlight2">/pcsound [on/off]</span> Toggle PC alert sounds on/off, or force on/off with parameter.
+
* <span class="highlight2">group [on/off]</span> Toggle (or turn on/off) excluding group members from zone in/out and reminder alerts.
−
* <span class="highlight2">/pcbeep [on/off]</span> Toggle PC alert beeps on/off, or force on/off with parameter.
+
* <span class="highlight2">guild [on/off]</span> Toggle (or turn on/off) excluding guild members from zone in/out and reminder alerts.
−
* <span class="highlight2">/pcpopup [on/off]</span>  Toggle PC alert popup messages on/off, or force on/off with parameter.
+
* <span class="highlight2">sound [on/off]</span> Toggle (or turn on/off) PC alert sounds.
−
* <span class="highlight2">/pcchat [on/off]</span>  Toggle PC alert chat window messages on/off, or force on/off with parameter.
+
* <span class="highlight2">beep [on/off]</span> Toggle (or turn on/off) PC alert beeps.
−
* <span class="highlight2">/pcsave</span> Save current settings to MQ2PCCheck.ini.
+
* <span class="highlight2">popup [on/off]</span>  Toggle (or turn on/off) PC alert popup messages.
−
* <span class="highlight2">/pcrem</span> Change alert reminder interval, in seconds.  Minimum is 10 seconds.  Set to 0 to disable reminders.
+
* <span class="highlight2">chat [on/off]</span>  Toggle (or turn on/off) PC alert chat window messages.
−
* <span class="highlight2">/pchelp</span> Shows help information.
+
* <span class="highlight2">load</span> Load saved settings from  MQ2PCCheck.ini.
 +
* <span class="highlight2">rem #</span> Change alert reminder interval to # seconds.  Minimum is 10 seconds.  Set to 0 to disable reminders.
 +
* <span class="highlight2">help</span> Shows help information.
  
 
==Example Usage==
 
==Example Usage==
Line 33: Line 35:
  
  
−
This command will turn off alert sounds (Resets upon zoning).
+
This command will turn on quiet mode (turn off alert sounds - resets upon zoning).
−
* <span class="highlight2">/pcquiet</span>
+
* <span class="highlight2">/pccheck quiet on</span>
  
  
 
This command will turn on the use of sound files for alerts.
 
This command will turn on the use of sound files for alerts.
−
* <span class="highlight2">/pcsound on</span>
+
* <span class="highlight2">/pccheck sound on</span>
  
  
 
This command will turn on the use of beeps for alerts.
 
This command will turn on the use of beeps for alerts.
−
* <span class="highlight2">/pcbeep on</span>
+
* <span class="highlight2">/pccheck beep on</span>
  
  
−
This command will turn allow the use of popups for alerts.
+
This command will turn on the use of popups for alerts.
−
* <span class="highlight2">/pcpopup on</span>
+
* <span class="highlight2">/pccheck popup on</span>
  
−
This command will save the current configuration to MQ2PCCheck.ini file.
+
This command will set the alert reminder to 30 seconds.
−
* <span class="highlight2">/pcsave</span>
+
* <span class="highlight2">/pccheck rem 30</span>
  
 
==Macro Data==
 
==Macro Data==
Line 56: Line 58:
  
 
===ExampleType===
 
===ExampleType===
−
* <span class="highlight2">${PCCheck} : bool</span> - Return TRUE if PC is in zone.
+
* <span class="highlight2">NOTE: TLO member results take into account your group and guild settings, as well as excluding yourself.</span>
 +
* <span class="highlight2">${PCCheck} : string</span> - Return TRUE if plugin is loaded.
 +
* <span class="highlight2">${PCCheck.Alert} : bool</span> - Return TRUE if PC is in zone.
 +
* <span class="highlight2">${PCCheck.Alert[SpawnSearch]} : bool</span> - Return TRUE if PC is in zone, based on SpawnSearch.  Example:  ${PCCheck.Alert[radius 200]}.
 
* <span class="highlight2">${PCCheck.Status} : bool</span> - Return TRUE if PC checking is active.
 
* <span class="highlight2">${PCCheck.Status} : bool</span> - Return TRUE if PC checking is active.
 
* <span class="highlight2">${PCCheck.Count} : int</span> - Return number of PCs in zone.
 
* <span class="highlight2">${PCCheck.Count} : int</span> - Return number of PCs in zone.
−
* <span class="highlight2">${PCCheck.NG} : bool</span> - Return TRUE if any PC in zone that is not in your group or guild (based on whether those options are on or not.  If neither is on, this will be the same as ${PCCheck}).
+
* <span class="highlight2">${PCCheck.Count[SpawnSearch]} : int</span> - Return number of PCs in zone, based on SpawnSearch.  Example:  ${PCCheck.Count[radius 200]}.
−
* <span class="highlight2">${PCCheck.NGCount} : int</span> - Return number of PCs in zone who are NOT in your group or guild (based on whether those options are on or not.  If neither is on, this will be the same as ${PCCheck.Count})
 
  
 
==Sample Configuration==
 
==Sample Configuration==

Latest revision as of 00:50, 3 September 2015

Plugin Info
Name MQ2PCCheck
Author htw
Link Wiki Link
Commands /pccheck
Source Available No
Uses INI File Yes

Description

Alerts when PC in zone.

Features

  • This plugin has the ability to alert you in different ways such as sound and visual messages if a PC is detected.

Commands

  • /pccheck status | on | off | quiet [on|off] | sound [on|off] | beep [on|off] | popup [on|off] | chat [on|off] | rem | group [on|off] | guild [on|off] | load
  • status Show current settings/status.
  • off Turn pc checking off.
  • on Turn pc checking on.
  • quiet [off|on] Toggle (or turn on/off) quiet mode.
  • group [on/off] Toggle (or turn on/off) excluding group members from zone in/out and reminder alerts.
  • guild [on/off] Toggle (or turn on/off) excluding guild members from zone in/out and reminder alerts.
  • sound [on/off] Toggle (or turn on/off) PC alert sounds.
  • beep [on/off] Toggle (or turn on/off) PC alert beeps.
  • popup [on/off] Toggle (or turn on/off) PC alert popup messages.
  • chat [on/off] Toggle (or turn on/off) PC alert chat window messages.
  • load Load saved settings from MQ2PCCheck.ini.
  • rem # Change alert reminder interval to # seconds. Minimum is 10 seconds. Set to 0 to disable reminders.
  • help Shows help information.

Example Usage

This command will turn on PC checking.

  • /pccheck on


This command will turn on quiet mode (turn off alert sounds - resets upon zoning).

  • /pccheck quiet on


This command will turn on the use of sound files for alerts.

  • /pccheck sound on


This command will turn on the use of beeps for alerts.

  • /pccheck beep on


This command will turn on the use of popups for alerts.

  • /pccheck popup on

This command will set the alert reminder to 30 seconds.

  • /pccheck rem 30

Macro Data

This plugin adds a new TLO: PCCheck

ExampleType

  • NOTE: TLO member results take into account your group and guild settings, as well as excluding yourself.
  • ${PCCheck} : string - Return TRUE if plugin is loaded.
  • ${PCCheck.Alert} : bool - Return TRUE if PC is in zone.
  • ${PCCheck.Alert[SpawnSearch]} : bool - Return TRUE if PC is in zone, based on SpawnSearch. Example: ${PCCheck.Alert[radius 200]}.
  • ${PCCheck.Status} : bool - Return TRUE if PC checking is active.
  • ${PCCheck.Count} : int - Return number of PCs in zone.
  • ${PCCheck.Count[SpawnSearch]} : int - Return number of PCs in zone, based on SpawnSearch. Example: ${PCCheck.Count[radius 200]}.

Sample Configuration

MQ2PCCheck.ini 

[Settings]
RemInt=30
PCCheck=on
PCSound=on
PCBeep=off
PCPopup=on
PCChat=on
PCNoGroup=on
PCNoGuild=off

Availability

This plugin is included with the MMOBugs Compile.

Retrieved from "https://www.mmobugs.com/wiki/index.php?title=MQ2PCCheck&oldid=2199"