UnrealScript Language Reference - Revision history

Plasma at 08:52, 25 May 2024

2024-05-25T08:52:40Z

← Older revision		Revision as of 08:52, 25 May 2024
Line 1:		Line 1:
			__FORCETOC__
	== UnrealScript Language Reference ==		== UnrealScript Language Reference ==

Plasma at 15:40, 20 May 2024

2024-05-20T15:40:31Z

← Older revision		Revision as of 15:40, 20 May 2024
Line 1,284:		Line 1,284:
	! Operator !! Types it applies to !! Meaning		! Operator !! Types it applies to !! Meaning
	\|-		\|-
	\| $ \|\| string \|\| ~~Example~~		\| $ \|\| string \|\| String concatenation
	\|-		\|-
	\| *= \|\| byte, int, float, vector, rotation \|\| ~~Example~~		\| *= \|\| byte, int, float, vector, rotation \|\| Multiply and assign
	\|-		\|-
	\| /= \|\| byte, int, float, vector, rotation \|\| ~~Example~~		\| /= \|\| byte, int, float, vector, rotation \|\| Divide and assign
	\|-		\|-
	\| += \|\| byte, int, float, vector \|\| ~~Example~~		\| += \|\| byte, int, float, vector \|\| Add and assign
	\|-		\|-
	\| -= \|\| byte, int, float, vector \|\| ~~Example~~		\| -= \|\| byte, int, float, vector \|\| Subtract and assign
	\|-		\|-
	\| <nowiki>\|\|</nowiki> \|\| bool \|\| ~~Example~~		\| <nowiki>\|\|</nowiki> \|\| bool \|\| Logical or
	\|-		\|-
	\| && \|\| bool \|\| ~~Example~~		\| && \|\| bool \|\| Logical and
	\|-		\|-
	\| & \|\| int \|\| ~~Example~~		\| & \|\| int \|\| Bitwise and
	\|-		\|-
	\| <nowiki>\|</nowiki> \|\| int \|\| ~~Example~~		\| <nowiki>\|</nowiki> \|\| int \|\| Bitwise or
	\|-		\|-
	\| ^ \|\| int \|\| ~~Example~~		\| ^ \|\| int \|\| Bitwise exlusive or
	\|-		\|-
	\| != \|\| All \|\| ~~Example~~		\| != \|\| All \|\| Compare for inequality
	\|-		\|-
	\| == \|\| All \|\| ~~Example~~		\| == \|\| All \|\| Compare for equality
	\|-		\|-
	\| < \|\| byte, int, float, string \|\| ~~Example~~		\| < \|\| byte, int, float, string \|\| Less than
	\|-		\|-
	\| > \|\| byte, int, float, string \|\| ~~Example~~		\| > \|\| byte, int, float, string \|\| Greater than
	\|-		\|-
	\| <= \|\| byte, int, float, string \|\| ~~Example~~		\| <= \|\| byte, int, float, string \|\| Less than or equal to
	\|-		\|-
	\| >= \|\| byte, int, float, string \|\| ~~Example~~		\| >= \|\| byte, int, float, string \|\| Greater than or equal to
	\|-		\|-
	\| ~= \|\| float, string \|\| ~~Example~~		\| ~= \|\| float, string \|\| Approximate equality (within 0.0001), case-insensitive equality.
	\|-		\|-
	\| << \|\| int, vector \|\| ~~Example~~		\| << \|\| int, vector \|\| Left shift (int), Forward vector transformation (vector)
	\|-		\|-
	\| >> \|\| int, vector \|\| ~~Example~~		\| >> \|\| int, vector \|\| Right shift (int), Reverse vector transformation (vector)
	\|-		\|-
	\| + \|\| byte, int, float, vector \|\| ~~Example~~		\| + \|\| byte, int, float, vector \|\| Add
	\|-		\|-
	\| - \|\| byte, int, float, vector \|\| ~~Example~~		\| - \|\| byte, int, float, vector \|\| Subtract
	\|-		\|-
	\| % \|\| float \|\| ~~Example~~		\| % \|\| float \|\| Modulo (remainder after division)
	\|-		\|-
	\| * \|\| byte, int, float, vector, rotation \|\| ~~Example~~		\| * \|\| byte, int, float, vector, rotation \|\| Multiply
	\|-		\|-
	\| / \|\| byte, int, float, vector, rotation \|\| ~~Example~~		\| / \|\| byte, int, float, vector, rotation \|\| Divide
	\|-		\|-
	\| Dot \|\| vector \|\| ~~Example~~		\| Dot \|\| vector \|\| Vector dot product
	\|-		\|-
	\| Cross \|\| vector \|\| ~~Example~~		\| Cross \|\| vector \|\| Vector cross product
	\|-		\|-
	\| ** \|\| float \|\| ~~Example~~		\| ** \|\| float \|\| Exponentiation
	\|}		\|}

