Overview Package Class Source Class tree Glossary
previous class      next class frames      no frames

Core.Object

Modifiers
native noexport

Core.Object

Direct Known Subclasses:

Actor, AdminBase, AnimNotify, Bitmap, BrowserFilters, CacheManager, CameraEffect, Canvas, ChallengeGame, CheatManager, Commandlet, CrosshairPack, CustomBotConfig, CustomFilter, CustomLadderInfo, DecoText, DrawOpBase, DruidUpgradeObj, GameProfile, GUI, I3DL2Listener, Interactions, KarmaParamsCollision, LadderInfo, LevelSummary, Locale, LogEntry, Manifest, MaplistRecord, MatchInfo, Material, MatObject, MeshObject, ObjectPool, ONSPowerLinkCustomSetup, Palette, ParticleEmitter, Player, PlayerInput, PlayerRecordClass, PlayInfo, PropertyManagerBase, ReachSpec, Resource, RosterEntry, RPGAbility, RPGPlayerDataObject, ScriptedAction, Sound, SpeciesType, SPHighScoreBase, Spline, SPProfileExporter, StreamBase, Subsystem, SVehicleWheel, TextToSpeechAlias, Time, UT2K4RosterGroup, WeaponFire, xAdminBase, xPawnGibGroup, xPawnSoundGroup, xPrivilegeBase, xUtil

Constants Summary
MaxInt=0x7fffffff
Pi=3.1415926535897932
RF_NotForClient=0x00100000
RF_NotForEdit=0x00400000
RF_NotForServer=0x00200000
RF_Public=0x00000004
RF_Standalone=0x00080000
RF_Transactional=0x00000001
RF_Transient=0x00004000

Variables Summary
classClass
intObjectFlags
pointerObjectInternal[7]
objectOuter
Object
nameName

Enumerations Summary
EAxis
AXIS_X, AXIS_Y, AXIS_Z
ECamOrientation
CAMORIENT_None, CAMORIENT_LookAtActor, CAMORIENT_FacePath, CAMORIENT_Interpolate, CAMORIENT_Dolly,
EDetailMode
DM_Low, DM_High, DM_SuperHigh
EDrawPivot
DP_UpperLeft, DP_UpperMiddle, DP_UpperRight, DP_MiddleRight, DP_LowerRight, DP_LowerMiddle, DP_LowerLeft, DP_MiddleLeft, DP_MiddleMiddle,
ESheerAxis
SHEER_None, SHEER_XY, SHEER_XZ, SHEER_YX, SHEER_YZ, SHEER_ZX, SHEER_ZY,

Structures Summary
BoundingVolume
Sphere
Box
Min, Max, IsValid
Color
B, G, R, A
CompressedPosition
Location, Rotation, Velocity
Coords
Origin, XAxis, YAxis, ZAxis
FloatBox
X1, Y1, X2, Y2
Guid
A, B, C, D
IntBox
X1, Y1, X2, Y2
InterpCurve
Points
InterpCurvePoint
InVal, OutVal
Matrix
XPlane, YPlane, ZPlane, WPlane
Plane
W
Quat
X, Y, Z, W
Range
Min, Max
RangeVector
X, Y, Z
Rotator
Pitch, Yaw, Roll
Scale
Scale, SheerRate, SheerAxis
TMultiMap
FArray_Data, FArray_ArrayNum, FArray_ArrayMax, TMapBase_Hash, TMapBase_HashCount
Vector
X, Y, Z

