Difference between revisions of "Meta Expressions"

Revision as of 16:37, 1 October 2016

These expressions can set and retrieve variables, react to object/char properties, use and combine objects, and more.

This adds the "Expression" meta condition and the "Expression Action" and "Chat Expression" meta actions.

The "/vt mexec [expression]" command can be used instead of the meta rules when appropriate. It is also a great testing tool.

There are two ways to use Expressions, your situation will determine the best choice.

The first is through sending the command like any other chat command. Ex: "/vt mexec [expression]". This can be useful if you want to issue the command without using a meta rule, or simply want to test an expression without using meta.

The second is by utilizing the "Expression" meta condition and the "Expression Action" and "Chat Expression" meta actions.

The "Expression" meta condition is like any other meta condition, if the parameters are met then it will initiate the action. You can use this to detect world objects, character properties, react to custom variables and more.

The "Expression Action" meta action initiates the expression written within.

The "Expression Chat" meta action is used to output expression strings to chat. You can use regex and meta functions to format an expression. When outputting numbers from a variable you must first convert it to a string.

Notes

• true is the same as 1, false is the same as 0. There are no actual booleans, just numbers.
• There are two extra operators added since monster expressions: the ^ (xor) operator, and the ; operator. The ; operator works on any two types and simply returns the value of the first one. It has the lowest possible precedence. The idea is to use it to string together commands when you don't care about the result.
• Unlike monster expressions, meta expressions do not trim spaces from the ends of strings.
• Set variables persist until cleared by a command or until relog.
• Formatting during the conversion of number to string is a string like this: http://msdn.microsoft.com/en-us/library/kfsatb94%28v=vs.110%29.aspx
• All operator characters which occur in a string must be escaped with \
• All numbers in a string must also be escaped.

Language Details: Operators

The following operators are recognized (listed in order of precedence):

• \ escapes a special character so that it is treated as part of a string. For instance, ".\*" yields the string ".*" rather than attempting to multiply.
• ( and ) allow grouping of expressions to change precedence.
•  % performs integer modulo division. For instance, 13%3 yields 1.
• / performs division.
• * performs multiplication.
• + performs addition on numbers, or concatenates two strings.
• - performs subtraction.
• # performs a regex match, yielding true if the match succeeded or false otherwise. The item after the # is the regex and the one before it is the string to match against. For instance, abc#b returns true, because 'abc' contains b.
•  !=, ==, >, <, >=, <= comparison operators: compares two expressions and yields true or false. The two expressions to be compared must be of the same type. String comparisons are not case sensitive.
• && yields true if two boolean expressions are both true.
• || yields true if either of two boolean expressions are true.
• ^ performs a bitwise exclusive or on two numbers, treating them as integers.

Language Details: Strings

Strings in an expression are a continuous series of letters, spaces, and escaped characters. Anything other than a letter or a space should be escaped by adding a \ in front of it.

Examples:

• Desired string: "hello world" Expression string: "hello world"
• Desired string: "a-b" Expression string: "a\-b"
• Desired string: "a! b-~! c123'." Expression string: "a\! b\-\~\! c\1\2\3\'\."

Function Information

Expand to view details and available examples.

There are currently 67 meta functions.

See the Virindi Tank Changelog for the most recent additions.

Object Properties

Vtank Object Prop Enums

Examples

Test for proximity to any portal:

coordinatedistancewithz[wobjectgetphysicscoordinates[wobjectfindnearestbyobjectclass[14]],getplayercoordinates[]]<5

Check if you have any Aged or Durable Legendary Keys in your inventory:

getobjectinternaltype[wobjectfindininventorybynamerx[\^\(Aged\|Durable\) Legendary Key\$]]==7

Check if there is any object currently selected:

getobjectinternaltype[wobjectgetselection[]]==7

Save the selected items name in a variable:

setvar[keyName,wobjectgetname[wobjectgetselection[]]]

Combine items in inventory by name:

actiontryapplyitem[wobjectfindininventorybyname[itemName], wobjectfindininventorybyname[itemName]]

Combine items in inventory by template type:

actiontryapplyitem[wobjectfindininventorybytemplatetype[#],wobjectfindininventorybytemplatetype[#]]

Where # is the template type number. Use wobjectgettemplatetype[wobjectgetselection[]] to obtain the template type number from an object.

Select item in inventory by name:

actiontryselect[wobjectfindininventorybyname[itemName]]

Select Nearest Monster:

actiontryselect[wobjectfindnearestmonster[]]

Select World Object by ObjectClass:

actiontryselect[wobjectfindnearestbyobjectclass[#]] -- Where # is the object class

Select Nearest Vendor:

actiontryselect[wobjectfindnearestbyobjectclass[25]]

Select Nearest NPC:

actiontryselect[wobjectfindnearestbyobjectclass[37]]

Use Nearest Vendor:

actiontryuseitem[wobjectfindnearestbyobjectclass[25]]

Use Nearest NPC:

actiontryuseitem[wobjectfindnearestbyobjectclass[37]]

Use Nearest door:

actiontryuseitem[wobjectfindnearestdoor[]]

Use nearest portal:

actiontryuseitem[wobjectfindnearestbyobjectclass[14]]

Use a Massive Mana Charge on yourself by name:

actiontryapplyitem[wobjectfindininventorybyname[Massive Mana Charge], wobjectgetplayer[]]

Use a Mana Stone on yourself by template type:

actiontryapplyitem[wobjectfindininventorybytemplatetype[9060],wobjectgetplayer[]]

Use inventory item by template type:

actiontryuseitem[wobjectfindininventorybytemplatetype[#]]

Check if your luminance is full (1.5mil):

getcharquadprop[6]==1500000