Actions

Difference between revisions of "Predefined variables"

From Iron Realms Nexus Client Documentation

(Added Imperian gmcp.Char.Vitals values)
Line 56: Line 56:
 
| If you currently have equilibrium
 
| If you currently have equilibrium
 
| All
 
| All
 +
|-
 +
! scope="row"| @my_health_reserve
 +
| Your currently available health reserves.
 +
| Imperian
 +
|-
 +
! scope="row"| @my_mana_reserve
 +
| Your currently available mana reserves.
 +
| Imperian
 
|-
 
|-
 
! scope="row"| @my_vote
 
! scope="row"| @my_vote
Line 96: Line 104:
 
| The current amount of health you're bleeding for.
 
| The current amount of health you're bleeding for.
 
| Aetolia
 
| Aetolia
 +
|-
 +
! scope="row"| @my_bleed
 +
| The current amount of health you're bleeding for.
 +
| Imperian
 
|-
 
|-
 
! scope="row"| @my_blind
 
! scope="row"| @my_blind
 
| If you are blind.
 
| If you are blind.
| Aetolia
+
| Aetolia, Imperian
 
|-
 
|-
 
! scope="row"| @my_deaf
 
! scope="row"| @my_deaf
 
| If you are deaf.
 
| If you are deaf.
| Aetolia
+
| Aetolia, Imperian
 
|-
 
|-
 
! scope="row"| @my_prone
 
! scope="row"| @my_prone
 
| If you are prone.
 
| If you are prone.
| Aetolia
+
| Aetolia, Imperian
 +
|-
 +
! scope="row"| @my_stunned
 +
| If you are stunned.
 +
| Imperian
 
|-
 
|-
 
! scope="row"| @my_cloak
 
! scope="row"| @my_cloak
Line 119: Line 135:
 
! scope="row"| @my_phased
 
! scope="row"| @my_phased
 
| If you are phased.
 
| If you are phased.
| Aetolia
+
| Aetolia, Imperian
 
|-
 
|-
 
! scope="row"| @my_elevation
 
! scope="row"| @my_elevation
 
| What room elevation you're currently at.
 
| What room elevation you're currently at.
 
| Aetolia
 
| Aetolia
 +
|-
 +
! scope="row"| @my_flying
 +
| Whether you are currently flying (per the elevation).
 +
| Imperian
 
|-
 
|-
 
! scope="row"| @my_herb
 
! scope="row"| @my_herb
 
| If you have herb/slice balance.
 
| If you have herb/slice balance.
| Aetolia
+
| Aetolia, Imperian
 
|-
 
|-
 
! scope="row"| @my_salve
 
! scope="row"| @my_salve
 
| If you have salve/poultice balance.
 
| If you have salve/poultice balance.
| Aetolia
+
| Aetolia, Imperian
 
|-
 
|-
 
! scope="row"| @my_pipe
 
! scope="row"| @my_pipe
 
| If you have pipe/tincture balance.
 
| If you have pipe/tincture balance.
| Aetolia
+
| Aetolia, Imperian
 
|-
 
|-
 
! scope="row"| @my_elixir
 
! scope="row"| @my_elixir
 
| If you have elixir/serum balance.
 
| If you have elixir/serum balance.
 
| Aetolia
 
| Aetolia
 +
|-
 +
! scope="row"| @my_health
 +
| If you have elixir balance.
 +
| Imperian
 +
|-
 +
! scope="row"| @my_toadstool
 +
| If you have toadstool balance.
 +
| Imperian
 
|-
 
|-
 
! scope="row"| @my_moss
 
! scope="row"| @my_moss
Line 147: Line 175:
 
! scope="row"| @my_tree
 
! scope="row"| @my_tree
 
| If your tree tattoo is off cooldown.
 
| If your tree tattoo is off cooldown.
| Aetolia
+
| Aetolia, Imperian
 
|-
 
|-
 
! scope="row"| @my_renew
 
! scope="row"| @my_renew
Line 159: Line 187:
 
! scope="row"| @my_focus
 
! scope="row"| @my_focus
 
| If your focus ability is off cooldown.
 
| If your focus ability is off cooldown.
| Aetolia
+
| Aetolia, Imperian
 +
|-
 +
! scope="row"| @my_purge
 +
| If your purge blood ability is off cooldown.
 +
| Imperian
 
|-
 
|-
 