Functions Summary
preoperatorbool ! (bool A)
operatorbool != (int A, int B)
operatorbool != (string A, string B)
operatorbool != (rotator A, rotator B)
operatorbool != (float A, float B)
operatorbool != (vector A, vector B)
operatorbool != (bool A, bool B)
operatorbool != (name A, name B)
operatorbool != (Object A, Object B)
operatorstring $ (coerce string A, coerce string B)
operatorstring $= (out string A, coerce string B)
operatorfloat % (float A, float B)
operatorint & (int A, int B)
operatorbool && (bool A, skip bool B)
operatorvector * (float A, vector B)
operatorvector * (vector A, float B)
operatorfloat * (float A, float B)
operatorrotator * (float A, rotator B)
operatorrotator * (rotator A, float B)
operatorint * (int A, int B)
operatorvector * (vector A, vector B)
operatorfloat ** (float A, float B)
operatorint *= (out int A, float B)
operatorvector *= (out vector A, vector B)
operatorrotator *= (out rotator A, float B)
operatorfloat *= (out float A, float B)
operatorvector *= (out vector A, float B)
operatorbyte *= (out byte A, byte B)
operatorint + (int A, int B)
operatorrotator + (rotator A, rotator B)
operatorfloat + (float A, float B)
operatorvector + (vector A, vector B)
preoperatorint ++ (out int A)
postoperatorint ++ (out int A)
postoperatorbyte ++ (out byte A)
preoperatorbyte ++ (out byte A)
operatorfloat += (out float A, float B)
operatorrotator += (out rotator A, rotator B)
operatorbyte += (out byte A, byte B)
operatorint += (out int A, int B)
operatorvector += (out vector A, vector B)
operatorfloat - (float A, float B)
preoperatorfloat - (float A)
preoperatorvector - (vector A)
operatorrotator - (rotator A, rotator B)
preoperatorint - (int A)
operatorvector - (vector A, vector B)
operatorint - (int A, int B)
postoperatorbyte -- (out byte A)
postoperatorint -- (out int A)
preoperatorint -- (out int A)
preoperatorbyte -- (out byte A)
operatorrotator -= (out rotator A, rotator B)
operatorvector -= (out vector A, vector B)
operatorint -= (out int A, int B)
operatorstring -= (out string A, coerce string B)
operatorfloat -= (out float A, float B)
operatorbyte -= (out byte A, byte B)
operatorrotator / (rotator A, float B)
operatorvector / (vector A, float B)
operatorint / (int A, int B)
operatorfloat / (float A, float B)
operatorrotator /= (out rotator A, float B)
operatorint /= (out int A, float B)
operatorvector /= (out vector A, float B)
operatorfloat /= (out float A, float B)
operatorbyte /= (out byte A, byte B)
operatorbool < (float A, float B)
operatorbool < (int A, int B)
operatorbool < (string A, string B)
operatorint << (int A, int B)
operatorvector << (vector A, rotator B)
operatorbool <= (float A, float B)
operatorbool <= (int A, int B)
operatorbool <= (string A, string B)
operatorbool == (rotator A, rotator B)
operatorbool == (string A, string B)
operatorbool == (float A, float B)
operatorbool == (vector A, vector B)
operatorbool == (name A, name B)
operatorbool == (bool A, bool B)
operatorbool == (int A, int B)
operatorbool == (Object A, Object B)
operatorbool > (float A, float B)
operatorbool > (int A, int B)
operatorbool > (string A, string B)
operatorbool >= (float A, float B)
operatorbool >= (string A, string B)
operatorbool >= (int A, int B)
operatorint >> (int A, int B)
operatorvector >> (vector A, rotator B)
operatorint >>> (int A, int B)
operatorstring @ (coerce string A, coerce string B)
operatorstring @= (out string A, coerce string B)
functionfloat Abs (float A)
functionfloat Acos (float A)
function AllObjects (class baseClass, out Object obj)
functionint Asc (string S)
functionfloat Asin (float A)
functionfloat Atan (float A, float B)
event BeginState ()
functionstring Caps (coerce string S)
functionfloat Ceil (float A)
functionstring Chr (int i)
functionint Clamp (int V, int A, int B)
functionbool ClassIsChildOf (class TestClass, class ParentClass)
function ClearConfig (optional string PropName)
operatorbool ClockwiseFrom (int A, int B)
functionfloat Cos (float A)
event Created ()
operatorvector Cross (vector A, vector B)
function Disable (name ProbeFunc)
functionbool Divide (coerce string Src, string Divider, out string LeftPart, out string RightPart)
operatorfloat Dot (vector A, vector B)
functionobject DynamicLoadObject (string ObjectName, class ObjectClass, optional bool MayFail)
function EatStr (out string Dest, out string Source, int Num)
function Enable (name ProbeFunc)
event EndState ()
functionstring Eval (bool Condition, coerce string ResultIfTrue, coerce string ResultIfFalse)
functionfloat Exp (float A)
functionfloat FClamp (float V, float A, float B)
functionobject FindObject (string ObjectName, class ObjectClass)
functionfloat FMax (float A, float B)
functionfloat FMin (float A, float B)
functionfloat FRand ()
function GetAxes (rotator A, out vector X, out vector Y, out vector Z)
functionname GetEnum (object E, coerce int i)
functionString GetItemName (string FullName)
functionarray<string> GetPerObjectNames (string ININame, optional string ObjectClass, optional int MaxResults)
functionstring GetPropertyText (string PropName)
function GetReferencers (Object Target, out array<Object> Referencers)
functionname GetStateName ()
function GetUnAxes (rotator A, out vector X, out vector Y, out vector Z)
function GotoState (optional name NewState, optional name Label)
functionint InStr (coerce string S, coerce string t)
functionfloat InterpCurveEval (InterpCurve curve, float input)
function InterpCurveGetInputDomain (InterpCurve curve, out float min, out float max)
function InterpCurveGetOutputRange (InterpCurve curve, out float min, out float max)
function Invert (out vector X, out vector Y, out vector Z)
functionbool IsA (name ClassName)
functionbool IsInState (name TestState)
functionbool IsOnConsole ()
functionbool IsSoaking ()
functionstring Left (coerce string S, int i)
functionint Len (coerce string S)
functionfloat Lerp (float Alpha, float A, float B, optional bool bClampRange)
functionstring Localize (string SectionName, string KeyName, string PackageName)
functionstring Locs (coerce string S)
function Log (coerce string S, optional name Tag)
functionfloat Loge (float A)
functionint Max (int A, int B)
functionstring Mid (coerce string S, int i, optional int j)
functionint Min (int A, int B)
functionvector MirrorVectorByNormal (vector Vect, vector Normal)
functionvector Normal (vector A)
functionrotator Normalize (rotator Rot)
functionrotator OrthoRotation (vector X, vector Y, vector Z)
functionbool PlatformIs64Bit ()
functionbool PlatformIsMacOS ()
functionbool PlatformIsUnix ()
functionbool PlatformIsWindows ()
functionQuat QuatFindBetween (Vector A, Vector B)
functionQuat QuatFromAxisAndAngle (Vector Axis, Float Angle)
functionQuat QuatFromRotator (rotator A)
functionQuat QuatInvert (Quat A)
functionQuat QuatProduct (Quat A, Quat B)
functionvector QuatRotateVector (Quat A, vector B)
functionQuat QuatSlerp (Quat A, Quat B, float Slerp)
functionrotator QuatToRotator (Quat A)
functionint Rand (int Max)
functionfloat RandRange (float Min, float Max)
functionstring Repl (coerce string Src, coerce string Match, coerce string With, optional bool bCaseSensitive)
function ReplaceText (out string Text, string Replace, string With)
function ResetConfig (optional string PropName)
functionstring Right (coerce string S, int i)
functionrotator RotRand (optional bool bRoll)
functionfloat Round (float A)
function SaveConfig ()
functionbool SetPropertyText (string PropName, string PropValue)
functionfloat Sin (float A)
functionfloat Smerp (float Alpha, float A, float B)
functionint Split (coerce string Src, string Divider, out array<string> Parts)
functionfloat Sqrt (float A)
functionfloat Square (float A)
function StaticClearConfig (optional string PropName)
function StaticSaveConfig ()
function StopWatch (optional bool bStop)
functionint StrCmp (coerce string S, coerce string T, optional int Count, optional bool bCaseSensitive)
functionfloat Tan (float A)
functionvector VRand ()
functionfloat VSize (vector A)
function Warn (coerce string S)
operatorint ^ (int A, int B)
operatorbool ^^ (bool A, bool B)
operatorint | (int A, int B)
operatorbool || (bool A, skip bool B)
preoperatorint ~ (int A)
operatorbool ~= (string A, string B)
operatorbool ~= (float A, float B)


