Editing
Operator Reference
Jump to navigation
Jump to search
Warning:
You are not logged in. Your IP address will be publicly visible if you make any edits. If you
log in
or
create an account
, your edits will be attributed to your username, along with other benefits.
Anti-spam check. Do
not
fill this in!
The following are valid operators in the Papyrus language: () [] , = + - * / % . "" ! == != > < >= <= || && += -= *= /= %= as == Parenthesis == () Parenthesis, when surrounding an [[Expression Reference|expression]], will cause that expression to be evaluated before any operators outside of the parenthesis. When following a [[Function Reference|function]] name, they denote the parameter list for the function. Examples: <syntaxhighlight lang="papyrus"> ; i will get the value of 9 i = (1 + 2) * 3 </syntaxhighlight> <br> <syntaxhighlight lang="papyrus"> ; call the function MyFunction with a parameter of 10 MyFunction(10) </syntaxhighlight> == Square Brackets == [] Square brackets are used for [[Array Reference|arrays]]. Either for accessing a specific array element, denoting the size of an array for a new one, or for denoting that a type is an array type. Examples: <syntaxhighlight lang="papyrus"> ; i whatever is in element 0 of the array i = myArray[0] </syntaxhighlight> <br> <syntaxhighlight lang="papyrus"> ; define an array of size 10 int[] myArray = new int[10] </syntaxhighlight> == Comma == , The comma operator separates parameters in a [[Function Reference|function]] definition, or a function call. Examples: <syntaxhighlight lang="papyrus"> ; call the function MyFunction with a parameter of 10 and 20 MyFunction(10, 20) </syntaxhighlight> == Math Operators == + - * / % Math operators perform some sort of operation on the two [[Expression Reference|expressions]] it sits between. Papyrus supports assignment, addition, subtraction, multiplication, division, and integer modulus. The minus sign is also used for negation (also known as unary minus). The addition operator can also be used to concatenate ('paste together') strings. If you try to divide by zero or find the remainder of a divide by zero through modulus the result is undefined and the game will spit an error to the log. Integer division will return an integer value and discard any remainders. Examples: <syntaxhighlight lang="papyrus"> ; i will get the value of 7 i = 1 + 2 * 3 </syntaxhighlight> <br> <syntaxhighlight lang="papyrus"> ; i will get the value of 1 i = 9 % 4 ; i will get the value of -3 i = -7 % 4 </syntaxhighlight> <br> <syntaxhighlight lang="papyrus"> ; i will get the value of 4 i = 29 / 6 </syntaxhighlight> <br> <syntaxhighlight lang="papyrus"> ; i will get the string "Hello World" i = "Hello " + "World" </syntaxhighlight> <br> The next example ''will not compile'' as perhaps expected because the minus sign is also used for negation <syntaxhighlight lang="papyrus"> int x int y x = 22 y = x-1 ; compiler: no viable alternative at input 'x' </syntaxhighlight> == Dot == . The dot operator goes after a variable name to let you call [[Function Reference|functions]] on it, or to access [[Property Reference|properties]]. Examples: <syntaxhighlight lang="papyrus"> ; Call the function on the variable myVariable.MyFunction() </syntaxhighlight> <br> <syntaxhighlight lang="papyrus"> ; Set the property to 10 myVariable.MyProperty = 10 </syntaxhighlight> == Double Quotes == "" Double quotes surround a [[Literals Reference#String Literals|string literal]]. Examples: <syntaxhighlight lang="papyrus"> ; A basic hello world string hello = "Hello World!" </syntaxhighlight> == Logical Operators == ! || && Logical operators evaluate to true or false values, based on their [[Expression Reference|expressions]]. *The NOT operator (!) will be true if its single expression (to the right of the operator) is false, and false if it is true. *The OR operator (||) will be true if one of the expressions to its left and right are true, and will short-circuit if the left expression is true (it will not evaluate the right expression at all). *Note that <code>If A == (B || C || D)</code> is a common mistake for new programmers. It should be <code>If A == B || A == C || A == D</code>. *The AND operator (&&) will be true if both of the expressions to its left and right are true, and will short-circuit if the left expression is false (it will not evaluate the right expression at all). Likewise, the OR operator (||) will short-circuit if the left expression is true. Examples: <syntaxhighlight lang="papyrus"> ; i gets true if both a and b are true i = a && b </syntaxhighlight> <br> <syntaxhighlight lang="papyrus"> ; i gets true if a is false i = !a </syntaxhighlight> <br> <syntaxhighlight lang="papyrus"> ; short-circuit can make sure a reference exists before doing something with it if ref && ref.HasKeyword(VendorItemClutter) </syntaxhighlight> == Comparison Operators == == != < > <= >= The comparison operators compare both [[Expression Reference|expressions]] to their left and right, and return a boolean value based on the operator used. If floating-point values are being compared, a tiny epsilon value is accounted for to conteract floating-point error. *Equality (==) returns true if both expressions have equal values. *Inequality (!=) returns true if both expressions have inequal values. *Less-than (<) returns true if the left expression's value is smaller then the right expression's value. *Greater-than (>) returns true if the left expression's value is larger then the right expression's value. *Less-than or equal to (<=) returns true if the left expression's value is smaller than or equal to the right expression's value. *Greater-than or equal to (>=) returns true if the left expression's value is larger than or equal to the right expression's value. Examples: <syntaxhighlight lang="papyrus"> ; i will get true if a is greater then b i = a > b </syntaxhighlight> <br> <syntaxhighlight lang="papyrus"> ; i will get true if a is equal to b i = a == b </syntaxhighlight> == Assignment Operators == = += -= *= /= %= Assignment operators assign the value from the right [[Expression Reference|expression]] to the [[Variable Reference|variable]] (or [[Property Reference|property]]) from the left expression. If the equal sign starts with one of the math operators, then the right expression's value will be added to the current value of the left expression, and then assigned to the left expression. Note that if the left expression is a property, then both the property's get and set functions will be called. Examples: <syntaxhighlight lang="papyrus"> ; assign 10 to i i = 10 </syntaxhighlight> <br> <syntaxhighlight lang="papyrus"> ; add 1 to the current value of i, and assign it to i i += 1 </syntaxhighlight> Only the = operator can be used to assign values to an [[Arrays_(Papyrus)|array]] element: <syntaxhighlight lang="papyrus"> ; Will not compile, as the compiler doesn't know how to handle it. myArray[3] += 5 </syntaxhighlight> == Cast == as The [[Cast Reference|cast]] operator attempts to cast the value from the left [[Expression Reference|expression]] to the type to the right of it, and returns the resulting value. Examples: <syntaxhighlight lang="papyrus"> ; cast a to a float and assign it to i i = a as float </syntaxhighlight> == Operator Precedence == Operator precedence is listed in the following table, from highest to lowest: {| class="wikitable" |- | () | Mathematical parenthesis |- | . | Dot operator (for accessing functions and properties) |- | as | Cast operator |- | - ! | Unary minus and logical NOT |- | * / % | Multiplication, division, and modulus |- | + - | Addition and subtraction |- | == != > < >= <= | Comparison operators |- | && | Logical AND |- | || | Logical OR |- | = += -= *= /= %= | Assignment |} [[Category:Scripting]] [[Category:Papyrus]] [[Category:Papyrus Language Reference]]
Summary:
Please note that all contributions to the CreationKit Wiki are considered to be released under the Creative Commons Attribution-ShareAlike (see
CreationKit:Copyrights
for details). If you do not want your writing to be edited mercilessly and redistributed at will, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource.
Do not submit copyrighted work without permission!
Cancel
Editing help
(opens in new window)
Navigation menu
Personal tools
Not logged in
Talk
Contributions
Create account
Log in
Namespaces
Page
Discussion
English
Views
Read
Edit
Edit source
View history
More
Search
Navigation
Landing page
Tutorials
Game Systems
Editor Reference
Scripting Reference
Recent changes
Help
Tools
What links here
Related changes
Special pages
Page information
Page values