Legacy:Global Function (UT) - Revision history

SeriousBarbie: +"is equal to or"

2016-11-23T23:14:25Z

+"is equal to or"

SeriousBarbie: SetPropertyString -> SetPropertyText

2015-09-25T20:42:55Z

SetPropertyString -> SetPropertyText

Azura: Removed incorrect reference to modulo in description of Abs function

2008-12-30T15:40:07Z

Removed incorrect reference to modulo in description of Abs function

Bc179129.bendcable.com: that seems better =)

2006-02-02T03:28:48Z

that seems better =)

New page

{{classbox| [[Legacy:UT|UT]] :: [[Legacy:Object (UT)|Object (UT)]] (Methods)}}

The functions listed here are globally available in all classes. Due to [[Legacy:UnrealScript|UnrealScript]]'s strict object-oriented approach, they're actually methods of the [[Legacy:Object (UT)|Object (UT)]] class.

Almost all of these functions are declared as native and final (see [[Legacy:Class Syntax|class syntax]]) and most of them are also [[Legacy:Static Function|static function]]s.

See [[Legacy:Vector|vector]] and [[Legacy:Rotator|rotator]] for functions on those variable types.

See [[Legacy:Global Function|Global Function]] for global UT2003 functions.

===Integer Functions ===
; int Rand (int Max) [static] : Returns a random number ranging from 0 to Max-1.
; int Min (int A, int B) [static] : Returns the lower of the two values.
; int Max (int A, int B) [static] : Returns the higher of the two values.
; int Clamp (int V, int A, int B) [static] : If V is smaller than A, A is returned. If V is larger than B, B is returned. In any other case V is returned.

===Float Functions ===
; float Abs (float A) [static] : Returns the absolute value (also known as the modulo) of A, usually written |A|. Eg: Abs(5) == Abs(-5) == 5.
; float Sin (float A) [static] : Returns sine( A )
; float Cos (float A) [static] : Returns cosine( A )
; float Tan (float A) [static] : Returns tan( A )
; float Atan (float A) [static] : Inverse tangent. Returns tan-1-(A). Other inverse trig functions are not included in [[Legacy:UT|UT]]'s UnrealScript. (see [[Legacy:Useful Maths Functions|Useful Maths Functions]])
; float Exp (float A) [static] : Returns eA
; float Loge (float A) [static] : Returns log(A), the natural logarithm.
; float Sqrt (float A) [static] : Returns the square root of A.
; float Square (float A) [static] : Returns A2.
; float FRand ( ) : Returns a random number between 0 and 1.
; float FMin (float A, float B) [static] : Returns the lower of the two values.
; float FMax (float A, float B) [static] : Returns the higher of the two values.
; float FClamp (float V, float A, float B) [static] : If V is smaller than A, A is returned. If V is larger than B, B is returned. In any other case V is returned.
; float Lerp (float Alpha, float A, float B) [static] : "Returns the linear interpolation between A and B." The return value is calculated through something like this: <tt>(B - A) * Alpha + A</tt>
; float Smerp (float Alpha, float A, float B) [static] : Returns an Alpha-smooth nonlinear interpolation between A and B. The return value seems to be calculated through something like this: <tt>(-2 * (B - A) * Alpha ** 3) + (3 * (B - A) * Alpha ** 2) + A</tt>
;[[Image:Legacy_interpolation-smerp.gif|]]
; float RandRange (float Min, float Max) : Returns a random number between Min and Max. This function is not static.

===String Functions ===
; int Len (coerce string S) [static] : Returns the length of the string, i.e. the number of characters in it.
; int InStr (coerce string haystack, coerce string needle) [static] : If the string <tt>needle</tt> is found inside <tt>haystack</tt>, the number of characters in <tt>haystack</tt> ''before'' the first occurance of <tt>needle</tt> is returned. That is, if the <tt>needle</tt> is found right at the beginning of <tt>haystack</tt>, 0 is returned. If <tt>haystack</tt> doesn't contain <tt>needle</tt>, InStr returns -1.
; string Mid (coerce string S, int skip, optional int num) [static] : Returns a substring of <tt>S</tt>, skipping <tt>skip</tt> characters and returning the next <tt>num</tt> characters or all remaining if the third parameter is left out. Mid("hello", 0, 2) returns "he", Mid("hello", 1) returns "ello", i.e. all but the first character.
; string Left (coerce string S, int num) [static] : Returns the <tt>num</tt> leftmost characters of <tt>S</tt> or all of them if <tt>S</tt> contains less than <tt>num</tt> characters.
; string Right (coerce string S, int num) [static] : Returns the <tt>num</tt> rightmost characters of <tt>S</tt> or all of them if <tt>S</tt> contains less than <tt>num</tt> characters.
; string Caps (coerce string S) [static] : Returns <tt>S</tt> converted to uppercase.
; string Chr (int i) [static] : Returns the character matchin the given ASCII code.
; int Asc (string S) [static] : Returns the ASCII code of the first character in <tt>S</tt>.

