Engine.Actor

Extends

Object

Modifiers

abstract intrinsic

Core.Object
|   
+-- Engine.Actor

Direct Known Subclasses:

Brush, DamageType, Decoration, Effects, HUD, Info, Inventory, Keypoint, Light, Menu, NavigationPoint, Pawn, Projectile, ScoreBoard, Triggers

Functions Summary
	bool	!= (vector A, vector B)
	bool	!= (rotator A, rotator B)
	rotator	* (rotator A, float B)
	rotator	* (float A, rotator B)
	vector	* (vector A, vector B)
	vector	* (float A, vector B)
	vector	* (vector A, float B)
	vector	*= (out vector A, float B)
	rotator	*= (out rotator A, float B)
	vector	*= (out vector A, vector B)
	vector	+ (vector A, vector B)
	rotator	+ (rotator A, rotator B)
	vector	+= (out vector A, vector B)
	rotator	+= (out rotator A, rotator B)
	vector	- (vector A)
	vector	- (vector A, vector B)
	rotator	- (rotator A, rotator B)
	rotator	-= (out rotator A, rotator B)
	vector	-= (out vector A, vector B)
	rotator	/ (rotator A, float B)
	vector	/ (vector A, float B)
	vector	/= (out vector A, float B)
	rotator	/= (out rotator A, float B)
	vector	<< (vector A, rotator B)
	bool	== (vector A, vector B)
	bool	== (rotator A, rotator B)
	vector	>> (vector A, rotator B)
		AllActors (class<actor> BaseClass, out actor Actor, optional name MatchTag)
		AnimEnd ()
		Attach (Actor Other)
		BaseChange ()
		BasedActors (class<actor> BaseClass, out actor Actor)
		BeginEvent ()
		BeginPlay ()
		BroadcastMessage (coerce string[240] Msg, bool bBeep)
		Bump (Actor Other)
		ChildActors (class<actor> BaseClass, out actor Actor)
	vector	Cross (vector A, vector B)
	bool	Destroy ()
		Destroyed ()
		Detach (Actor Other)
	float	Dot (vector A, vector B)
		EncroachedBy (actor Other)
	bool	EncroachingOn (actor Other)
		EndedRotation ()
		EndEvent ()
		Error (coerce string[255] S)
		Expired ()
		Falling ()
		FinishAnim ()
		FinishInterpolation ()
		GainedChild (Actor Other)
	name	GetAnimGroup (name Sequence)
		GetAxes (rotator A, out vector X, out vector Y, out vector Z)
		GetUnAxes (rotator A, out vector X, out vector Y, out vector Z)
		HitWall (vector HitNormal, actor HitWall)
		HurtRadius (float DamageAmount, float DamageRadius, name DamageName, float Momentum, vector HitLocation)
		InterpolateEnd (actor Other)
		Invert (out vector X, out vector Y, out vector Z)
	bool	IsA (name ClassName)
	bool	IsAnimating ()
		KillCredit (Actor Other)
		KilledBy (pawn EventInstigator)
		Landed (vector HitNormal)
		LoopAnim (name Sequence, optional float Rate, optional float TweenTime, optional float MinRate)
		LostChild (Actor Other)
		MakeNoise (float Loudness)
	vector	MirrorVectorByNormal (vector Vect, vector Normal)
	bool	Move (vector Delta)
	bool	MoveSmooth (vector Delta)
	vector	Normal (vector A)
		PlayAnim (name Sequence, optional float Rate, optional float TweenTime)
	bool	PlayerCanSeeMe ()
		PlaySound (sound Sound, optional ESoundSlot Slot, optional float Volume, optional bool bNoOverride, optional float Radius, optional float Pitch)
		PostBeginPlay ()
		PostTeleport (Teleporter OutTeleporter)
		PreBeginPlay ()
	bool	PreTeleport (Teleporter InTeleporter)
		RadiusActors (class<actor> BaseClass, out actor Actor, float Radius, optional vector Loc)
	rotator	RotRand (optional bool bRoll)
		SetBase (actor NewBase)
		SetCollision (optional bool NewColActors, optional bool NewBlockActors, optional bool NewBlockPlayers)
	bool	SetCollisionSize (float NewRadius, float NewHeight)
		SetInitialState ()
	bool	SetLocation (vector NewLocation)
		SetOwner (actor NewOwner)
		SetPhysics (EPhysics newPhysics)
	bool	SetRotation (rotator NewRotation)
		SetTimer (float NewTimerRate, bool bLoop)
		Sleep (float Seconds)
	actor	Spawn (class SpawnClass, optional actor SpawnOwner, optional name SpawnTag, optional vector SpawnLocation, optional rotator SpawnRotation)
		Spawned ()
	Actor	SpecialHandling (Pawn Other)
		TakeDamage (int Damage, Pawn EventInstigator, vector HitLocation, vector Momentum, name DamageType)
		Tick (float DeltaTime)
		Timer ()
		Touch (Actor Other)
		TouchingActors (class<actor> BaseClass, out actor Actor)
	Actor	Trace (out vector HitLocation, out vector HitNormal, vector TraceEnd, optional vector TraceStart, optional bool bTraceActors, optional vector Extent)
		TraceActors (class<actor> BaseClass, out actor Actor, out vector HitLoc, out vector HitNorm, vector End, optional vector Start, optional vector Extent)
		TravelPostAccept ()
		TravelPreAccept ()
		Trigger (Actor Other, Pawn EventInstigator)
		TweenAnim (name Sequence, float Time)
		UnTouch (Actor Other)
		UnTrigger (Actor Other, Pawn EventInstigator)
		VisibleActors (class<actor> BaseClass, out actor Actor, optional float Radius, optional vector Loc)
		VisibleCollidingActors (class<actor> BaseClass, out actor Actor, optional float Radius, optional vector Loc)
	vector	VRand ()
	float	VSize (vector A)
		ZoneChange (ZoneInfo NewZone)
	string	[ (] GetNextSkin( string[64] Prefix, string[64] CurrentSkin, int Dir)
	string	[ (] GetMapName( string[32] NameEnding, string[32] MapName, int Dir)

Acceleration Source code

AnimLast Source code

AnimMinRate Source code

bAlwaysTick Source code

Update even when players-only.

bAnimFinished Source code

bAnimLoop Source code

bAnimNotify Source code

Base Source code

Actor we're standing on.

bAssimilated Source code

bDeleteMe Source code

About to be deleted.

bDynamicLight Source code

This light is dynamic.

bEdLocked Source code

bEdSnap Source code

Should snap to grid in UnrealEd.

bHighlighted Source code

bHurtEntry Source code

Keep HurtRadius from being reentrant,

bInterpolating Source code

Performing interpolating.

bIsMover Source code

bIsPawn Source code

bJustTeleported Source code

Used by engine physics - not valid for scripts.

bLightChanged Source code

Recalculate this light's lighting now.

bMemorized Source code

bNetFeel Source code

bNetHear Source code

bNetInitial Source code

Initial network update.

bNetOptional Source code

bNetOwner Source code

Player owns this actor.

bNetSee Source code

Brush Source code

Brush if DrawType=DT_Brush.

bSelected Source code

Selected in UnrealEd.

bSimulatedPawn Source code

bTempEditor Source code

bTicked Source code

Actor has been updated.

bTimerLoop Source code

Timer loops (else is one-shot).

CollisionTag Source code

ColLocation Source code

Actor's old location one move ago. Only for debugging.

Deleted Source code

Next actor in just-deleted chain.

DodgeDir Source code

ExtraTag Source code

Instigator Source code

Pawn responsible for damage caused by this actor.

Inventory Source code

Inventory chain.

LatentActor Source code

LatentByte Source code

LatentFloat Source code

Internal latent function use.

LatentInt Source code

Level Source code

Level this actor is on.

LightingTag Source code

MiscNumber Source code

NetTag Source code

OldAnimRate Source code

OldLocation Source code

OtherTag Source code

Owner Source code

Owner actor.

PhysAlpha Source code

PhysRate Source code

PrePivot Source code

Offset from box center for drawing.

Region Source code

Region this actor is in.

Role Source code

SimAnim Source code

Only replicated if bReplicateAnimations is true

SpecialTag Source code

StandingCount Source code

Target Source code

TimerCounter Source code

Counts up until it reaches TimerRate.

TimerRate Source code

Timer event, 0=no timer.

Touching[4] Source code

TweenRate Source code

XLevel Source code

Level object.

Advanced

bAlwaysRelevant Source code

Always relevant for network.

bCanTeleport Source code

This actor can be teleported. This property must be True for Teleporters to notice the actor.

bCollideWhenPlacing Source code

The actor will collide with world geometry when placed.

bDirectional Source code

Whether the editor should display an arrow to show the actor's current rotation. This has no effect in the game.

bEdShouldSnap Source code

Snap to grid in the editor.

bForceStasis Source code

bHidden Source code

Specifies, whether the actor is invisible in the game. This property has no effect in the editor.

bHiddenEd Source code

The actor is hidden in the editor. This has no effect in the game.

bHighDetail Source code

The actor only shows up in high or super high detail mode.

bIsItemGoal Source code

bIsKillGoal Source code

bIsSecretGoal Source code

bMovable Source code

Actor can be moved.

bNoDelete Source code

Specifies, that the actor can't be spawned or destroyed during the game.

bOnlyOwnerSee Source code

Only owner can see this actor.

bStasis Source code

In standalone (i.e. single player, e.g. Instant Action) games this actor should be turned off if it's not in a recently rendered zone. It will only be turned off when its Physics mode is PHYS_None or PHYS_Rotating.

bStatic Source code

Does not move or change over time. Don't let L.D.s change this - screws up net play.

bTravel Source code

Actor is capable of travelling among servers.

LifeSpan Source code

Specifies how long the actor will exist. This value is constantly decreased and the actor will be destroyed when it reaches 0. In this case the actor's Expired method is executed. An initial LifeSpan of 0 or explicitely setting the LifeSpan to 0 from UnrealScript disables the actor's "destruction timer". Setting it to a value greater 0 from UnrealScript enables it and the Actor will be destroyed after that time unless LifeSpan is set to 0 again before it expired.

Collision

bBlockActors Source code

Blocks other nonplayer actors.

bBlockPlayers Source code

OBSOLETE - no longer used

bCollideActors Source code

Collides with other actors.

bCollideWorld Source code

Collides with the world.

bProjTarget Source code

Projectiles should potentially target this actor.

CollisionHeight Source code

Half-height cyllinder.

CollisionRadius Source code

Radius of collision cyllinder.

Display

AmbientGlow Source code

Ambient brightness, or 255=pulsing.

AnimFrame Source code

AnimRate Source code

AnimSequence Source code

bMeshCurvy Source code

bMeshEnviroMap Source code

bNoSmooth Source code

bParticles Source code

bShadowCast Source code

Casts static shadows.

bUnlit Source code

Lights don't affect actor.

DrawScale Source code

Scaling factor, 1.0=normal size.

DrawType Source code

Fatness Source code

Mesh Source code

Mesh if DrawType=DT_Mesh.

ScaleGlow Source code

Skin Source code

Sprite Source code

Style Source code

Style for rendering sprites, meshes.

Texture Source code

Sprite texture. If DrawType=DT_Sprite

Events

Event Source code

The event this actor causes.

Tag Source code

Actor's tag name.

Filter

bDifficulty0 Source code

bDifficulty1 Source code

bDifficulty2 Source code

bDifficulty3 Source code

bNet Source code

bNetSpecial Source code

bSinglePlayer Source code

OddsOfAppearing Source code

LightColor

LightBrightness Source code

LightHue Source code

LightSaturation Source code

Lighting

bActorShadows Source code

Light casts actor shadows.

bCorona Source code

Light uses Skin as a corona.

bLensFlare Source code

bSpecialLit Source code

Only affects special-lit surfaces.

LightCone Source code

LightEffect Source code

LightPeriod Source code

LightPhase Source code

LightRadius Source code

LightType Source code

VolumeBrightness Source code

VolumeFog Source code

VolumeRadius Source code

Movement

bBounce Source code

Bounces when hits ground fast.

bFixedRotationDir Source code

Fixed direction of rotation.

bRotateToDesired Source code

Rotate to DesiredRotation.

Buoyancy Source code

Water buoyancy.

DesiredRotation Source code

Physics will smoothly rotate actor to this rotation if bRotateToDesired.

Location Source code

Actor's location; use Move to set.

Mass Source code

Mass of this actor.

Physics Source code

Rotation Source code

RotationRate Source code

Change in rotation per second.

Velocity Source code

Networking

NetPriority Source code

Higher priorities means update it more frequently.

RemoteRole Source code

Object

Group Source code

InitialState Source code

Sound

AmbientSound Source code

Ambient sound effect.

SoundPitch Source code

Sound pitch shift, 64.0=none.

SoundRadius Source code

Radius of ambient sound.

SoundVolume Source code

Volume of ambient sound.

TransientSoundVolume Source code

Default sound volume for regular sounds (can be overridden in playsound).

EDodgeDir Source code

EDrawType Source code

The DrawType enumneration sets how the actor displays. Some of these options work with another property to set what is displayed.

DT_None

The actor isn't displayed at all. bHidden instead in most cases because it will allow the actor to still show up in UnrealEd.

DT_Sprite

Display a sprite with the material set in the Texture property.

DT_Mesh

Display the mesh set in the Mesh property.

DT_Brush

Only for Brush classes.

DT_RopeSprite

DT_VerticalSprite

DT_Terraform

DT_SpriteAnimOnce

Like DT_Sprite, but plays an animated texture's animation at a speed that plays the animation exactly once during the LifeSpan of the actor.

DT_StaticMesh

Display the static mesh set in the StaticMesh property.

DT_DrawType

DT_Particle

Used by particle effect actors (Emitter, xEmitter, xWeatherEffect) and xProcMeshes.

DT_AntiPortal

Used for Antiportals.

DT_FluidSurface

Used by FluidSurfaceInfos. See Fluid Surfaces.

EInputAction Source code

EInputKey Source code

ELightEffect Source code

Spatial light effect to use.

ELightType Source code

Light modulation.

EMusicTransition Source code

Music transitions.

ENetRole Source code

Net variables.

ROLE_None

This means that none of the actor's attributes will not be replicated at all. Examples for this kind of actors are the GameInfo, Mutators and GameRules as well as some explosion effects and decals in UT. Note that Actor's with this role can still be instantiated on network game clients if spawned from the right function. For example if an Actor with ROLE_None is instantiated from a simulated event PostBeginPlay() function it will be created on both the server and the client as this function is invoked on both. However the server-side Actor and the client-side Actor are two completely independant entities. This means that destroying the actor on the server will not destroy the actor on the client (and vice-versa).

ROLE_DumbProxy

The actor is replicated, but can't execute any functions on the remote side. It will update when variables are replicated to it but will not attempt to interpolate.

ROLE_SimulatedProxy

The actor is replicated and may execute simulated functions and simulated state code on the remote side. Often this kind of actor simulates its behavior based on initially replicated properties without (much) further "help" from the server.

ROLE_AutonomousProxy

Autonomous proxies come with some more magic built-in. They are basically simulated proxies, but may execute simulated and non-simulated functions on the client owning/controlling this actor (only on that client!). In UT only PlayerPawns are autonomous proxies, in UT2003 only PlayerControllers are. Every other client sees them as a regular simulated proxy. Player-controlled actors, such as the guided redeemer missile (GuidedWarshell in UT or RedeemerWarhead in UT2003) are autonomous proxies on the controlling player's client, too.

ROLE_Authority

All functions can be executed. This role is only allowed on the machine the actor was spawned on. All actors on the server or in standalone games have Role== ROLE_Authority. Never manually set the RemoteRole on the authorative version of an actor or the Role on a replicated version of the actor to this value.

EPhysics Source code

Actor's PhysicsType is set in the Physics property. Use the SetPhysics() method to change.

PHYS_CinMotion

(new in UT2003)

PHYS_Falling

Automatically applies the gravity of the current zone. Pawn-set acceleration in the Z direction is ignored.

PHYS_Flying

The Pawn or Actor can move independantly from gravity. Velocity on the Z axis is ignored.

PHYS_Hovering

This is is a fun Physics type. When you an actors physics to PHYS_Hovering, it, er, hovers a few UU off the ground. If you do this to an xPawn, for example, it will act kind of like a hovercraft. Friction is reduced (so you slide around, and slide down ramps), and if you go at speed up an incline you can do some massive jumps.

PHYS_Interpolating

Used in conjunction with bInterpolating in Actor. Seems to also use the PhysRate and PhysAlpha parameters. Seems to be a leftover from the pre-Matinee days.

PHYS_Karma

Signals an Actor is to be effected by the Karma engine.

PHYS_KarmaRagDoll

This is used for dead pawns.

PHYS_Ladder

Applies to an Actor when they are climbing a ladder.

PHYS_MovingBrush

Used for Movers

PHYS_None

No native physics code is applied.

PHYS_Projectile

Uses velocities on all 3 axes but DOES NOT use the current Zone's ZoneGravity and ZoneFluidFriction members to adjust velocity. This means that actors with a velocity are not affected by gravity or friction. Actors with this physics setting do not have any freedom of movement.

PHYS_Rolling

(removed in UT2003)

PHYS_RootMotion

(new in UT2003)

PHYS_Rotating

Only rotation changes. Location doesn't change. If bRotateToDesired is false, then the Actor rotates according to RotationRate. If bRotateToDesired is true, then the Actor rotates to the rotation specified by DesiredRotation at the speed specified by RotationRate.

PHYS_Spider

Similar to PHYS_Walking except it applies to an Actor against any surface, not just a "ground" surface. An Actor in PHYS_Spider will move against a horizontal or vertical surface just like in PHYS_Walking. When the end of the surface is reached the Pawn will be set to PHYS_Falling. PHYS_Spider only works on one plane, it will not allow a Pawn to move across perpendicular walls.

PHYS_Swimming

Similar to PHYS_Flying, but also take the zone's FluidFriction into account.

PHYS_Trailer

Used to set an Actor to follow its Owner. An Actor set this way has no physics of its own, (*including collision) and simply follow their Owner around. NOTE: There are two settings in the Actor class which can specify the actions of a PHYS_Trailer. First is bTrailerPrePivot, which, when set to True, causes the Actor in PHYS_Trailer to be positioned away from its Owner by the vector value set in PrePivot. If not set or left at 0, the Actor in PHYS_Trailer will have the same location as its Owner. Secondly, there is bTrailerSameRotation, which causes the Actor in PHYS_Trailer to have the same Rotation as its Owner no matter where it is.

PHYS_Walking

Native physics code for Pawn class only. Applies all the things that make a pawn move around on the ground. Must have a Base set, without a Base to walk on, this turns to PHYS_Falling.

ERenderStyle Source code

Style for rendering sprites, meshes.

ESoundSlot Source code

ETravelType Source code

Travelling from server to server.

TRAVEL_Absolute

Absolute URL.

TRAVEL_Partial

Partial (carry name, reset server).

TRAVEL_Relative

Relative URL.

PointRegion Source code

Identifies a unique convex volume in the world.
iLeaf:

Bsp leaf.

Zone:

Zone

ZoneNumber:

Zone Number.

!= 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

AllActors Source code

Avoid using AllActors() too often as it iterates through the whole actor list and is therefore slow.

AnimEnd Source code

Notification that the current animation has ended. Allows an object to wait for animation completion before proceeding with other activities.

Attach Source code

BaseChange Source code

BasedActors Source code

Returns all actors based on the current actor (slow, like AllActors)

BeginEvent Source code

BeginPlay Source code

BroadcastMessage Source code

Bump Source code

ChildActors Source code

ChildActors() returns all actors owned by this actor. Slow like AllActors()

Cross Source code

Destroy Source code

Destroy this actor. Returns true if destroyed, false if indestructable.
Destruction is latent. It occurs at the end of the tick.

Destroyed Source code

Detach Source code

Dot Source code

EncroachedBy Source code

EncroachingOn Source code

EndedRotation Source code

Called when rotation completes

EndEvent Source code

Error Source code

Handle an error and kill this one actor.

Expired Source code

Falling Source code

FinishAnim Source code

FinishInterpolation Source code

GainedChild Source code

GetAnimGroup Source code

GetAxes Source code

GetUnAxes Source code

HitWall Source code

HurtRadius Source code

Hurt locally authoritative actors within the radius.

InterpolateEnd Source code

Invert Source code

IsA Source code

IsAnimating Source code

KillCredit Source code

KilledBy Source code

Landed Source code

LoopAnim Source code

LostChild Source code

Called when another actor with this actor as its owner is destroyed.

MakeNoise Source code

Inform other creatures that you've made a noise they might hear (they are sent a HearNoise message). Senders of MakeNoise should have an instigator if they are not pawns.

MirrorVectorByNormal Source code

Move Source code

MoveSmooth Source code

Normal Source code

PlayAnim Source code

PlayerCanSeeMe Source code

PlayerCanSeeMe returns true if any player (server) or the local player (standalone or client) has a line of sight to actor's location.

PlaySound Source code

Play a sound effect.

PostBeginPlay Source code

Called immediately after gameplay begins.

PostTeleport Source code

PreBeginPlay Source code

Called immediately before gameplay begins.

PreTeleport Source code

RadiusActors Source code

RadiusActors() returns all actors within a give radius. Slow like AllActors(). Use CollidingActors() or VisibleCollidingActors() instead if desired actor types are visible (not bHidden) and in the collision hash (bCollideActors is true)

RotRand Source code

SetBase Source code

SetCollision Source code

SetCollisionSize Source code

SetInitialState Source code

Called after PostBeginPlay.

SetLocation Source code

This function sets the location of the actor it is called on. It will not work on actors with PHYS_Karma or PHYS_KarmaRagdoll. If the actor cannot occupy the new location because it is colliding with an actor that can block it, it will be placed at the nearest valid location. Note that because Terrain has no "volume" and is just a bent up sheet, the actor may not be moved in this manner when it penetrates terrain.

SetOwner Source code

SetPhysics Source code

SetRotation Source code

This function sets the rotation of the actor it is called on. It will not work on actors with PHYS_Karma or PHYS_KarmaRagdoll.

SetTimer Source code

Causes Timer() events every NewTimerRate seconds. If bLoop is true, causes Timer() events every NewTimerRate seconds. Otherwise, causes Timer() to be called once in NewTimerRate seconds. SetTimer(0.0, False); stops the timer.

Sleep Source code

Waits for the specified amount of time before returning.
Latent function, can only be used in state code.

Spawn Source code

Spawn an actor. Returns an actor of the specified class, not of class Actor (this is hardcoded in the compiler).
Returns None if the actor could not be spawned (either the actor wouldn't fit in the specified location, or the actor list is full).
Defaults to spawning at the spawner's location.

Spawned Source code

SpecialHandling Source code

TakeDamage Source code

Tick Source code

Timer Source code

Touch Source code

TouchingActors Source code

Returns all actors touching the current actor (fast).

Trace Source code

This traces a path to find what it collides with first. The line will be traced starting at TraceStart and ending at TraceEnd. If bTraceActors is true, actors will be considered for the tracing, otherwise only pieces of the world (terrain, staticmeshactors, BSP) will be considered for collision. When the trace hits something, HitLocation and HitNormal will be set to contain the location and normal of the impact. If specified, the material of the surface hit can also be returned. If an Extent is specified, you can have the trace have "width." It will have a box of the size specified as a vector (corner to corner) as the "thickness" of the trace.
Note that traces are not very fast, so should be avoided or kept to a minimum where possible.
Note that if you want actors to be considered for traces they must be able to block the trace, either by bCollideActors, or easier with bBlockZeroExtentTraces or bBlockNonZeroExtentTraces if your trace uses extents.

TraceActors Source code

Return all actors along a traced line. Reasonably fast (like any trace)

TravelPostAccept Source code

Called when carried into a new level, after AcceptInventory.

TravelPreAccept Source code

Called when carried onto a new level, before AcceptInventory.

Trigger Source code

TweenAnim Source code

UnTouch Source code

UnTrigger Source code

VisibleActors Source code

Returns all visible (not bHidden) actors within a radius for which a trace from Loc (which defaults to caller's Location) to that actor's Location does not hit the world.
Slow like AllActors(). Use VisibleCollidingActors() instead if desired actor types are in the collision hash (bCollideActors is true)

VisibleCollidingActors Source code

Returns all colliding (bCollideActors==true) actors within a certain radius for which a trace from Loc (which defaults to caller's Location) to that actor's Location does not hit the world.
Much faster than AllActors() since it uses the collision hash

VRand Source code

VSize Source code

ZoneChange Source code

[ Source code

[ Source code