! scope="row"| @my_writhing
 
! scope="row"| @my_writhing
Line 180: Line 212:
 
| If you have right arm balance.
 
| If you have right arm balance.
 
| Aetolia
 
| Aetolia
 +
|-
 +
! scope="row"| @my_leftarm
 +
| If you currently have left arm balance.
 +
| Imperian
 +
|-
 +
! scope="row"| @my_rightarm
 +
| If you currently have right arm balance.
 +
| Imperian
 +
|-
 +
! scope="row"| @my_leftwield
 +
| Item number of the item you are wielding in your left hand.
 +
| Imperian
 +
|-
 +
! scope="row"| @my_leftwield_name
 +
| The short name of the item you are wielding in your left hand (e.g. "broadsword")
 +
| Imperian
 +
|-
 +
! scope="row"| @my_rightwield
 +
| Item number of the item you are wielding in your right hand.
 +
| Imperian
 +
|-
 +
! scope="row"| @my_rightwield_name
 +
| The short name of the item you are wielding in your right hand (e.g. "broadsword")
 +
| Imperian
 
|-
 
|-
 
! scope="row"| @my_wield_left
 
! scope="row"| @my_wield_left
Line 191: Line 247:
 
! scope="row"| @my_essence
 
! scope="row"| @my_essence
 
| Your remaining life essence percent (Necromancy).
 
| Your remaining life essence percent (Necromancy).
| Aetolia
+
| Aetolia, Imperian
 
|-
 
|-
 
! scope="row"| @my_devotion
 
! scope="row"| @my_devotion
 
| Your remaining devotion percent (Devotion).
 
| Your remaining devotion percent (Devotion).
| Aetolia
+
| Aetolia, Imperian
 +
|-
 +
! scope="row"| @my_fanatism
 +
| Your current fanatism level (Kanai).
 +
| Imperian
 +
|-
 +
! scope="row"| @my_rage
 +
| Your current rage level (Warchants).
 +
| Imperian
 +
|-
 +
! scope="row"| @my_fire
 +
| Your current fire level (Shapeshifting).
 +
| Imperian
 +
|-
 +
! scope="row"| @my_ice
 +
| Your current rage level (Shapeshifting).
 +
| Imperian
 +
|-
 +
! scope="row"| @my_gunfocus
 +
| Your current focus level (Focus). Only sent if you have a focus target.
 +
| Imperian
 +
|-
 +
! scope="row"| @my_focustarget
 +
| Your current focus target (Focus). Only sent if you have a focus target.
 +
| Imperian
 
|-
 
|-
 
! scope="row"| @my_spark
 
! scope="row"| @my_spark
Line 207: Line 287:
 
! scope="row"| @my_kai
 
! scope="row"| @my_kai
 
| What your kai level is at (Kaido).
 
| What your kai level is at (Kaido).
| Aetolia
+
| Aetolia, Imperian
 
|-
 
|-
 
! scope="row"| @my_momentum
 
! scope="row"| @my_momentum
Line 224: Line 304:
 
| What steed you are currently mounted upon.
 
| What steed you are currently mounted upon.
 
| Aetolia
 
| Aetolia
 +
|-
 +
! scope="row"| @my_mount
 +
| What steed you are currently mounted upon.
 +
| Imperian
 +
|-
 +
! scope="row"| @my_faith
 +
| Your current Cult/Sect faith amount
 +
| Imperian
 +
|-
 +
! scope="row"| @my_res_weakness
 +
| The remaining duration of your PVP resurrection weakness.
 +
| Imperian
 
|}
 
|}
  

Revision as of 23:11, 18 March 2018

Predefined variables are set by the game as text is sent to the clients.

Variable Name Description
@tar Your current enemy target.
@match The text matched in a trigger.
@line The complete line of text that executed the trigger.
@suffix The suffix is set to all of the text received in a line after the matching text.
@prefix The prefix is set to all of the text received in a line before the matching text.

Additionally, Nexus will attempt to automatically fill the in these variables for you:

