Actions

Difference between revisions of "Predefined variables"

From Iron Realms Nexus Client Documentation

(Created page with "Predefined variables are set by the game as text is sent to the clients. {| |Variable | |- |@tar |Your current enemy target. |- |@match |The text matched in a trigger. |}")
 
 
(16 intermediate revisions by 4 users not shown)
Line 1: Line 1:
 
Predefined variables are set by the game as text is sent to the clients.
 
Predefined variables are set by the game as text is sent to the clients.
  
{|
+
{| class="wikitable"
|Variable
+
! style="text-align:left;" | Variable Name
|  
+
! style="text-align:left;" | Description
 
|-
 
|-
|@tar
+
! scope="row"|@tar
 
|Your current enemy target.  
 
|Your current enemy target.  
 
|-
 
|-
|@match
+
! scope="row"|@match
 
|The text matched in a trigger.
 
|The text matched in a trigger.
 +
|-
 +
! scope="row"|@line
 +
|The complete line of text that executed the trigger.
 +
|-
 +
! scope="row"|@suffix
 +
|The suffix is set to all of the text received in a line after the matching text.
 +
|-
 +
! scope="row"|@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:
 +
 +
{| class="wikitable"
 +
|-
 +
! scope="col"| Variable
 +
! scope="col"| Description
 +
! scope="col"| Game
 +
|-
 +
! scope="row"| @my_hp
 +
| Your current health
 +
| All
 +
|-
 +
! scope="row"| @my_maxhp
 +
| Your maximum health points
 +
| All
 +
|-
 +
! scope="row"| @my_mp
 +
| Your current mana points
 +
| All
 +
|-
 +
! scope="row"| @my_maxmp
 +
| Your maximum mana points
 +
| All
 +
|-
 +
! scope="row"| @my_nl
 +
| Your experience percentage to next level
 +
| All
 +
|-
 +
! scope="row"| @my_bal
 +
| If you currently have balance
 +
| Achaea, Aetolia, Imperian
 +
|-
 +
! scope="row"| @my_eq
 +
| If you currently have equilibrium
 +
| Achaea, Aetolia, Imperian
 +
|-
 +
! scope="row"| @my_balance
 +
| If you currently have balance
 +
| Lusternia
 +
|-
 +
! scope="row"| @my_equilibrium
 +
| If you currently have equilibrium
 +
| Lusternia
 +
|-
 +
! 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
 +
| If you have not voted for your game recently
 +
| All
 +
|-
 +
! scope="row"| @my_string
 +
| Your current prompt string
 +
| All
 +
|-
 +
! scope="row"| @my_wp
 +
| Your current willpower points
 +
| Achaea, Aetolia
 +
|-
 +
! scope="row"| @my_maxwp
 +
| Your maximum willpower points
 +
| Achaea, Aetolia
 +
|-
 +
! scope="row"| @my_awp
 +
| Your current aetherwill points
 +
| Lusternia
 +
|-
 +
! scope="row"| @my_maxawp
 +
| Your maximum aetherwill points
 +
| Lusternia
 +
|-
 +
! scope="row"| @my_ep
 +
| Your current endurance points
 +
| Achaea, Aetolia
 +
|-
 +
! scope="row"| @my_maxep
 +
| Your maximum endurance points
 +
| Achaea, Aetolia
 +
|-
 +
! scope="row"| @my_ego
 +
| Your current ego points
 +
| Lusternia
 +
|-
 +
! scope="row"| @my_maxego
 +
| Your maximum ego points
 +
| Lusternia
 +
|-
 +
! scope="row"| @my_pow
 +
| Your current power
 +
| Lusternia
 +
|-
 +
! scope="row"| @my_maxpow
 +
| Your maximum power
 +
| Lusternia
 +
|-
 +
! scope="row"| @my_reserves
 +
| Your current power reserves
 +
| Lusternia
 +
|-
 +
! scope="row"| @my_ep
 +
| Your current endurance points
 +
| Achaea, Aetolia
 +
|-
 +
! scope="row"| @my_maxep
 +
| Your maximum endurance points
 +
| Achaea, Aetolia
 +
|-
 +
! scope="row"| @my_xp
 +
| The numerical amount of experience you have for your current level.
 +
| Aetolia
 +
|-
 +
! scope="row"| @my_maxxp
 +
| The numerical amount of experience needed to advance from your current level.
 +
| Aetolia
 +
|-
 +
! scope="row"| @my_blood
 +
| Your blood reserves percentage
 +
| Aetolia
 +
|-
 +
! scope="row"| @my_bleeding
 +
| The current amount of health you're bleeding for.
 +
| Aetolia, Lusternia
 +
|-
 +
! scope="row"| @my_bleed
 +
| The current amount of health you're bleeding for.
 +
| Imperian
 +
|-
 +
! scope="row"| @my_bruising
 +
| The current amount of health you're bruised for.
 +
| Lusternia
 +
|-
 +
! scope="row"| @my_hemorrhaging
 +
| The current amount of health you're hemorrhaging for.
 +
| Lusternia
 +
|-
 +
! scope="row"| @my_blind
 +
| If you are blind.
 +
| Aetolia, Imperian, Lusternia
 +
|-
 +
! scope="row"| @my_deaf
 +
| If you are deaf.
 +
| Aetolia, Imperian, Lusternia
 +
|-
 +
! scope="row"| @my_prone
 +
| If you are prone.
 +
| Aetolia, Imperian, Lusternia
 +
|-
 +
! scope="row"| @my_stunned
 +
| If you are stunned.
 +
| Imperian
 +
|-
 +
! scope="row"| @my_cloak
 +
| If you have the Cloak (tattoo) defence.
 +
| Aetolia
 +
|-
 +
! scope="row"| @my_fangbarrier
 +
| If you have the fangbarrier defence.
 +
| Aetolia
 +
|-
 +
! scope="row"| @my_phased
 +
| If you are phased.
 +
| Aetolia, Imperian
 +
|-
 +
! scope="row"| @my_elevation
 +
| What room elevation you're currently at.
 +
| Aetolia
 +
|-
 +
! scope="row"| @my_flying
 +
| Whether you are currently flying (per the elevation).
 +
| Imperian
 +
|-
 +
! scope="row"| @my_herb
 +
| If you have herb/slice balance.
 +
| Aetolia, Imperian
 +
|-
 +
! scope="row"| @my_salve
 +
| If you have salve/poultice balance.
 +
| Aetolia, Imperian
 +
|-
 +
! scope="row"| @my_pipe
 +
| If you have pipe/tincture balance.
 +
| Aetolia, Imperian
 +
|-
 +
! scope="row"| @my_elixir
 +
| If you have elixir/serum balance.
 +
| 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
 +
| If you have moss/kidney balance.
 +
| Aetolia
 +
|-
 +
! scope="row"| @my_tree
 +
| If your tree tattoo is off cooldown.
 +
| Aetolia, Imperian
 +
|-
 +
! scope="row"| @my_renew
 +
| If your renew ability is off cooldown.
 +
| Aetolia
 +
|-
 +
! scope="row"| @my_affelixir
 +
| If your affliction elixir/serum balance is off cooldown.
 +
| Aetolia
 +
|-
 +
! scope="row"| @my_focus
 +
| If your focus ability is off cooldown.
 +
| Aetolia, Imperian
 +
|-
 +
! scope="row"| @my_ice
 +
| Curative balance for restorative ice
 +
| Lusternia
 +
|-
 +
! scope="row"| @my_slush
 +
| Curative balance for lucidity slush
 +
| Lusternia
 +
|-
 +
! scope="row"| @my_steam
 +
| Curative balance for soothing steam
 +
| Lusternia
 +
|-
 +
! scope="row"| @my_dust
 +
| Curative balance for purity dust
 +
| Lusternia
 +
|-
 +
! scope="row"| @my_healing
 +
| Curative balance for healing elixir
 +
| Lusternia
 +
|-
 +
! scope="row"| @my_sparkleberry
 +
| Curative balance for sparkleberry
 +
| Lusternia
 +
|-
 +
! scope="row"| @my_scroll
 +
| Curative balance for healing scroll
 +
| Lusternia
 +
|-
 +
! scope="row"| @my_purge
 +
| If your purge blood ability is off cooldown.
 +
| Imperian
 +
|-
 +
! scope="row"| @my_writhing
 +
| If you are currently writhing.
 +
| Aetolia
 +
|-
 +
! scope="row"| @my_soul
 +
| Your soul percentage (drained by Carnifex).
 +
| Aetolia
 +
|-
 +
! scope="row"| @my_madness
 +
| Your Shapeshifter madness percentage.
 +
| Aetolia
 +
|-
 +
! scope="row"| @my_left_arm
 +
| If you have left arm balance.
 +
| Aetolia, Lusternia
 +
|-
 +
! scope="row"| @my_right_arm
 +
| If you have right arm balance.
 +
| Aetolia, Lusternia
 +
|-
 +
! scope="row"| @my_left_leg
 +
| If you have left leg balance.
 +
| Lusternia
 +
|-
 +
! scope="row"| @my_right_leg
 +
| If you have right leg balance.
 +
| Lusternia
 +
|-
 +
! 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_head
 +
| If you have head balance.
 +
| Lusternia
 +
|-
 +
! scope="row"| @my_psisub
 +
| If you have psionic sub balance. (-1 if channel is locked.)
 +
| Lusternia
 +
|-
 +
! scope="row"| @my_psisuper
 +
| If you have psionic super balance. (-1 if channel is locked.)
 +
| Lusternia
 +
|-
 +
! scope="row"| @my_psiid
 +
| If you have psionic id balance. (-1 if channel is locked.)
 +
| Lusternia
 +
|-
 +
! scope="row"| @my_modulebal
 +
| If you have aethership module balance. (-1 if not locked into a module.)
 +
| Lusternia
 +
|-
 +
! scope="row"| @my_eflowbal
 +
| If you have enigmatic flow balance.
 +
| Lusternia
 +
|-
 +
! 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
 +
| What item are you wielding in your left hand.
 +
| Aetolia
 +
|-
 +
! scope="row"| @my_wield_right
 +
| What item are you wielding in your right hand.
 +
| Aetolia
 +
|-
 +
! scope="row"| @my_essence
 +
| Your remaining life essence percent (Necromancy).
 +
| Aetolia, Imperian
 +
|-
 +
! scope="row"| @my_devotion
 +
| Your remaining devotion percent (Devotion).
 +
| 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
 +
| Your remaining spark percent (Illumination).
 +
| Aetolia
 +
|-
 +
! scope="row"| @my_empathy
 +
| Your current empathy.
 +
| Lusternia
 +
|-
 +
! scope="row"| @my_enigmaticflow
 +
| Your current enigmatic flow.
 +
| Lusternia
 +
|-
 +
! scope="row"| @my_stance
 +
| What stance you are currently in (Tekura for Aetolia, Kata for Lusternia).
 +
| Aetolia, Lusternia
 +
|-
 +
! scope="row"| @my_kai
 +
| What your kai level is at (Kaido).
 +
| Aetolia, Imperian
 +
|-
 +
! scope="row"| @my_momentum
 +
| Your current momentum level (Terramancy).
 +
| Aetolia
 +
|-
 +
! scope="row"| @my_charge_left
 +
| Current charge of your left-hand weapon (Bladefire).
 +
| Aetolia
 +
|-
 +
! scope="row"| @my_charge_right
 +
| Current charge of your right-hand weapon (Bladefire).
 +
| Aetolia
 +
|-
 +
! scope="row"| @my_mounted
 +
| What steed you are currently mounted upon.
 +
| Aetolia
 +
|-
 +
! scope="row"| @my_mount
 +
| What steed you are currently mounted upon.
 +
| Imperian, Lusternia
 +
|-
 +
! 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
 +
|-
 +
! scope="row"| @my_headwounds
 +
| Your current head wounds.
 +
| Lusternia
 +
|-
 +
! scope="row"| @my_chestwounds
 +
| Your current chest wounds.
 +
| Lusternia
 +
|-
 +
! scope="row"| @my_gutwounds
 +
| Your current gut wounds.
 +
| Lusternia
 +
|-
 +
! scope="row"| @my_leftarmwounds
 +
| Your current left arm wounds.
 +
| Lusternia
 +
|-
 +
! scope="row"| @my_rightarmwounds
 +
| Your current right arm wounds.
 +
| Lusternia
 +
|-
 +
! scope="row"| @my_leftlegwounds
 +
| Your current left leg wounds.
 +
| Lusternia
 +
|-
 +
! scope="row"| @my_rightlegwounds
 +
| Your current right leg wounds.
 +
| Lusternia
 
|}
 
|}
 +
 +
=== Example ===
 +
 +
This is the output from the game, showing some predefined variables. It uses the trigger below.
 +
 +
[[File:PredefinedOutput.png]]
 +
 +
 +
This is the sample trigger used display the predefined variables above.
 +
 +
[[File:PredefinedTrigger.png]]

Latest revision as of 01:27, 19 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 Achaea, Aetolia, Imperian
@my_eq If you currently have equilibrium Achaea, Aetolia, Imperian
@my_balance If you currently have balance Lusternia
@my_equilibrium If you currently have equilibrium Lusternia
@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_awp Your current aetherwill points Lusternia
@my_maxawp Your maximum aetherwill points Lusternia
@my_ep Your current endurance points Achaea, Aetolia
@my_maxep Your maximum endurance points Achaea, Aetolia
@my_ego Your current ego points Lusternia
@my_maxego Your maximum ego points Lusternia
@my_pow Your current power Lusternia
@my_maxpow Your maximum power Lusternia
@my_reserves Your current power reserves Lusternia
@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, Lusternia
@my_bleed The current amount of health you're bleeding for. Imperian
@my_bruising The current amount of health you're bruised for. Lusternia
@my_hemorrhaging The current amount of health you're hemorrhaging for. Lusternia
@my_blind If you are blind. Aetolia, Imperian, Lusternia
@my_deaf If you are deaf. Aetolia, Imperian, Lusternia
@my_prone If you are prone. Aetolia, Imperian, Lusternia
@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_ice Curative balance for restorative ice Lusternia
@my_slush Curative balance for lucidity slush Lusternia
@my_steam Curative balance for soothing steam Lusternia
@my_dust Curative balance for purity dust Lusternia
@my_healing Curative balance for healing elixir Lusternia
@my_sparkleberry Curative balance for sparkleberry Lusternia
@my_scroll Curative balance for healing scroll Lusternia
@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, Lusternia
@my_right_arm If you have right arm balance. Aetolia, Lusternia
@my_left_leg If you have left leg balance. Lusternia
@my_right_leg If you have right leg balance. Lusternia
@my_leftarm If you currently have left arm balance. Imperian
@my_rightarm If you currently have right arm balance. Imperian
@my_head If you have head balance. Lusternia
@my_psisub If you have psionic sub balance. (-1 if channel is locked.) Lusternia
@my_psisuper If you have psionic super balance. (-1 if channel is locked.) Lusternia
@my_psiid If you have psionic id balance. (-1 if channel is locked.) Lusternia
@my_modulebal If you have aethership module balance. (-1 if not locked into a module.) Lusternia
@my_eflowbal If you have enigmatic flow balance. Lusternia
@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_empathy Your current empathy. Lusternia
@my_enigmaticflow Your current enigmatic flow. Lusternia
@my_stance What stance you are currently in (Tekura for Aetolia, Kata for Lusternia). Aetolia, Lusternia
@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, Lusternia
@my_faith Your current Cult/Sect faith amount Imperian
@my_res_weakness The remaining duration of your PVP resurrection weakness. Imperian
@my_headwounds Your current head wounds. Lusternia
@my_chestwounds Your current chest wounds. Lusternia
@my_gutwounds Your current gut wounds. Lusternia
@my_leftarmwounds Your current left arm wounds. Lusternia
@my_rightarmwounds Your current right arm wounds. Lusternia
@my_leftlegwounds Your current left leg wounds. Lusternia
@my_rightlegwounds Your current right leg wounds. Lusternia

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