Plasma at 15:36, 20 May 2024

2024-05-20T15:36:50Z

Show changes

Plasma at 15:30, 20 May 2024

2024-05-20T15:30:31Z

← Older revision		Revision as of 15:30, 20 May 2024
Line 1,280:		Line 1,280:
	UnrealScript provides a wide variety of C/C++/Java-style operators for such operations as adding numbers together, comaring values, and incrementing variables. The complete set of operators is defined in Object.u, but here is a recap. Here are the standard operators, in order of precedence. Note that all of the C style operators have the same precedence as they do in C.		UnrealScript provides a wide variety of C/C++/Java-style operators for such operations as adding numbers together, comaring values, and incrementing variables. The complete set of operators is defined in Object.u, but here is a recap. Here are the standard operators, in order of precedence. Note that all of the C style operators have the same precedence as they do in C.

	{\| class="wikitable" style="margin:auto"		{\| class="wikitable" style="margin:auto;margin-left: 0px;"
	\|-		\|-
	! Operator !! Types it applies to !! Meaning		! Operator !! Types it applies to !! Meaning

Plasma at 15:27, 20 May 2024

2024-05-20T15:27:06Z

← Older revision		Revision as of 15:27, 20 May 2024
Line 1,284:		Line 1,284:
	! Operator !! Types it applies to !! Meaning		! Operator !! Types it applies to !! Meaning
	\|-		\|-
	\| $ \|\| ~~Example~~ \|\| Example		\| $ \|\| string \|\| Example
	\|-		\|-
	\| *= \|\| ~~Example~~ \|\| Example		\| *= \|\| byte, int, float, vector, rotation \|\| Example
	\|-		\|-
	\| /= \|\| ~~Example~~ \|\| Example		\| /= \|\| byte, int, float, vector, rotation \|\| Example
	\|-		\|-
	\| += \|\| ~~Example~~ \|\| Example		\| += \|\| byte, int, float, vector \|\| Example
	\|-		\|-
	\| -= \|\| ~~Example~~ \|\| Example		\| -= \|\| byte, int, float, vector \|\| Example
	\|-		\|-
	\| <nowiki>\|\|</nowiki> \|\| ~~Example~~ \|\| Example		\| <nowiki>\|\|</nowiki> \|\| bool \|\| Example
	\|-		\|-
	\| && \|\| ~~Example~~ \|\| Example		\| && \|\| bool \|\| Example
	\|-		\|-
	\| & \|\| ~~Example~~ \|\| Example		\| & \|\| int \|\| Example
	\|-		\|-
	\| <nowiki>\|</nowiki> \|\| ~~Example~~ \|\| Example		\| <nowiki>\|</nowiki> \|\| int \|\| Example
	\|-		\|-
	\| ^ \|\| ~~Example~~ \|\| Example		\| ^ \|\| int \|\| Example
	\|-		\|-
	\| != \|\| ~~Example~~ \|\| Example		\| != \|\| All \|\| Example
	\|-		\|-
	\| == \|\| ~~Example~~ \|\| Example		\| == \|\| All \|\| Example
	\|-		\|-
	\| < \|\| ~~Example~~ \|\| Example		\| < \|\| byte, int, float, string \|\| Example
	\|-		\|-
	\| > \|\| ~~Example~~ \|\| Example		\| > \|\| byte, int, float, string \|\| Example
	\|-		\|-
	\| <= \|\| ~~Example~~ \|\| Example		\| <= \|\| byte, int, float, string \|\| Example
	\|-		\|-
	\| >= \|\| ~~Example~~ \|\| Example		\| >= \|\| byte, int, float, string \|\| Example
	\|-		\|-
	\| ~= \|\| ~~Example~~ \|\| Example		\| ~= \|\| float, string \|\| Example
	\|-		\|-
	\| << \|\| ~~Example~~ \|\| Example		\| << \|\| int, vector \|\| Example
	\|-		\|-
	\| >> \|\| ~~Example~~ \|\| Example		\| >> \|\| int, vector \|\| Example
	\|-		\|-
	\| + \|\| ~~Example~~ \|\| Example		\| + \|\| byte, int, float, vector \|\| Example
	\|-		\|-
	\| - \|\| ~~Example~~ \|\| Example		\| - \|\| byte, int, float, vector \|\| Example
	\|-		\|-
	\| % \|\| ~~Example~~ \|\| Example		\| % \|\| float \|\| Example
	\|-		\|-
	\| * \|\| ~~Example~~ \|\| Example		\| * \|\| byte, int, float, vector, rotation \|\| Example
	\|-		\|-
	\| / \|\| ~~Example~~ \|\| Example		\| / \|\| byte, int, float, vector, rotation \|\| Example
	\|-		\|-
	\| Dot \|\| ~~Example~~ \|\| Example		\| Dot \|\| vector \|\| Example
	\|-		\|-
	\| Cross \|\| ~~Example~~ \|\| Example		\| Cross \|\| vector \|\| Example
	\|-		\|-
	\| ** \|\| ~~Example~~ \|\| Example		\| ** \|\| float \|\| Example
	\|}		\|}