Constants Detail

MaxInt Source code

const MaxInt = 0x7fffffff;
The maximum positive int value

Pi Source code

const Pi = 3.1415926535897932;

RF_NotForClient Source code

const RF_NotForClient = 0x00100000;
ObjectFlag
Don't load for game client.

RF_NotForEdit Source code

const RF_NotForEdit = 0x00400000;
ObjectFlag
Don't load for editor.

RF_NotForServer Source code

const RF_NotForServer = 0x00200000;
ObjectFlag
Don't load for game server.

RF_Public Source code

const RF_Public = 0x00000004;
Object Flag
Can be referenced by external package files

RF_Standalone Source code

const RF_Standalone = 0x00080000;
ObjectFlag
Keep object around for editing even if unreferenced.

RF_Transactional Source code

const RF_Transactional = 0x00000001;
Object flag
Supports editor undo/redo

RF_Transient Source code

const RF_Transient = 0x00004000;
ObjectFlag
Can't be saved or loaded.


Variables Detail

Class Source code

var native const editconst class Class;
The class of this object.

ObjectFlags Source code

var native const int ObjectFlags;

ObjectInternal[7] Source code

var native private const pointer ObjectInternal[7];

Outer Source code

var native const object Outer;

Object

Name Source code

var(Object) native const editconst noexport name Name;
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

EAxis Source code

enum EAxis
{
AXIS_X, AXIS_Y, AXIS_Z
};
Generic axis enum.

ECamOrientation Source code

enum ECamOrientation
{
CAMORIENT_None, CAMORIENT_LookAtActor, CAMORIENT_FacePath, CAMORIENT_Interpolate, CAMORIENT_Dolly,
};
Camera orientations for Matinee

EDetailMode Source code

enum EDetailMode
{
DM_Low, DM_High, DM_SuperHigh
};
Detail mode

EDrawPivot Source code

