Data Expression

Table of Contents - [Data\Expression](#dataexpression) * [Value](#value) * [Divide](#divide) * [Multiply](#multiply) * [Subtract](#subtract) * [Add](#add) * [Compare](#compare) * [Logic Not](#logic-not) * [Logic And](#logic-and) * [Logic Or](#logic-or) * [Named Expression](#named-expression) * [Exponent](#exponent) * [Modulo](#modulo) * [If](#if)

Data\Expression {dataExpression}

Expressions are a powerful feature of the ROC editor that allows you to write formulas and plug them into various fields of game data. Similar to Validators, expressions are evaluated and return a result. Expressions are more flexible as they can be configured to write user defined formulas, and unlike validators they can return numeric or boolean values depending on context. In numeric cases, true is treated as 1 and false is treated as 0. In boolean cases, non-zero numbers are treated as true and 0 is treated as false. Note that expressions can also be used as validators. The most common use case for expressions are for creating custom damage formulas, such as damage = ([caster]STRENGTH * 10) - [target]ARMOR), where STRENGTH and ARMOR are arbitrary attributes defined as tags. Supported Fields Expressions can be plugged into a number of existing data fields and can also be used with data binding in custom UI. These are the currently supported data fields:

Value {Value}

These are the types of values you can include or reference in expression formulas.

Constant {Constant}

Returns a constant value.

Bool Value {Bool-Value}

Returns true or false.

Int32 Value {Int32-Value}

Returns an integer value.

Double Value {Double-Value}

Returns a floating point number (with decimal).

Random {Random}

Returns a random number between the min and max value.

Int32 Value {Int32-Value}

MessageType: RangeInt

Returns an integer value.

Double Value {Double-Value}

MessageType: RangeDouble

Returns a floating point number (with decimal).

Damage Amount {Damage-Amount}

The damage amount is multiplied by this value (default 0).

Returns the literal damage value when used within a damage effect.

Multiplier {Multiplier}

Heal Amount {Heal-Amount}

The heal amount is multiplied by this value (default 0).

Returns the literal heal value when used within a heal effect.

Multiplier {Multiplier}

Tag Count {Tag-Count}

Returns the tag count of a specific tag on a unit.

Unit {Unit}

EnumType: ValidatorExpressions.UnitLocation

Which unit is evaluated.

Tag Name {Tag-Name}

Which tag is evaluated.

Unit Level {Unit-Level}

Returns the level of a unit. Currently limited in usefulness.

Unit {Unit}

EnumType: ValidatorExpressions.UnitLocation

Which unit is evaluated.

Ability Level {Ability-Level}

Returns the level of an ability. Currently limited in usefulness.

Ability {Ability}

Which ablity is evaluated.

Wildsky Upgrade Level [Wild Sky] {Wildsky-Upgrade-Level-Wild-Sky}

Returns the level of a wild sky upgrade.

Data Upgrade {Data-Upgrade}

Which upgrade is evaluated.

Upgrade Level {Upgrade-Level}

Returns the level of an upgrade.

Upgrade {Upgrade}

Which upgrade is evaluated.

Remaining Path Distance {Remaining-Path-Distance}

Returns the remaining path distance for a unit with waypoints.

Unit {Unit}

EnumType: ValidatorExpressions.UnitLocation

Which unit is evaluated.

Unit Ability Cooldown {Unit-Ability-Cooldown}

Returns the current cooldown remaining for an ability.

Unit {Unit}

EnumType: ValidatorExpressions.UnitLocation

Which unit is evaluated.

Ability {Ability}

Which ablity is evaluated.

Returns the elapsed time that a behavior has been on a unit.

Note that this duration is reset to 0 when the stack count is refreshed.

Unit {Unit}

EnumType: ValidatorExpressions.UnitLocation

Which unit is evaluated.

Behavior {Behavior}

Which behavior is evaluated.

Behavior Duration {Behavior-Duration}

Returns the duration that a behavior has been on a unit.

Returns the maximum duration of a behavior on a unit. Note that this duration is not extended when the stack count is refreshed.

Unit {Unit}

EnumType: ValidatorExpressions.UnitLocation

Which unit is evaluated.

Behavior {Behavior}

Which behavior is evaluated.

Add Expressions {Add-Expressions}

Returns the sum of the listed expressions.

