Network variables are values that every server behind your proxy shares, such as a boss kill counter, an event flag or a player's quest progress. The proxy stores them, so by default they survive restarts.

Network variables require MythicMobs Premium! The profile scopes also need MythicRPG Premium.

Working With Network Variables

Network variables are separate from MythicMobs variables: setVariable and <global.var.NAME> never see them, and the mechanics, conditions and placeholders on this wiki never see MythicMobs variables. How the servers load and share network variables is explained in Reading and Writing.

Variable Types

The type attribute decides how a value is read and printed. Letter case does not matter.

• FLOAT and DOUBLE always print a decimal point (100.0). Very large and very small numbers print with an exponent, such as 1.0E7.
• If a value does not fit its type, for example 5.5 or 20.0 for an INTEGER, nothing is stored and the console logs a warning. value is not calculated, so a placeholder that prints a decimal needs FLOAT or DOUBLE.
• A LOCATION's world must exist on every server that uses the variable. If it is missing on the server that sets it, the skill stops with an error.
• Other MythicMobs types, such as METASKILL and ITEM, cannot be stored. A type that is not in the table makes the line invalid.
• Values have a size limit, see Limits.

Variable Scopes

The scope attribute decides who a variable belongs to. Letter case does not matter.

• A global, a player and a profile variable with the same name are three different variables. A player variable follows the player to every server, and a profile variable follows the profile.
• player and p mean the caster, not the target.
• caster and target need a player, profile and targetprofile a player with an active MythicRPG profile. Otherwise a mechanic does nothing and a condition is false, without a message.
• A mob is the caster of its own skills, so in mob skills use target or targetprofile and aim the mechanic at the player, see Targets.
• Any other scope makes the line invalid.

Variable Names

• Names are case-sensitive: Kills and kills are two variables. With MySQL storage the database may treat them as one, so pick one spelling.
• Use letters, numbers and underscores. A name with a dot or a pipe (|) can be set, but a placeholder cannot read it.
• Do not put the scope in the name: var=caster.kills is a global variable named caster.kills. Use scope=caster instead.
• With MySQL storage, a name can be at most 191 characters long.

Persistence and Expiry

The duration and save attributes of networkVariableSet and networkVariableAdd decide how long a variable lives.

• An expired variable counts as not set.
• Expiry depends on the clocks of your servers, see Conflicts and Clocks.
• networkVariableSet replaces the expiry every time, so a set without duration makes the variable permanent again.
• networkVariableAdd with a duration restarts the countdown. An add with neither duration nor save=false keeps the expiry the variable already has.
• A player or profile variable with save=false is gone as soon as the player leaves the server, also when they move to another server.
• Player and profile variables stay on the proxy after the player leaves the network. Give them a duration if they should not stay forever.
• Use save=false for values that should not come back after a restart, such as a boss's live health.

MythicRPG Profile Variables

A MythicRPG profile is one of a player's characters. The profile and targetprofile scopes keep a variable on the player's active profile, so each character has its own value, while caster and target keep one value per player for all of their characters.

The profile scopes and placeholders require MythicRPG Premium as well as MythicMobs Premium! MythicProxy checks for MythicRPG Premium once, when it starts. Without it, profile and targetprofile are invalid scopes and the profile placeholders do not exist, see MythicRPG Premium Not Detected.

Each right-click moves the clicking player's current character one quest stage further, and every character has its own stage.

QuestGiver:
  Type: VILLAGER
  Skills:
  - networkVariableAdd{var=quest_stage;scope=targetprofile;amount=1} ~onInteract
  - message{m="Your character is on quest stage <target.profilenetvar.quest_stage|0>"} @trigger ~onInteract

• Active profile. The scopes and placeholders use the profile that MythicRPG has active for the player. After a profile switch they use the new profile at once, and its variables read as not set until the proxy has sent them.
• No active profile. While a player has no active profile, for example while MythicRPG is still loading it, a mechanic does nothing, a condition is false and a placeholder prints UNDEFINED, see Unset Variables.
• Several backends. A profile has the same variables on every backend only if it has the same id there. Give the backends that share players the same MythicRPG MySQL or MariaDB database (Storage.Driver in MythicRPG's config-rpg.yml). With the default JSON storage, each backend has its own profiles.
• Deleted profiles. Deleting a profile in MythicRPG does not delete its variables on the proxy.
• Joins and switches. The join and switch triggers also wait for the player's profile, see Missed Events.