===General Functions ===

====Logging ====
; Log (coerce string S, optional name Tag) [static] : Writes a line to the log file. The line begins with the Tag or "ScriptLog:" if Tag was not specified, followed by the log string. The tags 'Error' and 'Warning' (and probably others, too) have a special meaning in [[Legacy:Commandlet|Commandlet]]s.
; Warn (coerce string S) [static] : Same like <tt>Log</tt>, but the line starts with "ScriptWarning:" and contains information about the object, state and function that called <tt>Warn</tt>.
; string Localize (string SectionName, string KeyName, string PackageName) [static] : Returns the string found in ''PackageName''.int in the [''SectionName''] section. Logs an error if no localization for the specified string is found.

====State-Related ====
; GotoState (optional name NewState, optional name Label) : Switches to a new state. State code execution begins at the specified label or at "Begin:" if <tt>Label</tt> is not specified. Before the state is changed the old state's <tt>EndState</tt> function is called. After the state changed <tt>BeginState</tt> of the new state is called.
; bool IsInState (name TestState) : Returns whether the object's current state is the one specified.
; name GetStateName ( ) : Returns the object's current state name.
; BeginState ( ) [not native, not final] : This event is executed during GotoState right after the object switched to the new state. This function can be overridden in any state of any class.
; EndState ( ) [not native, not final] : This event is executed during GotoState right before the object switches to the new state. This function can be overridden in any state of any class.

====Class Hierarchy ====
; bool ClassIsChildOf (class TestClass, class ParentClass) [static] : Returns whether <tt>TestClass</tt> is a subclass of <tt>Parentclass</tt>.
; bool IsA (name ClassName) : Returns whether the object's class is the specified class or a subclass. This function doesn't need a reference to the desired class, but just the class's name.

====Enabling / Disabling Functions ====
; Enable (name ProbeFunc) : Enables a [[Legacy:Probe Function|probe function]].
; Disable (name ProbeFunc) : Disables a [[Legacy:Probe Function|probe function]].

====Objects / Properties ====
; string GetPropertyText (string PropName) : Returns the value of the specified property [[Legacy:Typecasting|typecasted]] to string. This is useful when you don't want any dependencies to the package of an object, but still need to access its properties. Usage: <tt>aString = anObject.GetPropertyText("''PropertyName''");</tt>
; SetPropertyText (string PropName, string PropValue) : Assigns a value to the specified property of an object. Only use this for properties that can be [[Legacy:Typecasting|typecasted]] from string. Usage: <tt>anObject.SetPropertyString("''PropertyName''", "''new value''");</tt>
; name GetEnum (Object E, int i) [static] : Returns the i-th element of the given enumeration, as in <code>GetEnum(enum'MyEnum', 2)</code> or an empty name of the specified index exceeds the number of elements in the enumeration.
; [[Legacy:Object (UT)|Object (UT)]] DynamicLoadObject (string ObjectName, Class ObjectClass, optional bool MayFail) [static] : Loads and returns the specified object. If <tt>bMayFail</tt> is true no error will be logged.
; SaveConfig ( ) : Saves the current values of config and globalconfig variables of this object to the ini file and sets them as default values for the object's class.
; StaticSaveConfig ( ) [static] : Saves the default values of config and globalconfig variables of this object's class to the ini file.
; ResetConfig ( ) [static] : Resets the config and globalconfig variables of this object's class to the values stored in Default.ini or DefUser.ini.

