| Overview | Package | Class | Source | Class tree | Glossary | UnrealScript Documentation |
| previous class next class | frames no frames | |||||
Core.Object
Actor, Bitmap, Canvas, Console, Palette, Player, Subsystem
| Constants Summary | ||
|---|---|---|
| MaxInt | = | 0x7fffffff |
| Pi | = | 3.1415926535897932 |
| Variables Summary | |
|---|---|
| int | ObjectFlags |
| int | ObjectInternal[6] |
| object | Parent |
| Object | |
| class | Class |
| name | Name |
| Enumerations Summary | ||
|---|---|---|
| ESheerAxis SHEER_None, SHEER_XY, SHEER_XZ, SHEER_YX, SHEER_YZ, SHEER_ZX, SHEER_ZY, | ||
| Structures Summary | ||
|---|---|---|
| BoundingBox Min, Max, IsValid | ||
| BoundingVolume Sphere | ||
| Color R, G, B, A | ||
| Coords Origin, XAxis, YAxis, ZAxis | ||
| DynamicArray Num, Max, Ptr | ||
| DynamicString | ||
| Guid A, B, C, D | ||
| Plane W | ||
| Rotator Pitch, Yaw, Roll | ||
| Scale Scale, SheerRate, SheerAxis | ||
| Vector X, Y, Z | ||
| Functions Summary | ||
|---|---|---|
![]() | bool | ! (bool A) |
![]() | bool | != (float A, float B) |
![]() | bool | != (int A, int B) |
![]() | bool | != (string[255] A, string[255] B) |
![]() | bool | != (name A, name B) |
![]() | bool | != (Object A, Object B) |
![]() | bool | != (bool A, bool B) |
![]() | float | % (float A, float B) |
![]() | int | & (int A, int B) |
![]() | bool | && (bool A, skip bool B) |
![]() | float | * (float A, float B) |
![]() | int | * (int A, int B) |
![]() | float | ** (float A, float B) |
![]() | float | *= (out float A, float B) |
![]() | byte | *= (out byte A, byte B) |
![]() | int | *= (out int A, float B) |
![]() | int | + (int A, int B) |
![]() | float | + (float A, float B) |
![]() | int | ++ (out int A) |
![]() | int | ++ (out int A) |
![]() | byte | ++ (out byte A) |
![]() | byte | ++ (out byte A) |
![]() | float | += (out float A, float B) |
![]() | int | += (out int A, int B) |
![]() | byte | += (out byte A, byte B) |
![]() | int | - (int A) |
![]() | float | - (float A, float B) |
![]() | int | - (int A, int B) |
![]() | float | - (float A) |
![]() | int | -- (out int A) |
![]() | int | -- (out int A) |
![]() | byte | -- (out byte A) |
![]() | byte | -- (out byte A) |
![]() | byte | -= (out byte A, byte B) |
![]() | int | -= (out int A, int B) |
![]() | float | -= (out float A, float B) |
![]() | float | / (float A, float B) |
![]() | int | / (int A, int B) |
![]() | byte | /= (out byte A, byte B) |
![]() | float | /= (out float A, float B) |
![]() | int | /= (out int A, float B) |
![]() | bool | < (string[255] A, string[255] B) |
![]() | bool | < (float A, float B) |
![]() | bool | < (int A, int B) |
![]() | int | << (int A, int B) |
![]() | bool | <= (string[255] A, string[255] B) |
![]() | bool | <= (float A, float B) |
![]() | bool | <= (int A, int B) |
![]() | bool | == (int A, int B) |
![]() | bool | == (string[255] A, string[255] B) |
![]() | bool | == (float A, float B) |
![]() | bool | == (Object A, Object B) |
![]() | bool | == (name A, name B) |
![]() | bool | == (bool A, bool B) |
![]() | bool | > (int A, int B) |
![]() | bool | > (string[255] A, string[255] B) |
![]() | bool | > (float A, float B) |
![]() | bool | >= (string[255] A, string[255] B) |
![]() | bool | >= (int A, int B) |
![]() | bool | >= (float A, float B) |
![]() | int | >> (int A, int B) |
![]() | float | Abs (float A) |
![]() | int | Asc (string[255] S) |
![]() | float | Atan (float A) |
![]() | BeginState () | |
![]() | int | Clamp (int V, int A, int B) |
![]() | bool | ClassIsChildOf (class TestClass, class ParentClass) |
![]() | float | Cos (float A) |
![]() | Disable (name ProbeFunc) | |
![]() | object | DynamicLoadObject (string[32] ObjectName, class ObjectClass) |
![]() | Enable (name ProbeFunc) | |
![]() | EndState () | |
![]() | float | Exp (float A) |
![]() | float | FClamp (float V, float A, float B) |
![]() | float | FMax (float A, float B) |
![]() | float | FMin (float A, float B) |
![]() | float | FRand () |
![]() | name | GetEnum (object E, int i) |
![]() | name | GetStateName () |
![]() | GotoState (optional name NewState, optional name Label) | |
![]() | int | InStr (coerce string[255] S, coerce string[255] t) |
![]() | bool | IsInState (name TestState) |
![]() | int | Len (coerce string[255] S) |
![]() | float | Lerp (float Alpha, float A, float B) |
![]() | Log (coerce string[240] S, optional name Tag) | |
![]() | float | Loge (float A) |
![]() | int | Max (int A, int B) |
![]() | int | Min (int A, int B) |
![]() | int | Rand (int Max) |
![]() | ResetConfig () | |
![]() | SaveConfig () | |
![]() | SetPropertyText (string[32] PropName, string[192] PropValue) | |
![]() | float | Sin (float A) |
![]() | float | Smerp (float Alpha, float A, float B) |
![]() | float | Sqrt (float A) |
![]() | float | Square (float A) |
![]() | float | Tan (float A) |
![]() | Warn (coerce string[240] S) | |
![]() | string | [ (] Caps ( coerce string[255] S) |
![]() | string | [ (] $ ( coerce string[255] A, coerce String[255] B) |
![]() | string | [ (] GetPropertyText( string[32] PropName) |
![]() | string | [ (] Chr ( int i) |
![]() | string | [ (] Localize( name SectionName, name KeyName, name PackageName) |
![]() | string | [ (] Right ( coerce string[255] S, int i) |
![]() | string | [ (] Left ( coerce string[255] S, int i) |
![]() | string | [ (] Mid ( coerce string[255] S, int i, optional int j) |
![]() | int | ^ (int A, int B) |
![]() | bool | ^^ (bool A, bool B) |
![]() | int | | (int A, int B) |
![]() | bool | || (bool A, skip bool B) |
![]() | int | ~ (int A) |
![]() | bool | ~= (string[255] A, string[255] B) |
![]() | bool | ~= (float A, float B) |
| Constants Detail |
|---|
The maximum positive int value
| Variables Detail |
|---|
Internal variable
The class of this object.
The name of this object. The string representation of this value is the same like the last part of the object's string representation.
| Enumerations Detail |
|---|
| Structures Detail |
|---|
A bounding box sphere together.
var(Object) config byte A;};
var(Object) config byte B;
var(Object) config byte G;
var(Object) config byte R;
An RGBA color
var(Object) config vector Origin;};
var(Object) config vector XAxis;
var(Object) config vector YAxis;
var(Object) config vector ZAxis;
An arbitrary coordinate system in 3d space.
A globally unique identifier.
A plane definition in 3d space.
var(Object) config int Pitch;};
var(Object) config int Roll;
var(Object) config int Yaw;
An orthogonal rotation in 3d space.
var(Object) config vector Scale;};
var(Object) ESheerAxis SheerAxis;
var(Object) config float SheerRate;
A scale and sheering.
var(Object) config float X;};
var(Object) config float Y;
var(Object) config float Z;
A point or direction vector in 3d space.
| Functions Detail |
|---|
! Source code
!= Source code
!= Source code
!= Source code
!= Source code
!= Source code
!= Source code
% Source code
& Source code
&& Source code
* Source code
* Source code
** Source code
*= Source code
*= Source code
*= Source code
+ Source code
+ Source code
++ Source code
++ Source code
++ Source code
++ Source code
+= Source code
+= Source code
+= Source code
- Source code
- Source code
- Source code
- Source code
-- Source code
-- Source code
-- Source code
-- Source code
-= Source code
-= Source code
-= Source code
/ Source code
/ Source code
/= Source code
/= Source code
/= Source code
< Source code
< Source code
< Source code
<< Source code
<= Source code
<= Source code
<= Source code
== Source code
== Source code
== Source code
== Source code
== Source code
== Source code
> Source code
> Source code
> Source code
>= Source code
>= Source code
>= Source code
>> Source code
Abs Source codeReturns the absolute value (also known as the modulo) ofA, usually written|A|. Eg:Abs(5)== Abs(-5) == 5.
Asc Source code
Returns the ASCII code of the first character in S.
Atan Source code
BeginState Source codeCalled immediately when entering a state, while within the GotoState call that caused the state change.
Clamp Source codeIfVis smaller thanA,Ais returned. IfVis larger thanB,Bis returned. In any other caseVis returned.
ClassIsChildOf Source codeReturns whetherTestClassis a subclass ofParentclass. If the two classes are the same it returns true.
Cos Source code
Returns cosine( A )
Disable Source codeDisables a probe function.
DynamicLoadObject Source codeReturns a reference to a specified object, loading it if necessary.
Enable Source codeEnables a probe function.
EndState Source codeCalled immediately before going out of the current state, while within the GotoState call that caused the state change.
Exp Source code
FClamp Source codeIfVis smaller thanA,Ais returned. IfVis larger thanB,Bis returned. In any other caseVis returned.
FMax Source codeReturns the higher of the two values.
FMin Source codeReturns the lower of the two values.
FRand Source codeReturns a random number between 0 and 1.
GetEnum Source codeReturns thei-th element of the given enumeration, as inGetEnum(enum'MyEnum', 2)or an empty name of the specified index exceeds the number of elements in the enumeration.
GetStateName Source codeReturns the object's current state name.
GotoState Source codeSwitches to a new state. State code execution begins at the specified label or at"Begin:"ifLabelis not specified.
Before the state is changed the old state'sEndStatefunction is called. After the state changedBeginStateof the new state is called.
InStr Source codeIf the string t is found inside S InStr returns the starting position with the first character of S being 0. If t is not found InStr returns -1.
IsInState Source codeReturns whether the object's current state is the one specified.
Len Source codeReturns the length of a string.
Lerp Source codeReturns the linear interpolation between A and B.
The return value is calculated through something like this:(B - A) * Alpha + A
Log Source codeWrites a line to the log file. The line begins with theTagor"ScriptLog:"ifTagwas not specified, followed by the log string.
The tags'Error'and'Warning'(and probably others, too) have a special meaning in Commandlets.
Loge Source code
Returns log(A), the natural logarithm
Max Source codeReturns the higher of the two values.
Min Source codeReturns the lower of the two values.
Rand Source codeReturns a random number ranging from 0 to Max-1.
ResetConfig Source codeResets the config and globalconfig variables of this object's class to the values stored in Default.ini or DefUser.ini.
SaveConfig Source codeSaves 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.
SetPropertyText Source codeAssigns a value to the specified public non-constant property of an object. Only use this for properties that can be typecasted from string.
Usage:anObject.SetPropertyString("PropertyName", "new value");
Sin Source code
Returns sine( A )
Smerp Source codeReturns an Alpha-smooth nonlinear interpolation between A and B.
The return value seems to be calculated through something like this:(-2 * (B - A) * Alpha ** 3) + (3 * (B - A) * Alpha ** 2) + A
Sqrt Source code
Returns the square root of A.
Square Source code
Tan Source code
Returns tan( A )
Warn Source codeSame likeLog, but the line starts with"ScriptWarning:"and contains information about the object, state and function that called Warn.
[ Source code
[ Source code
[ Source code
[ Source code
[ Source code
[ Source code
[ Source code
[ Source code
^ Source code
^^ Source code
| Source code
|| Source code
~ Source code
~= Source code
~= Source code| Overview | Package | Class | Source | Class tree | Glossary | UnrealScript Documentation |
| previous class next class | frames no frames | |||||