Functionally similar to Add but used as an expression value rather than a top-level operator.

Effect Critical Hit {Effect-Critical-Hit}

Returns 1 if the effect tree is the result of a critical hit with a weapon or ability. This can be used to create damage expressions that deal increased damage on critical hits. For example this psuedo-expression would cause a damage effect to deal 150% damage on critical hit.

Multiply( EffectCrticial * DamageAmount(1) * Constant(0.5) )

Swap out the constant for value derived from tag count to support dynamic critical hit damage multipliers.

Units Distance {Units-Distance}

Returns the distance between units.

From Unit {From-Unit}

EnumType: ValidatorExpressions.UnitLocation

To Unit {To-Unit}

EnumType: ValidatorExpressions.UnitLocation

Divide {Divide}

Divide a value by another.

Multiply {Multiply}

Multiply multiple values together. Supports nested expressions.

Subtract {Subtract}

Subtract a value from another.

Add {Add}

Add multiple values together. Supports nested expressions.

Compare {Compare}

Compares two values/expressions and returns true or false based on the result.

Logic Not {Logic-Not}

Returns the flipped value or expression (true becomes false, false becomes true).

Logic And {Logic-And}

Returns true if all listed values/expressions are true.

Logic Or {Logic-Or}

Returns true if any listed values/expressions are true.

Named Expression {Named-Expression}

Used to reference another expression. This is useful for combining multiple expressions or breaking complex expressions into smaller abstractions.

Exponent {Exponent}

Returns value to the power of another. Similar to the ^ operator in Lua.

Modulo {Modulo}

Returns the remainder of a value after being divided by another. Similar to the % operator in Lua.

If {If}

Returns the sum of the Values expressions if the Compare condition returns true. Otherwise returns the same of the Else Values expressions.

Data Expression

Data\Expression {dataExpression}

Value {Value}

Constant {Constant}

Bool Value {Bool-Value}

Int32 Value {Int32-Value}

Double Value {Double-Value}

Random {Random}

Int32 Value {Int32-Value}

Double Value {Double-Value}

Damage Amount {Damage-Amount}

Multiplier {Multiplier}

Heal Amount {Heal-Amount}

Multiplier {Multiplier}

Tag Count {Tag-Count}

Unit {Unit}

Tag Name {Tag-Name}

Unit Level {Unit-Level}

Unit {Unit}

Ability Level {Ability-Level}

Ability {Ability}

Wildsky Upgrade Level [Wild Sky] {Wildsky-Upgrade-Level-Wild-Sky}

Data Upgrade {Data-Upgrade}

Upgrade Level {Upgrade-Level}

Upgrade {Upgrade}

Remaining Path Distance {Remaining-Path-Distance}

Unit {Unit}

Unit Ability Cooldown {Unit-Ability-Cooldown}

Unit {Unit}

Ability {Ability}

Use Cooldown Period {Use-Cooldown-Period}

Health {Health}

Unit {Unit}

Max Health {Max-Health}

Unit {Unit}

Health Fraction {Health-Fraction}

Unit {Unit}

Mana {Mana}

Unit {Unit}

Max Mana {Max-Mana}

Unit {Unit}

Mana Fraction {Mana-Fraction}

Unit {Unit}

Shield {Shield}

Unit {Unit}

Max Shield {Max-Shield}

Unit {Unit}

Shield Fraction {Shield-Fraction}

Unit {Unit}

Behavior Stack Count {Behavior-Stack-Count}

Unit {Unit}

Behavior {Behavior}

Behavior Elapsed Time {Behavior-Elapsed-Time}

Unit {Unit}

Behavior {Behavior}

Behavior Duration {Behavior-Duration}

Unit {Unit}

Behavior {Behavior}

Add Expressions {Add-Expressions}

Effect Critical Hit {Effect-Critical-Hit}

Units Distance {Units-Distance}

From Unit {From-Unit}

To Unit {To-Unit}

Divide {Divide}

Multiply {Multiply}

Subtract {Subtract}

Add {Add}

Compare {Compare}

Logic Not {Logic-Not}

Logic And {Logic-And}

Logic Or {Logic-Or}

Named Expression {Named-Expression}

Exponent {Exponent}

Modulo {Modulo}

If {If}

Resources

Data

Triggers

UI

Registry Mods