Plasma at 15:23, 20 May 2024

2024-05-20T15:23:52Z

← Older revision		Revision as of 15:23, 20 May 2024
Line 1,294:		Line 1,294:
	\| -= \|\| Example \|\| Example		\| -= \|\| Example \|\| Example
	\|-		\|-
	\| ~~\p\p~~ \|\| Example \|\| Example		\| <nowiki>\|\|</nowiki> \|\| Example \|\| Example
	\|-		\|-
	\| && \|\| Example \|\| Example		\| && \|\| Example \|\| Example
Line 1,300:		Line 1,300:
	\| & \|\| Example \|\| Example		\| & \|\| Example \|\| Example
	\|-		\|-
	\| \p \|\| Example \|\| Example		\| <nowiki>\|</nowiki> \|\| Example \|\| Example
	\|-		\|-
	\| ^ \|\| Example \|\| Example		\| ^ \|\| Example \|\| Example

Plasma at 15:20, 20 May 2024

2024-05-20T15:20:02Z

← Older revision		Revision as of 15:20, 20 May 2024
Line 1,279:		Line 1,279:

	UnrealScript provides a wide variety of C/C++/Java-style operators for such operations as adding numbers together, comaring values, and incrementing variables. The complete set of operators is defined in Object.u, but here is a recap. Here are the standard operators, in order of precedence. Note that all of the C style operators have the same precedence as they do in C.		UnrealScript provides a wide variety of C/C++/Java-style operators for such operations as adding numbers together, comaring values, and incrementing variables. The complete set of operators is defined in Object.u, but here is a recap. Here are the standard operators, in order of precedence. Note that all of the C style operators have the same precedence as they do in C.

			{\| class="wikitable" style="margin:auto"
			\|-
			! Operator !! Types it applies to !! Meaning
			\|-
			\| $ \|\| Example \|\| Example
			\|-
			\| *= \|\| Example \|\| Example
			\|-
			\| /= \|\| Example \|\| Example
			\|-
			\| += \|\| Example \|\| Example
			\|-
			\| -= \|\| Example \|\| Example
			\|-
			\| \p\p \|\| Example \|\| Example
			\|-
			\| && \|\| Example \|\| Example
			\|-
			\| & \|\| Example \|\| Example
			\|-
			\| \p \|\| Example \|\| Example
			\|-
			\| ^ \|\| Example \|\| Example
			\|-
			\| != \|\| Example \|\| Example
			\|-
			\| == \|\| Example \|\| Example
			\|-
			\| < \|\| Example \|\| Example
			\|-
			\| > \|\| Example \|\| Example
			\|-
			\| <= \|\| Example \|\| Example
			\|-
			\| >= \|\| Example \|\| Example
			\|-
			\| ~= \|\| Example \|\| Example
			\|-
			\| << \|\| Example \|\| Example
			\|-
			\| >> \|\| Example \|\| Example
			\|-
			\| + \|\| Example \|\| Example
			\|-
			\| - \|\| Example \|\| Example
			\|-
			\| % \|\| Example \|\| Example
			\|-
			\| * \|\| Example \|\| Example
			\|-
			\| / \|\| Example \|\| Example
			\|-
			\| Dot \|\| Example \|\| Example
			\|-
			\| Cross \|\| Example \|\| Example
			\|-
			\| ** \|\| Example \|\| Example
			\|}