Variable Description Game
@my_hp Your current health All
@my_maxhp Your maximum health points All
@my_mp Your current mana points All
@my_maxmp Your maximum mana points All
@my_nl Your experience percentage to next level All
@my_bal If you currently have balance All
@my_eq If you currently have equilibrium All
@my_health_reserve Your currently available health reserves. Imperian
@my_mana_reserve Your currently available mana reserves. Imperian
@my_vote If you have not voted for your game recently All
@my_string Your current prompt string All
@my_wp Your current willpower points Achaea, Aetolia
@my_maxwp Your maximum willpower points Achaea, Aetolia
@my_ep Your current endurance points Achaea, Aetolia
@my_maxep Your maximum endurance points Achaea, Aetolia
@my_xp The numerical amount of experience you have for your current level. Aetolia
@my_maxxp The numerical amount of experience needed to advance from your current level. Aetolia
@my_blood Your blood reserves percentage Aetolia
@my_bleeding The current amount of health you're bleeding for. Aetolia
@my_bleed The current amount of health you're bleeding for. Imperian
@my_blind If you are blind. Aetolia, Imperian
@my_deaf If you are deaf. Aetolia, Imperian
@my_prone If you are prone. Aetolia, Imperian
@my_stunned If you are stunned. Imperian
@my_cloak If you have the Cloak (tattoo) defence. Aetolia
@my_fangbarrier If you have the fangbarrier defence. Aetolia
@my_phased If you are phased. Aetolia, Imperian
@my_elevation What room elevation you're currently at. Aetolia
@my_flying Whether you are currently flying (per the elevation). Imperian
@my_herb If you have herb/slice balance. Aetolia, Imperian
@my_salve If you have salve/poultice balance. Aetolia, Imperian
@my_pipe If you have pipe/tincture balance. Aetolia, Imperian
@my_elixir If you have elixir/serum balance. Aetolia
@my_health If you have elixir balance. Imperian
@my_toadstool If you have toadstool balance. Imperian
@my_moss If you have moss/kidney balance. Aetolia
@my_tree If your tree tattoo is off cooldown. Aetolia, Imperian
@my_renew If your renew ability is off cooldown. Aetolia
@my_affelixir If your affliction elixir/serum balance is off cooldown. Aetolia
@my_focus If your focus ability is off cooldown. Aetolia, Imperian
@my_purge If your purge blood ability is off cooldown. Imperian
@my_writhing If you are currently writhing. Aetolia
@my_soul Your soul percentage (drained by Carnifex). Aetolia
@my_madness Your Shapeshifter madness percentage. Aetolia
@my_left_arm If you have left arm balance. Aetolia
@my_right_arm If you have right arm balance. Aetolia
@my_leftarm If you currently have left arm balance. Imperian
@my_rightarm If you currently have right arm balance. Imperian
@my_leftwield Item number of the item you are wielding in your left hand. Imperian
@my_leftwield_name The short name of the item you are wielding in your left hand (e.g. "broadsword") Imperian
@my_rightwield Item number of the item you are wielding in your right hand. Imperian
@my_rightwield_name The short name of the item you are wielding in your right hand (e.g. "broadsword") Imperian
@my_wield_left What item are you wielding in your left hand. Aetolia
@my_wield_right What item are you wielding in your right hand. Aetolia
@my_essence Your remaining life essence percent (Necromancy). Aetolia, Imperian
@my_devotion Your remaining devotion percent (Devotion). Aetolia, Imperian
@my_fanatism Your current fanatism level (Kanai). Imperian
@my_rage Your current rage level (Warchants). Imperian
@my_fire Your current fire level (Shapeshifting). Imperian
@my_ice Your current rage level (Shapeshifting). Imperian
@my_gunfocus Your current focus level (Focus). Only sent if you have a focus target. Imperian
@my_focustarget Your current focus target (Focus). Only sent if you have a focus target. Imperian
@my_spark Your remaining spark percent (Illumination). Aetolia
@my_stance What Tekura stance you are currently in. Aetolia
@my_kai What your kai level is at (Kaido). Aetolia, Imperian
@my_momentum Your current momentum level (Terramancy). Aetolia
@my_charge_left Current charge of your left-hand weapon (Bladefire). Aetolia
@my_charge_right Current charge of your right-hand weapon (Bladefire). Aetolia
@my_mounted What steed you are currently mounted upon. Aetolia
@my_mount What steed you are currently mounted upon. Imperian
@my_faith Your current Cult/Sect faith amount Imperian
@my_res_weakness The remaining duration of your PVP resurrection weakness. Imperian

Example

This is the output from the game, showing some predefined variables. It uses the trigger below.

PredefinedOutput.png


This is the sample trigger used display the predefined variables above.

PredefinedTrigger.png