enum EDrawPivot
{
DP_UpperLeft, DP_UpperMiddle, DP_UpperRight, DP_MiddleRight, DP_LowerRight, DP_LowerMiddle, DP_LowerLeft, DP_MiddleLeft, DP_MiddleMiddle,
};

ESheerAxis Source code

enum ESheerAxis
{
SHEER_None, SHEER_XY, SHEER_XZ, SHEER_YX, SHEER_YZ, SHEER_ZX, SHEER_ZY,
};


Structures Detail

BoundingVolume Source code

struct BoundingVolume extends Box
{
var plane Sphere;
};
A bounding box sphere together.

Box Source code

struct Box
{
var byte IsValid;
var vector Max;
var vector Min;
};
A bounding box.

Color Source code

struct Color
{
var(Object) config byte A;
var(Object) config byte B;
var(Object) config byte G;
var(Object) config byte R;
};
An RGBA color

CompressedPosition Source code

struct CompressedPosition
{
var vector Location;
var rotator Rotation;
var vector Velocity;
};


Coords Source code

struct Coords
{
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.

FloatBox Source code

struct FloatBox
{
var float X1;
var float X2;
var float Y1;
var float Y2;
};


Guid Source code

struct Guid
{
var int A;
var int B;
var int C;
var int D;
};
A globally unique identifier.

IntBox Source code

struct IntBox
{
var int X1;
var int X2;
var int Y1;
var int Y2;
};


InterpCurve Source code

struct InterpCurve
{
var(Object) array<InterpCurvePoint> Points;
};
A struct which holds output values for a set of input values. The array which is formed is used to query for an interpolated output value for any input value.

InterpCurvePoint Source code

struct InterpCurvePoint
{
var(Object) float InVal;
var(Object) float OutVal;
};
A single interpolation point used in the InterpCurve struct. It maps an input value to a particular output value.

Matrix Source code

struct Matrix
{
var(Object) Plane WPlane;
var(Object) Plane XPlane;
var(Object) Plane YPlane;
var(Object) Plane ZPlane;
};
a 4x4 matrix

Plane Source code

struct Plane extends Vector
{
var(Object) config float W;
};
A plane definition in 3d space.

Quat Source code

struct Quat
{
var(Object) config float W;
var(Object) config float X;
var(Object) config float Y;
var(Object) config float Z;
};
A quaternion. Quaternions are a mathematical construct that represents a rotation in three dimensions. It is not as intuitive as the Euler angles that are used for most of the rotation within Unrealscript. A rotator, is a rotation using Euler angles and is the "standard" type of rotation within Unrealscript.

Range Source code

struct Range
{
var(Object) config float Max;
var(Object) config float Min;
};
Used to generate random values between Min and Max

RangeVector Source code

struct RangeVector
{
var(Object) config range X;
var(Object) config range Y;
var(Object) config range Z;
};
Vector of Ranges

Rotator Source code

struct Rotator
{
var(Object) config int Pitch;
var(Object) config int Roll;
var(Object) config int Yaw;
};
An orthogonal rotation in 3d space.

Scale Source code

struct Scale
{
var(Object) config vector Scale;
var(Object) ESheerAxis SheerAxis;
var(Object) config float SheerRate;
};
A scale and sheering.

TMultiMap Source code

struct TMultiMap
{
var int FArray_ArrayMax;
var int FArray_ArrayNum;
var pointer FArray_Data;
var pointer TMapBase_Hash;
var int TMapBase_HashCount;
};


Vector Source code

struct Vector
{
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

native(129) static final preoperator bool ! ( bool A )

!= Source code

native(155) static final operator bool != ( int A, int B )

!= Source code

native(123) static final operator bool != ( string A, string B )

!= Source code

native(203) static final operator bool != ( rotator A, rotator B )

!= Source code

native(181) static final operator bool != ( float A, float B )

!= Source code

native(218) static final operator bool != ( vector A, vector B )

!= Source code

native(243) static final operator bool != ( bool A, bool B )

!= Source code

native(255) static final operator bool != ( name A, name B )

!= Source code

native(119) static final operator bool != ( Object A, Object B )

$ Source code

native(112) static final operator string $ ( coerce string A, coerce string B )

$= Source code

native(322) static final operator string $= ( out string A, coerce string B )

% Source code

native(173) static final operator float % ( float A, float B )

& Source code

native(156) static final operator int & ( int A, int B )

&& Source code

native(130) static final operator bool && ( bool A, skip bool B )

* Source code

native(213) static final operator vector * ( float A, vector B )

* Source code

native(212) static final operator vector * ( vector A, float B )

* Source code

native(171) static final operator float * ( float A, float B )

* Source code

native(288) static final operator rotator * ( float A, rotator B )

* Source code

native(287) static final operator rotator * ( rotator A, float B )

* Source code

native(144) static final operator int * ( int A, int B )

* Source code

native(296) static final operator vector * ( vector A, vector B )

** Source code

native(170) static final operator float ** ( float A, float B )

*= Source code

native(159) static final operator int *= ( out int A, float B )

*= Source code

native(297) static final operator vector *= ( out vector A, vector B )

*= Source code

native(290) static final operator rotator *= ( out rotator A, float B )

*= Source code

native(182) static final operator float *= ( out float A, float B )

*= Source code

native(221) static final operator vector *= ( out vector A, float B )

*= Source code

native(133) static final operator byte *= ( out byte A, byte B )

+ Source code

native(146) static final operator int + ( int A, int B )

+ Source code

native(316) static final operator rotator + ( rotator A, rotator B )

+ Source code

native(174) static final operator float + ( float A, float B )

+ Source code

native(215) static final operator vector + ( vector A, vector B )

++ Source code

native(163) static final preoperator int ++ ( out int A )

++ Source code

native(165) static final postoperator int ++ ( out int A )

++ Source code

native(139) static final postoperator byte ++ ( out byte A )

++ Source code

native(137) static final preoperator byte ++ ( out byte A )

+= Source code

native(184) static final operator float += ( out float A, float B )

+= Source code

native(318) static final operator rotator += ( out rotator A, rotator B )

+= Source code

native(135) static final operator byte += ( out byte A, byte B )

+= Source code

native(161) static final operator int += ( out int A, int B )

+= Source code

native(223) static final operator vector += ( out vector A, vector B )

- Source code

native(175) static final operator float - ( float A, float B )

- Source code

native(169) static final preoperator float - ( float A )

- Source code

native(211) static final preoperator vector - ( vector A )

- Source code

native(317) static final operator rotator - ( rotator A, rotator B )

- Source code

native(143) static final preoperator int - ( int A )

- Source code

native(216) static final operator vector - ( vector A, vector B )

- Source code

native(147) static final operator int - ( int A, int B )

-- Source code

native(140) static final postoperator byte -- ( out byte A )

-- Source code

native(166) static final postoperator int -- ( out int A )

-- Source code

native(164) static final preoperator int -- ( out int A )

-- Source code

native(138) static final preoperator byte -- ( out byte A )

-= Source code

native(319) static final operator rotator -= ( out rotator A, rotator B )

-= Source code

native(224) static final operator vector -= ( out vector A, vector B )

-= Source code

native(162) static final operator int -= ( out int A, int B )

-= Source code

native(324) static final operator string -= ( out string A, coerce string B )

-= Source code

native(185) static final operator float -= ( out float A, float B )

-= Source code

native(136) static final operator byte -= ( out byte A, byte B )

/ Source code

native(289) static final operator rotator / ( rotator A, float B )

/ Source code

native(214) static final operator vector / ( vector A, float B )

/ Source code

native(145) static final operator int / ( int A, int B )

/ Source code

native(172) static final operator float / ( float A, float B )

/= Source code

native(291) static final operator rotator /= ( out rotator A, float B )

/= Source code

native(160) static final operator int /= ( out int A, float B )

/= Source code

native(222) static final operator vector /= ( out vector A, float B )

/= Source code

native(183) static final operator float /= ( out float A, float B )

/= Source code

native(134) static final operator byte /= ( out byte A, byte B )

< Source code

native(176) static final operator bool < ( float A, float B )

< Source code

native(150) static final operator bool < ( int A, int B )

< Source code

native(115) static final operator bool < ( string A, string B )

<< Source code

native(148) static final operator int << ( int A, int B )

<< Source code

native(275) static final operator vector << ( vector A, rotator B )

<= Source code

native(178) static final operator bool <= ( float A, float B )

<= Source code

native(152) static final operator bool <= ( int A, int B )

<= Source code

native(120) static final operator bool <= ( string A, string B )

== Source code

native(142) static final operator bool == ( rotator A, rotator B )

== Source code

native(122) static final operator bool == ( string A, string B )

== Source code

native(180) static final operator bool == ( float A, float B )

== Source code

native(217) static final operator bool == ( vector A, vector B )

== Source code

native(254) static final operator bool == ( name A, name B )

== Source code

native(242) static final operator bool == ( bool A, bool B )

== Source code

native(154) static final operator bool == ( int A, int B )

== Source code

native(114) static final operator bool == ( Object A, Object B )

> Source code

native(177) static final operator bool > ( float A, float B )

> Source code

native(151) static final operator bool > ( int A, int B )

> Source code

native(116) static final operator bool > ( string A, string B )

>= Source code

native(179) static final operator bool >= ( float A, float B )

>= Source code

native(121) static final operator bool >= ( string A, string B )

>= Source code

native(153) static final operator bool >= ( int A, int B )

>> Source code

native(149) static final operator int >> ( int A, int B )

>> Source code

native(276) static final operator vector >> ( vector A, rotator B )

>>> Source code

native(196) static final operator int >>> ( int A, int B )

@ Source code

native(168) static final operator string @ ( coerce string A, coerce string B )

@= Source code

native(323) static final operator string @= ( out string A, coerce string B )

Abs Source code

native(186) static final function float Abs ( float A )
Returns the absolute value (also known as the modulo) of A, usually written |A|. Eg: Abs(5)== Abs(-5) == 5.

Acos Source code

native static final function float Acos ( float A )
Inverse cosine.

AllObjects Source code

native(197) final iterator function AllObjects ( class baseClass, out Object obj )

Asc Source code

native(237) static final function int Asc ( string S )
Returns the ASCII code of the first character in S.

Asin Source code

native static final function float Asin ( float A )
Inverse sine.

Atan Source code

native(190) static final function float Atan ( float A, float B )

BeginState Source code

event BeginState ( )
Called immediately when entering a state, while within the GotoState call that caused the state change.

Caps Source code

native(235) static final function string Caps ( coerce string S )
Returns S converted to uppercase.

Ceil Source code

native(253) static final function float Ceil ( float A )
Returns A rounded off to the next higher whole number, e.g. Ceil(1.8) returns 2, Ceil(-1.8) returns -1, etc. Ceil will always round up while typecasting float to int rounds up for negative numbers and down for positive numbers, i.e. int casts simply discard everything after the decimal point.

Chr Source code

native(236) static final function string Chr ( int i )
Returns the character matchin the given ASCII code.

Clamp Source code

native(251) static final function int Clamp ( int V, int A, int B )
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.

ClassIsChildOf Source code

native(258) static final function bool ClassIsChildOf ( class TestClass, class ParentClass )
Returns whether TestClass is a subclass of Parentclass. If the two classes are the same it returns true.

ClearConfig Source code

native(537) final function ClearConfig ( optional string PropName )
Remove this object's section from the appropriate .ini file, and reload the script defaults for this object. If PropertyName is specified, only remove and reload that property, if found.

ClockwiseFrom Source code

native static final operator bool ClockwiseFrom ( int A, int B )

Cos Source code

native(188) static final function float Cos ( float A )
Returns cosine( A )

Created Source code

event Created ( )
Notifiction for object based classes only (not actors)

Cross Source code

native(220) static final operator vector Cross ( vector A, vector B )

Disable Source code

native(118) final function Disable ( name ProbeFunc )
Disables a probe function.

Divide Source code

native(239) static final function bool Divide ( coerce string Src, string Divider, out string LeftPart, out string RightPart )
Divides a string and returns the two parts.

Dot Source code

native(219) static final operator float Dot ( vector A, vector B )

DynamicLoadObject Source code

native static final function object DynamicLoadObject ( string ObjectName, class ObjectClass, optional bool MayFail )
Returns a reference to a specified object, loading it if necessary.

EatStr Source code

static final function EatStr ( out string Dest, out string Source, int Num )
Moves Num elements from Source to Dest

Enable Source code

native(117) final function Enable ( name ProbeFunc )
Enables a probe function.

EndState Source code

event EndState ( )
Called immediately before going out of the current state, while within the GotoState call that caused the state change.

Eval Source code

native(202) static final function string Eval ( bool Condition, coerce string ResultIfTrue, coerce string ResultIfFalse )
Given boolean expression Condition, return string ResultIfTrue if the expression evaluates to true, otherwise return ResultIfFalse.

Exp Source code

native(191) static final function float Exp ( float A )

FClamp Source code

native(246) static final function float FClamp ( float V, float A, float B )
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.

FindObject Source code

native static final function object FindObject ( string ObjectName, class ObjectClass )

FMax Source code

native(245) static final function float FMax ( float A, float B )
Returns the higher of the two values.

FMin Source code

native(244) static final function float FMin ( float A, float B )
Returns the lower of the two values.

FRand Source code

native(195) static final function float FRand ( )
Returns a random number between 0 and 1.

GetAxes Source code

native(229) static final function GetAxes ( rotator A, out vector X, out vector Y, out vector Z )

GetEnum Source code

native static final function name GetEnum ( object E, coerce int i )
Returns the i-th element of the given enumeration, as in GetEnum(enum'MyEnum', 2) or an empty name of the specified index exceeds the number of elements in the enumeration.

GetItemName Source code

simulated static function String GetItemName ( string FullName )
Returns the string representation of the name of an object without the package prefixes.

GetPerObjectNames Source code

native static final function array<string> GetPerObjectNames ( string ININame, optional string ObjectClass, optional int MaxResults )
Returns all section names that exist in the .ini file specified by ININame which correspond to PerObjectConfig classes.

GetPropertyText Source code

native final function string GetPropertyText ( string PropName )
Returns the value of the specified property typecasted to string. It is not possible to access default properties in this manner. This is useful when you don't want any dependencies to the package of an object, but still need to access its public (i.e. neither private nor protected) properties.
Usage: aString=anObject.GetPropertyText("PropertyName");

GetReferencers Source code

native final function GetReferencers ( Object Target, out array<Object> Referencers )
Returns a list of objects referencing the specified target object. Useful for debugging garbage collection problems.

GetStateName Source code

native(284) final function name GetStateName ( )
Returns the object's current state name.

GetUnAxes Source code

native(230) static final function GetUnAxes ( rotator A, out vector X, out vector Y, out vector Z )

GotoState Source code

native(113) final function GotoState ( optional name NewState, optional name Label )
Switches to a new state. State code execution begins at the specified label or at "Begin:" if Label is not specified.
Before the state is changed the old state's EndState function is called. After the state changed BeginState of the new state is called.

InStr Source code

native(126) static final function int InStr ( coerce string S, coerce string t )
If 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.

InterpCurveEval Source code

native static final function float InterpCurveEval ( InterpCurve curve, float input )

InterpCurveGetInputDomain Source code

native static final function InterpCurveGetInputDomain ( InterpCurve curve, out float min, out float max )

InterpCurveGetOutputRange Source code

native static final function InterpCurveGetOutputRange ( InterpCurve curve, out float min, out float max )

Invert Source code

native(227) static final function Invert ( out vector X, out vector Y, out vector Z )

IsA Source code

native(303) final function 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.

IsInState Source code

native(281) final function bool IsInState ( name TestState )
Returns whether the object's current state is the one specified.

IsOnConsole Source code

native final function bool IsOnConsole ( )
For console specific stuff. "Console" in this case refers to a game console. Not the console dropped down and typed into.

IsSoaking Source code

native final function bool IsSoaking ( )
For console specific stuff.

Left Source code

native(128) static final function string Left ( coerce string S, int i )
Returns the i leftmost characters of S.

Len Source code

native(125) static final function int Len ( coerce string S )
Returns the length of a string.

Lerp Source code

native(247) static final function float Lerp ( float Alpha, float A, float B, optional bool bClampRange )
Returns the linear interpolation between A and B.
The return value is calculated through something like this: (B - A) * Alpha + A

Localize Source code

native static function string Localize ( string SectionName, string KeyName, string PackageName )
Returns the string found in PackageName.int in the [SectionName] section. Logs an error if no localization for the specified string is found.

Locs Source code

native(238) static final function string Locs ( coerce string S )
Returns S converted to lowercase.

Log Source code

native(231) final static function Log ( coerce string S, optional name Tag )
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 Commandlets.

Loge Source code

native(192) static final function float Loge ( float A )
Returns log(A), the natural logarithm

Max Source code

native(250) static final function int Max ( int A, int B )
Returns the higher of the two values.

Mid Source code

native(127) static final function string Mid ( coerce string S, int i, optional int j )
Returns the middle part of S, starting at character i and including j characters (or all of them if j is not specified). Note: the 1st char has the number 0, this is diffrent then in visual basic, where the 1st char is 1.

Min Source code

native(249) static final function int Min ( int A, int B )
Returns the lower of the two values.

MirrorVectorByNormal Source code

native(300) static final function vector MirrorVectorByNormal ( vector Vect, vector Normal )

Normal Source code

native(226) static final function vector Normal ( vector A )

Normalize Source code

native static final function rotator Normalize ( rotator Rot )

OrthoRotation Source code

native static final function rotator OrthoRotation ( vector X, vector Y, vector Z )

PlatformIs64Bit Source code

native final function bool PlatformIs64Bit ( )

PlatformIsMacOS Source code

native final function bool PlatformIsMacOS ( )

PlatformIsUnix Source code

native final function bool PlatformIsUnix ( )

PlatformIsWindows Source code

native final function bool PlatformIsWindows ( )

QuatFindBetween Source code

native static final function Quat QuatFindBetween ( Vector A, Vector B )

QuatFromAxisAndAngle Source code

native static final function Quat QuatFromAxisAndAngle ( Vector Axis, Float Angle )

QuatFromRotator Source code

native static final function Quat QuatFromRotator ( rotator A )

QuatInvert Source code

native static final function Quat QuatInvert ( Quat A )

QuatProduct Source code

native static final function Quat QuatProduct ( Quat A, Quat B )

QuatRotateVector Source code

native static final function vector QuatRotateVector ( Quat A, vector B )

QuatSlerp Source code

native static final function Quat QuatSlerp ( Quat A, Quat B, float Slerp )

QuatToRotator Source code

native static final function rotator QuatToRotator ( Quat A )

Rand Source code

native(167) static final function int Rand ( int Max )
Returns a random number ranging from 0 to Max-1.

RandRange Source code

final function float RandRange ( float Min, float Max )
Return a random number within the given range.

Repl Source code

native(201) static final function string Repl ( coerce string Src, coerce string Match, coerce string With, optional bool bCaseSensitive )
Replaces all occurances of Match in string Src. Specify true for bCaseSensitive if matching should be case-sensitive.

ReplaceText Source code

simulated static final function ReplaceText ( out string Text, string Replace, string With )
Like Repl, but modifies the input string variable directly and is always case-sensitive.

ResetConfig Source code

native static final function ResetConfig ( optional string PropName )
Resets the config and globalconfig variables of this object's class to the values stored in Default.ini or DefUser.ini.

Right Source code

native(234) static final function string Right ( coerce string S, int i )
Returns the i rightmost characters of S.

RotRand Source code

native(320) static final function rotator RotRand ( optional bool bRoll )

Round Source code

native(257) static final function float Round ( float A )
Returns A rounded off to the nearest whole number, e.g. pass 1.05 and it returns 1.00, 5.5 will return 6.0 etc.

SaveConfig Source code

native(536) final function 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.

SetPropertyText Source code

native final function bool SetPropertyText ( string PropName, string PropValue )
Assigns 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

native(187) static final function float Sin ( float A )
Returns sine( A )

Smerp Source code

native(248) static final function float Smerp ( float Alpha, float A, float B )
Returns 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

Split Source code

native(240) static final function int Split ( coerce string Src, string Divider, out array<string> Parts )
Splits a string iat the specified divider and returns the parts as a dynamic array of strings. If the input string starts with the given divider, the first element of the output array will be empty.

Sqrt Source code

native(193) static final function float Sqrt ( float A )
Returns the square root of A.

Square Source code

native(194) static final function float Square ( float A )

StaticClearConfig Source code

native static final function StaticClearConfig ( optional string PropName )
Static version of ClearConfig().

StaticSaveConfig Source code

native static final function StaticSaveConfig ( )
Saves the default values of config and globalconfig variables of this object's class to the ini file.

StopWatch Source code

native(535) static final function StopWatch ( optional bool bStop )
For script timing. Have done some testing, having StopWatch called on Tick() with different values for bStop. bStop=False seems to do nothing, not showing any HUD messages, output to stdout/err, or to logfile. First call with bStop=True prints text "UNICODE str: Time=%lf ms" to output, logs "Log: Unknown percent in UnUnix.cpp::wvsnprintf().", and crashes, whether there have been zero, one, or many previous calls with bStop=False. So far, none of this looks useful, but perhaps it needs to be used in a different context to work properly - on dedicated server, or in an Actor (my test was in an Interaction, in an "Instant Action" game).
StopWatch( false ); starts the stopwatch. StopWatch( true ); disables and resets the timer. When you stop the timer, a line will be printed in the log stating something like: Time=41.768ms. This is the time that the stopwatch was at when it was stopped. This makes it appear to be very much like clock.. but the log statement that shows the stop time is not what you can really do with StopWatch.
The magic of stopwatch is that when it is running it timestamps log entries. Each is stamped with the time elapsed since the timer was started. It is great for finding out the time taken throughout a function, without writing a veritable pile of clock and unclock statements, as well as adding temporary variables for them, and the works!

StrCmp Source code

native(200) static final function int StrCmp ( coerce string S, coerce string T, optional int Count, optional bool bCaseSensitive )

Tan Source code

native(189) static final function float Tan ( float A )
Returns tan( A )

VRand Source code

native(252) static final function vector VRand ( )

VSize Source code

native(225) static final function float VSize ( vector A )

Warn Source code

native(232) final static function Warn ( coerce string S )
Same like Log, but the line starts with "ScriptWarning:" and contains information about the object, state and function that called Warn.

^ Source code

native(157) static final operator int ^ ( int A, int B )

^^ Source code

native(131) static final operator bool ^^ ( bool A, bool B )

| Source code

native(158) static final operator int | ( int A, int B )

|| Source code

native(132) static final operator bool || ( bool A, skip bool B )

~ Source code

native(141) static final preoperator int ~ ( int A )

~= Source code

native(124) static final operator bool ~= ( string A, string B )

~= Source code

native(210) static final operator bool ~= ( float A, float B )


Defaultproperties

defaultproperties
{
}

Overview Package Class Source Class tree Glossary
previous class      next class frames      no frames
Creation time: Wed 7/2/2007 19:16:07.671 - Created with UnCodeX