Plasma at 15:06, 20 May 2024

2024-05-20T15:06:55Z

← Older revision		Revision as of 15:06, 20 May 2024
Line 1,234:		Line 1,234:

	'''Converting among Actor and Object classes'''		'''Converting among Actor and Object classes'''

			Just like the conversion functions above, which convert among simple datatypes, in UnrealScript you can convert actor and object references among various types. For example, all actors have a variable named "Target", which is a reference to another actor. Say you are writing a script where you need to check and see if your Target belongs to the "Pawn" actor class, and you need to do something special with your target that only makes sense when it’s a pawn -- for example, you need to call one of the Pawn functions. The actor cast operators let you do this. Here’s an example:

			<syntaxhighlight lang="c++">
			var actor Target;
			//...

			function TestActorConversions()
			{
			local Pawn P;

			// See if my target is a Pawn.
			P = Pawn(Target);
			if( P != None )
			{
			// Target is a pawn, so set its Enemy to Self.
			P.Enemy = Self;
			}
			else
			{
			// Target is not a pawn.
			}
			}
			</syntaxhighlight>

			To perform an actor conversion, type the class name followed by the actor expression you wish to convert, in parenthesis. Such a conversion will either succeed or fail based on whether the conversion is sensible. In the above example, if your Target is referencing a Trigger object rather than a pawn, the expression Pawn(Target) will return "None", since a Trigger can’t be converted to a Pawn. However, if your Target is referencing a Brute object, the conversion will successfully return the Brute, because Brute is a subclass of Pawn.

			Thus, actor conversions have two purposes: First, you can use them to see if a certain actor reference belongs to a certain class. Second, you can use them to convert an actor reference from one class to a more specific class. Note that these conversions don’t affect the actor you’re converting at all -- they just enable UnrealScript to treat the actor reference as if it were a more specific type.

			Another example of conversions lies in the Inventory script. Each Inventory actor is owned by a Pawn, even though its Owner variable can refer to any Actor. So a common theme in the Inventory code is to cast Owner to a Pawn, for example:

			<syntaxhighlight lang="c++">
			// Called by engine when destroyed.
			function Destroyed()
			{
			// Remove from owner's inventory.
			if( Pawn(Owner)!=None )
			Pawn(Owner).DeleteInventory( Self );
			}
			</syntaxhighlight>


			'''Built-in operators and their precedence'''

			UnrealScript provides a wide variety of C/C++/Java-style operators for such operations as adding numbers together, comaring values, and incrementing variables. The complete set of operators is defined in Object.u, but here is a recap. Here are the standard operators, in order of precedence. Note that all of the C style operators have the same precedence as they do in C.

Plasma at 15:04, 20 May 2024

2024-05-20T15:04:59Z

