The three virtues of a programmer: Laziness, Impatience, and Hubris. – Larry Wall

UE1:Object (UT)

From Unreal Wiki, The Unreal Engine Documentation Site

Jump to: navigation, search
UT Object

Contents

Package: 
Core
Direct subclasses:
Actor, Bitmap, BrushBuilder, Canvas, Commandlet, Console, Font, LevelSummary, ListItem, Locale, Music, Palette, Player, Primitive, RenderIterator, Sound, Subsystem, TestObj, Time, UTExtraKeyBindings, UWindowBase, WebApplication, WebRequest, WebResponse
Known custom subclass:
Wormbo/SlowVacuumZone
This class in other games:
RTNP, U1, U2, U2XMP, UDK, UE2Runtime, UT2003, UT2004, UT3

The base class of the entire UnrealScript class hierarchy.

[edit] Constants

[edit] RF_Transactional

Value: 0x00000001

Supports editor undo/redo.

[edit] RF_Public

Value: 0x00000004

Can be referenced by external package files.

[edit] RF_Transient

Value: 0x00004000

Can't be saved or loaded.

[edit] RF_NotForClient

Value: 0x00100000

Don't load for game client.

[edit] RF_NotForServer

Value: 0x00200000

Don't load for game server.

[edit] RF_NotForEdit

Value: 0x00400000

Don't load for editor.

[edit] MaxInt

Value: 0x7fffffff

Maximum possible int value. ~MaxInt is the minimum possible int value.

[edit] Pi

Value: 3.1415926535897932

The approximate value of the mathematical constant π. (Pi)

[edit] Properties

[edit] Property group 'Object'

[edit] Class

Type: Class

Modifiers: native, const, editconst

This object's class.

[edit] Name

Type: name

Modifiers: native, const, editconst

This object's name.

[edit] Internal variables

[edit] ObjectFlags

Type: int

Modifiers: native, const

This object's internal flags. This value is mostly constructed from the RF_* constants above.

[edit] ObjectInternal

Type: int

Array size: 6

Modifiers: native, private, const

This array covers several native properties, which should not be available to UnrealScript.

[edit] Outer

Type: Object

Modifiers: native, const

The object containing this object.

[edit] Enums

[edit] ESheerAxis

SHEER_None
SHEER_XY
SHEER_XZ
SHEER_YX
SHEER_YZ
SHEER_ZX
SHEER_ZY

[edit] Structs

See Object structs.

[edit] Functions

[edit] Static native functions

See Object static native functions.

[edit] Native functions

[edit] Disable

native(118) final function Disable (name ProbeFunc)

Disables a probe function.

[edit] Enable

native(117) final function Enable (name ProbeFunc)

Enables a probe function.

[edit] GetPropertyText

native final function string GetPropertyText (string PropName)

Returns the string representation of a property with the specified name. This may not work correctly for array properties.

[edit] GetStateName

native(284) final function name GetStateName ()

Returns this object's current state name. Note that states are only really supported in Actor and Console subclasses.

[edit] GotoState

native(113) final function GotoState (optional name NewState, optional name Label)

Changes to the state with the specified name, starting execution of state code at the specified label.

[edit] IsA

native(303) final function bool IsA (name ClassName)

Returns whether the object's class or any of its parent classes has the specified name.

[edit] IsInState

native(281) final function bool IsInState (name TestState)

Returns whether the object's current state or any of its parent states has the specified name.

[edit] RandRange

native(1033) final function float RandRange (float Min, float Max)

Returns a random number in the specified range.

[edit] SaveConfig

native(536) final function SaveConfig ()

Saves the current values of this object's config and globalconfig properties to the corresponding INI file.

[edit] SetPropertyText

native final function SetPropertyText (string PropName, string PropValue)

Converts and assigns the specified value to the property with the specified name. This may not work correctly for array properties.

[edit] Events

[edit] BeginState

event BeginState ()

Called from within GotoState() right after the state was changed.

[edit] EndState

event EndState ()

Called from within GotoState() right before the state is changed.

[edit] Operators

See Object operators.

Personal tools