==Related Topics ==
* [[Legacy:UnrealScript|UnrealScript]]
** [[Legacy:Class Syntax|Class Syntax]]
** [[Legacy:Function Syntax|Function Syntax]]
** [[Legacy:Operators|Operators]]
** [[Legacy:Object (UT)|Object class]]

Wormbo: better description for the string functions

2006-02-01T17:53:57Z

better description for the string functions

@@ Line 68: / Line 68: @@
 ====Objects / Properties ====
 ; string GetPropertyText (string PropName) : Returns the value of the specified property [[Legacy:Typecasting|typecasted]] to string. This is useful when you don't want any dependencies to the package of an object, but still need to access its properties.<br />Usage: <tt>aString = anObject.GetPropertyText("''PropertyName''");</tt>
-; SetPropertyText (string PropName, string PropValue) : Assigns a value to the specified property of an object. Only use this for properties that can be [[Legacy:Typecasting|typecasted]] from string.<br />Usage: <tt>anObject.SetPropertyString("''PropertyName''", "''new value''");</tt>
+; SetPropertyText (string PropName, string PropValue) : Assigns a value to the specified property of an object. Only use this for properties that can be [[Legacy:Typecasting|typecasted]] from string.<br />Usage: <tt>anObject.SetPropertyText("''PropertyName''", "''new value''");</tt>
 ; name GetEnum (Object E, int i) [static] : Returns the i-th element of the given enumeration, as in <code>GetEnum(enum'MyEnum', 2)</code> or an empty name of the specified index exceeds the number of elements in the enumeration.
 ; [[Legacy:Object (UT)|Object (UT)]] DynamicLoadObject (string ObjectName, Class ObjectClass, optional bool MayFail) [static] : Loads and returns the specified object. If <tt>bMayFail</tt> is true no error will be logged.

← Older revision		Revision as of 17:53, 1 February 2006
Line 81:		Line 81:
	** [[Legacy:Operators\|Operators]]		** [[Legacy:Operators\|Operators]]
	** [[Legacy:Object (UT)\|Object class]]		** [[Legacy:Object (UT)\|Object class]]
		+
		+	==Discussion==
		+	:'''Nobody:''' Do all the string functions count the first character of the passed string as 0? I know it says here that instr(...) does this, and I've updated mid(...) to show this, not sure of the others, if so needs clarified.

@@ Line 59: / Line 59: @@
 ====Class Hierarchy ====
-; bool ClassIsChildOf (class TestClass, class ParentClass) [static] : Returns whether <tt>TestClass</tt> is a subclass of <tt>Parentclass</tt>.
+; bool ClassIsChildOf (class TestClass, class ParentClass) [static] : Returns whether <tt>TestClass</tt> is equal to or a subclass of <tt>Parentclass</tt>.
 ; bool IsA (name ClassName) : Returns whether the object's class is the specified class or a subclass. This function doesn't need a reference to the desired class, but just the class's name.

@@ Line 16: / Line 16: @@
 ===Float Functions ===
-; float Abs (float A) [static] : Returns the absolute value (also known as the modulo) of A, usually written |A|. Eg: Abs(5) == Abs(-5) == 5.
+; float Abs (float A) [static] : Returns the absolute value of A, usually written |A|. Eg: Abs(5) == Abs(-5) == 5.
 ; float Sin (float A) [static] : Returns sine( A )
 ; float Cos (float A) [static] : Returns cosine( A )
@@ Line 31: / Line 31: @@
 ; float Lerp (float Alpha, float A, float B) [static] : "Returns the linear interpolation between A and B."<br />The return value is calculated through something like this:<br /><tt>(B - A) * Alpha + A</tt>
 ; float Smerp (float Alpha, float A, float B) [static] : Returns an Alpha-smooth nonlinear interpolation between A and B.<br />The return value seems to be calculated through something like this:<br /><tt>(-2 * (B - A) * Alpha ** 3) + (3 * (B - A) * Alpha ** 2) + A</tt>
-;[[Image:Legacy_interpolation-smerp.gif|]]
+;[[Image:Legacy_interpolation-smerp.gif|Legacy_interpolation-smerp.gif]]
 ; float RandRange (float Min, float Max) : Returns a random number between Min and Max. This function is not static.
@@ Line 81: / Line 81: @@
 ** [[Legacy:Operators|Operators]]
 ** [[Legacy:Object (UT)|Object class]]