← Older revision		Revision as of 15:04, 20 May 2024
Line 1,105:		Line 1,105:

	If a state doesn’t override a state of the same name in the parent class, then you can optionally use the "expands" keyword to make the state expand on an existing state in the current class. This is useful, for example, in a situatio where you have a group of similar states (such as MeleeAttacking and RangeAttacking) which have a lot of functionality in common. In this case you could declare a base Attacking state as follows:		If a state doesn’t override a state of the same name in the parent class, then you can optionally use the "expands" keyword to make the state expand on an existing state in the current class. This is useful, for example, in a situatio where you have a group of similar states (such as MeleeAttacking and RangeAttacking) which have a lot of functionality in common. In this case you could declare a base Attacking state as follows:

			<syntaxhighlight lang="c++">
			// Base Attacking state.
			state Attacking
			{
			// Stick base functions here...
			}

			// Attacking up-close.
			state MeleeAttacking expands Attacking
			{
			// Stick specialized functions here...
			}

			// Attacking from a distance.
			state RangeAttacking expands Attacking
			{
			// Stick specialized functions here...
			}
			</syntaxhighlight>

			A state can optionally use the "ignores" specifier to ignore functions while in a state. The syntax for this is:

			<syntaxhighlight lang="c++">
			// Declare a state.
			state Retreating
			{
			// Ignore the following messages...
			ignores Touch, UnTouch, MyFunction;

			// Stick functions here...
			}
			</syntaxhighlight>

			You can tell what specific state an actor is in from its "state" variable, a variable of type "name".

			It is possible for an actor to be in "no state" by using GotoState(‘’). When an actor is in "no state", only its global (non-state) functions are called.

			Whever you use the GotoState command to set an actor’s state, the engine can call two special notification functions, if you have defined them: EndState() and BeginState(). EndState is called in the current state immediately before the new state is begun, and BeginState is called immediately after the new state begins. These functions provide a convenient place to do any state-specific initialization and cleanup which your state may require.


			'''Constants'''

			In UnrealScript, you can specify constant values of nearly all data types:

			* Integer and byte constants are specified with simple numbers, for example: 123
			* If you must specify an integer or byte constant in hexidecimal format, use i.e.: 0x123
			* Floating point constants are specified with decimal numbers like: 456.789
			* String constants must be enclosed in double quotes, for example: "MyString"
			* Name constants must be enclosed in single quotes, for example ‘MyName’
			* Vector constants contain X, Y, and Z values like this: Vect(1.0,2.0,4.0)
			* Rotation constants contant Pitch, Yaw, and Roll values like this: Rot(0x8000,0x4000,0)
			* The "None" constant refers to "no object" (or equivalantly, "no actor").
			* The "Self" constant refers to "this object" (or equivalantly, "this actor"), i.e. the object whose script is executing.
			* General object constants are specified by the object type followed by the object name in single quotes, for example: texture ‘Default’
			* EnumCount gives you the number of elements in an enumeration, for example: EnumCount(ELightType)
			* ArrayCount gives you the number of elements in an array, for example: ArrayCount(Touching)

			You can use the "const" keyword to declare constants which you can later refer to by name. For example:

			<syntaxhighlight lang="c++">
			const LargeNumber=123456;
			const PI=3.14159;
			const MyName="Tim";
			const Northeast=Vect(1.0,1.0,0.0);
			</syntaxhighlight>

			Constants can be defined within classes or within structs.

			To access a constant which was declared in another class, use the "classname.constname" syntax, for example:

			<syntaxhighlight lang="c++">
			Pawn.LargeNumber
			</syntaxhighlight>


			'''Expressions'''

			To assign a value to a variable, use "=" like this:

			<syntaxhighlight lang="c++">
			function Test()
			{
			local int i;
			local string[80] s;
			local vector v, q;

			i = 10; // Assign a value to integer variable i.
			s = "Hello!"; // Assign a value to string variable s.
			v = q; // Copy value of vector q to v.
			}
			</syntaxhighlight>

			In UnrealScript, whenever a function or other expression requires a certain type of data (for example, an "float"), and you specify a different type of data (for example, an "int), the compiler will try to convert the value you give to the proper type. Conversions among all the numerical data types (byte, int, and float) happen automatically, without any work on your part.

			UnrealScript is also able to many other built-in data types to other types, if you explicitly convert them in code. The syntax for this is:

			<syntaxhighlight lang="c++">
			function Test()
			{
			local int i;
			local string[80] s;
			local vector v, q;
			local rotation r;

			s = string(i); // Convert integer i to a string, and assign it to s.
			s = string(v); // Convert vector v to a string, and assign it to s.
			v = q + vector(r); // Convert rotation r to a vector, and add q.
			}
			</syntaxhighlight>

			Here is the complete set of non-automatic conversions you can use in UnrealScript:

			* String to Byte, Int, Float: Tries to convert a string like "123" to a value like 123. If the string doesn’t represent a value, the result is 0.
			* Byte, Int, Float, Vector, Rotation to String: Converts the number to its textual representation.
			* String to Vector, Rotation: Tries to parse the vector or rotation’s textual representation.
			* String to Bool: Converts the case-insensitive words "True" or "False" to True and False; converts any non-zero value to True; everything else is False.
			* Bool to String: Result is either "True" or "False".
			* Byte, Int, Float, Vector, Rotation to Bool: Converts nonzero values to True; zero values to False.
			* Bool to Byte, Int, Float: Converts True to 1; False to 0.
			* Name to String: Converts the name to the text equivalant.
			* Rotation to Vector: Returns a vector facing "forward" according to the rotation.
			* Vector to Rotation: Returns a rotation pitching and yawing in the direction of the vector; roll is zero.
			* Object (or Actor) to Int: Returns an integer that is guaranteed unique for that object.
			* Object (or Actor) to Bool: Returns False if the object is None; False otherwise.
			* Object (or Actor) to String: Returns a textual representation of the object.


			'''Converting among Actor and Object classes'''

Plasma at 15:01, 20 May 2024

2024-05-20T15:01:00Z

Show changes