| Overview | Package | Class | Source | Class tree | Glossary | UnrealScript Documentation |
| previous class next class | frames no frames | |||||
Core.Object | +-- Engine.Actor
Brush, Camera, CameraActor, ComponentTestActorBase, Controller, DecalActor, DecalManager, DialogueManager, DroppedPickup, DynamicSMActor, Emitter, EmitterPool, FlockAttractor, FlockTestActor, FlockTest_Spawner, HUD, Info, Inventory, InventoryManager, KAsset, Keypoint, LensFlareSource, Light, MaterialInstanceActor, MatineeActor, NavigationPoint, Note, Pawn, PhysAnimTestActor, PrefabInstance, Projectile, RB_ConstraintActor, RB_CylindricalForceActor, RB_LineImpulseActor, RB_RadialForceActor, RB_RadialImpulseActor, RB_Thruster, SceneCaptureActor, SkeletalMeshActor, SpeedTreeActor, StaticMeshActorBase, SubobjectTestActor, Test0023_MetaData, TestPlaceableActor, Trigger, UTAvoidMarker, UTBreakablePowerCables, UTCarriedObject, UTCustomChar_Preview, UTDarkWalkerBeamLight, UTDeployedActor, UTGib, UTJumpBootEffect, UTLinkBeamLight, UTOnslaughtGodBeam, UTPowerCorePanel, UTProcessedCharacterCache, UTVehicleBoostPad, UTWalkerBody, UTWarfareChildBarricade, UTWeaponAttachment, UTWeaponShield, VehicleMovementEffect
| Constants Summary | ||
|---|---|---|
| ACTORMAXSTEPHEIGHT | = | 35.0 |
| MINFLOORZ | = | 0.7 |
| RBSTATE_ANGVELSCALE | = | 1000.0 |
| RBSTATE_LINVELSCALE | = | 10.0 |
| RB_NeedsUpdate | = | 0x01 |
| RB_None | = | 0x00 |
| RB_Sleeping | = | 0x02 |
| REP_RBLOCATION_ERROR_TOLERANCE_SQ | = | 16.0f |
| TRACEFLAG_Blocking | = | 8 |
| TRACEFLAG_Bullet | = | 1 |
| TRACEFLAG_PhysicsVolumes | = | 2 |
| TRACEFLAG_SkipMovers | = | 4 |
| Inherited Contants from Core.Object |
|---|
| DegToRad, INDEX_NONE, MaxInt, Pi, RadToDeg |
| Inherited Variables from Core.Object |
|---|
| Class, HashNext, HashOuterNext, Linker, LinkerIndex, Name, NetIndex, ObjectArchetype, ObjectFlags, ObjectInternalInteger, Outer, StateFrame, VfTableObject |
| Enumerations Summary | ||
|---|---|---|
| ECollisionType COLLIDE_CustomDefault, COLLIDE_NoCollision, COLLIDE_BlockAll, COLLIDE_BlockWeapons, COLLIDE_TouchAll, COLLIDE_TouchWeapons, COLLIDE_BlockAllButWeapons, COLLIDE_TouchAllButWeapons, | ||
| EDoubleClickDir DCLICK_None, DCLICK_Left, DCLICK_Right, DCLICK_Forward, DCLICK_Back, DCLICK_Active, DCLICK_Done | ||
| EMoveDir MD_Stationary, MD_Forward, MD_Backward, MD_Left, MD_Right, MD_Up, MD_Down | ||
| ENetRole ROLE_None, ROLE_SimulatedProxy, ROLE_AutonomousProxy, ROLE_Authority, | ||
| EPhysics PHYS_None, PHYS_Walking, PHYS_Falling, PHYS_Swimming, PHYS_Flying, PHYS_Rotating, PHYS_Projectile, PHYS_Interpolating, PHYS_Spider, PHYS_Ladder, PHYS_RigidBody, PHYS_SoftBody, PHYS_Unused | ||
| ETravelType TRAVEL_Absolute, TRAVEL_Partial, TRAVEL_Relative, | ||
| Inherited Enumerations from Core.Object |
|---|
| EAxis, EInputEvent, EInterpCurveMode, EInterpMethodType, ETickingGroup |
| Structures Summary | ||
|---|---|---|
| AnimSlotDesc SlotName, NumChannels | ||
| AnimSlotInfo SlotName, ChannelWeights | ||
| AsyncLineCheckResult bCheckStarted, bCheckCompleted, bHit | ||
| CollisionImpactData ContactInfos, TotalNormalForceVector, TotalFrictionForceVector | ||
| ImpactInfo HitActor, HitLocation, HitNormal, RayDir, HitInfo | ||
| NavReference Nav, Guid | ||
| ReplicatedHitImpulse AppliedImpulse, HitLocation, BoneName, ImpulseCount, bRadialImpulse | ||
| RigidBodyContactInfo ContactPosition, ContactNormal, ContactPenetration, ContactVelocity[2], PhysMaterial[2] | ||
| RigidBodyState Position, Quaternion, LinVel, AngVel, bNewData | ||
| TimerData bLoop, FuncName, Rate, Count, TimerObj | ||
| TraceHitInfo Material, PhysMaterial, Item, LevelIndex, BoneName, HitComponent | ||
| Functions Summary | ||
|---|---|---|
![]() | bool | ActivateEventClass (class<SequenceEvent> InClass, Actor InInstigator, const out array<SequenceEvent> EventList, optional const out array<int> ActivateIndices, optional bool bTest )) |
![]() | coerce | actor () |
![]() | AllActors (class<actor> BaseClass, out actor Actor) | |
![]() | AllOwnedComponents (class<Component> BaseClass, ut ActorComponent OutComponent) | |
![]() | Attach (Actor Other) | |
![]() | AttachComponent (ActorComponent NewComponent) | |
![]() | AutonomousPhysics (float DeltaSeconds) | |
![]() | BaseChange () | |
![]() | BasedActors (class<actor> BaseClass, out actor Actor) | |
![]() | BecomeViewTarget (PlayerController PC) | |
![]() | BeginAnimControl (array<AnimSet> InAnimSets) | |
![]() | BroadcastLocalizedMessage (class<LocalMessage> InMessageClass, optional int Switch, optional PlayerReplicationInfo RelatedPRI_1, optional PlayerReplicationInfo RelatedPRI_2, optional Object OptionalObject )) | |
![]() | BroadcastLocalizedTeamMessage (int TeamIndex, class<LocalMessage> InMessageClass, optional int Switch, optional PlayerReplicationInfo RelatedPRI_1, optional PlayerReplicationInfo RelatedPRI_2, optional Object OptionalObject )) | |
![]() | Bump (Actor Other, PrimitiveComponent OtherComp, Vector HitNormal) | |
![]() | bool | CalcCamera (float fDeltaTime, out vector out_CamLoc, out rotator out_CamRot, out float out_FOV )) |
![]() | bool | CanSplash ())) |
![]() | ChartData (string DataName, float DataValue) | |
![]() | bool | CheckForErrors () |
![]() | CheckHitInfo (out TraceHitInfo HitInfo, PrimitiveComponent FallBackComponent, Vector Dir, out Vector out_HitLocation
)) | |
![]() | bool | CheckMaxEffectDistance (PlayerController P, vector SpawnLocation, optional float CullDistance)) |
![]() | ChildActors (class<actor> BaseClass, out actor Actor) | |
![]() | bool | ClampRotation (out Rotator out_Rot, Rotator rBase, Rotator rUpperLimits, Rotator rLowerLimits) |
![]() | ClearLatentAction (class<SeqAct_Latent> actionClass, ptional bool bAborted, ptional SeqAct_Latent exceptionAction)) | |
![]() | ClearTimer (optional Name inTimerFunc='Timer', optional Object inObj) | |
![]() | Clock (out float time) | |
![]() | CollidingActors (class<actor> BaseClass, out actor Actor, float Radius, optional vector Loc, optional bool bUseOverlapCheck) | |
![]() | CollisionChanged () | |
![]() | ComponentList (class<Object> BaseClass, out ActorComponent out_Component) | |
![]() | string | ConsoleCommand (string Command, optional bool bWriteToLog = true) |
![]() | ConstraintBrokenNotify (Actor ConOwner, RB_ConstraintSetup ConSetup, RB_ConstraintInstance ConInstance )) | |
![]() | bool | ContainsPoint (vector Spot) |
![]() | AudioComponent | CreateAudioComponent (SoundCue InSoundCue, optional bool bPlay, optional bool bStopWhenOwnerDestroyed, optional bool bUseLocation, optional vector SourceLocation, optional bool bAttachToSelf = true) |
![]() | DebugFreezeGame ())) | |
![]() | bool | Destroy () |
![]() | Destroyed () | |
![]() | Detach (Actor Other) | |
![]() | DetachComponent (ActorComponent ExComponent) | |
![]() | DisplayDebug (HUD HUD, out float out_YL, out float out_YPos)) | |
![]() | DoKismetAttachment (Actor Attachment, SeqAct_AttachToActor Action)) | |
![]() | DrawDebugBox (vector Center, vector Extent, byte R, byte G, byte B, optional bool bPersistentLines) | |
![]() | DrawDebugCone (Vector Origin, Vector Direction, FLOAT Length, FLOAT AngleWidth, FLOAT AngleHeight, INT NumSides, Color DrawColor, optional bool bPersistentLines) | |
![]() | DrawDebugCoordinateSystem (vector AxisLoc, Rotator AxisRot, float Scale, optional bool bPersistentLines) | |
![]() | DrawDebugCylinder (vector Start, vector End, float Radius, INT Segments, byte R, byte G, byte B, optional bool bPersistentLines) | |
![]() | DrawDebugLine (vector LineStart, vector LineEnd, byte R, byte G, byte B, optional bool bPersistentLines) | |
![]() | DrawDebugSphere (vector Center, float Radius, INT Segments, byte R, byte G, byte B, optional bool bPersistentLines) | |
![]() | DynamicActors (class<actor> BaseClass, out actor Actor) | |
![]() | bool | EffectIsRelevant (vector SpawnLocation, bool bForceDedicated, optional float CullDistance )) |
![]() | EncroachedBy (actor Other) | |
![]() | bool | EncroachingOn (Actor Other) |
![]() | EndViewTarget (PlayerController PC) | |
![]() | Falling () | |
![]() | bool | FastTrace (vector TraceEnd, optional vector TraceStart, optional vector BoxExtent, optional bool bTraceBullet) |
![]() | FellOutOfWorld (class<DamageType> dmgType)) | |
![]() | bool | FindActorsOfClass (class<Actor> ActorClass, out array<Actor> out_Actors)) |
![]() | FindBase () | |
![]() | bool | FindEventsOfClass (class<SequenceEvent> EventClass, optional out array<SequenceEvent> out_EventList)) |
![]() | FindGoodEndView (PlayerController PC, out Rotator GoodRotation)) | |
![]() | bool | FindSpot (vector BoxExtent, out vector SpotLocation) |
![]() | FinishAnim (AnimNodeSequence SeqNode) | |
![]() | FinishAnimControl () | |
![]() | FlushPersistentDebugLines () | |
![]() | ForceNetRelevant ())) | |
![]() | ForceUpdateComponents (optional bool bCollisionUpdate = FALSE, optional bool bTransformOnly = TRUE) | |
![]() | GainedChild (Actor Other) | |
![]() | GetActorEyesViewPoint (out vector out_Location, out Rotator out_Rotation )) | |
![]() | FaceFXAsset | GetActorFaceFXAsset () |
![]() | Actor | GetBaseMost () |
![]() | GetBoundingCylinder (out float CollisionRadius, out float CollisionHeight) con) | |
![]() | GetComponentsBoundingBox (out box ActorBox) con) | |
![]() | String | GetDebugName ())) |
![]() | vector | GetDestination (Controller C) |
![]() | AudioComponent | GetFaceFXAudioComponent ())) |
![]() | float | GetGravityZ () |
![]() | String | GetHumanReadableName ())) |
![]() | String | GetItemName (string FullName )) |
![]() | string | GetLocalString (optional int Switch, optional PlayerReplicationInfo RelatedPRI_1, optional PlayerReplicationInfo RelatedPRI_2 )) |
![]() | string | GetLocationStringFor (PlayerReplicationInfo PRI)) |
![]() | Guid | GetPackageGuid (name PackageName) |
![]() | String | GetPhysicsName ())) |
![]() | vector | GetTargetLocation (optional actor RequestedBy, optional bool bRequestAlternateLoc) con) |
![]() | byte | GetTeamNum () |
![]() | float | GetTerminalVelocity () |
![]() | float | GetTimerCount (optional Name inTimerFunc='Timer', optional Object inObj) |
![]() | float | GetTimerRate (optional name TimerFuncName = 'Timer', optional Object inObj) |
![]() | string | GetURLMap () |
![]() | bool | HealDamage (int Amount, Controller Healer, class<DamageType> DamageType) |
![]() | HitWall (vector HitNormal, actor Wall, PrimitiveComponent WallComp) | |
![]() | bool | HurtRadius (float BaseDamage, float DamageRadius, class<DamageType> DamageType, float Momentum, vector HurtOrigin, optional Actor IgnoredActor, optional Controller InstigatedByController = Instigator != None ? Instigator.Controller : None, optional bool bDoFullDamage
)) |
![]() | InterpolationChanged (SeqAct_Interp InterpAction) | |
![]() | InterpolationFinished (SeqAct_Interp InterpAction) | |
![]() | InterpolationStarted (SeqAct_Interp InterpAction) | |
![]() | bool | IsActorPlayingFaceFXAnim ())) |
![]() | bool | IsBasedOn (Actor TestActor) |
![]() | bool | IsInPain ())) |
![]() | bool | IsInVolume (Volume aVolume)) |
![]() | bool | IsOverlapping (Actor A) |
![]() | bool | IsOwnedBy (Actor TestActor) |
![]() | bool | IsPlayerOwned () |
![]() | bool | IsStationary ())) |
![]() | bool | IsTimerActive (optional Name inTimerFunc='Timer', optional Object inObj) |
![]() | KilledBy (pawn EventInstigator) | |
![]() | Landed (vector HitNormal, actor FloorActor) | |
![]() | LocalPlayerControllers (class<PlayerController> BaseClass, out PlayerController PC) | |
![]() | LostChild (Actor Other) | |
![]() | MakeNoise (float Loudness, optional Name NoiseType) | |
![]() | MatchStarting () | |
![]() | ModifyHearSoundComponent (AudioComponent AC) | |
![]() | bool | Move (vector Delta) |
![]() | bool | MoveSmooth (vector Delta) |
![]() | EMoveDir | MovingWhichWay (out float Amount) |
![]() | NativePostRenderFor (PlayerController PC, Canvas Canvas, vector CameraPosition, vector CameraDir) | |
![]() | NotifyLocalPlayerTeamReceived () | |
![]() | NotifySkelControlBeyondLimit (SkelControlLookAt LookAt) | |
![]() | OnAnimEnd (AnimNodeSequence SeqNode, float PlayedTime, float ExcessTime) | |
![]() | OnAnimPlay (AnimNodeSequence SeqNode) | |
![]() | OnAttachToActor (SeqAct_AttachToActor Action)) | |
![]() | OnCauseDamage (SeqAct_CauseDamage Action)) | |
![]() | OnChangeCollision (SeqAct_ChangeCollision Action)) | |
![]() | OnDestroy (SeqAct_Destroy Action)) | |
![]() | OnHealDamage (SeqAct_HealDamage Action)) | |
![]() | OnMakeNoise (SeqAct_MakeNoise Action )) | |
![]() | OnRanOver (SVehicle Vehicle, PrimitiveComponent RunOverComponent, int WheelIndex) | |
![]() | OnSetBlockRigidBody (SeqAct_SetBlockRigidBody Action)) | |
![]() | OnSetPhysics (SeqAct_SetPhysics Action)) | |
![]() | OnTeleport (SeqAct_Teleport Action)) | |
![]() | OnToggleHidden (SeqAct_ToggleHidden Action)) | |
![]() | OutsideWorldBounds ())) | |
![]() | OverlappingActors (class<Actor> BaseClass, out Actor out_Actor, float Radius, optional vector Loc, optional bool bIgnoreHidden) | |
![]() | bool | OverRotated (out Rotator out_Desired, out Rotator out_Actual) |
![]() | PawnBaseDied () | |
![]() | PhysicsVolumeChange (PhysicsVolume NewVolume) | |
![]() | PickedUpBy (Pawn P) | |
![]() | bool | PlayActorFaceFXAnim (FaceFXAnimSet AnimSet, String GroupName, String SeqName) |
![]() | bool | PlayerCanSeeMe () |
![]() | PlaySound (SoundCue InSoundCue, optional bool bNotReplicated, optional bool bNoRepToOwner, optional bool bStopWhenOwnerDestroyed, optional vector SoundLocation, optional bool bNoRepToRelevant) | |
![]() | PlayTeleportEffect (bool bOut, bool bSound) | |
![]() | bool | PointCheckComponent (PrimitiveComponent InComponent, vector PointLocation, vector PointExtent) |
![]() | PostBeginPlay () | |
![]() | PostInitAnimTree (SkeletalMeshComponent SkelComp) | |
![]() | PostRenderFor (PlayerController PC, Canvas Canvas, vector CameraPosition, vector CameraDir) | |
![]() | PostTeleport (Teleporter OutTeleporter) | |
![]() | PostTouch (Actor Other) | |
![]() | PreBeginPlay ())) | |
![]() | bool | PreTeleport (Teleporter InTeleporter) |
![]() | RanInto (Actor Other) | |
![]() | ReplaceText (out string Text, string Replace, string With)) | |
![]() | ReplicatedEvent (name VarName) | |
![]() | Reset () | |
![]() | RigidBodyCollision (PrimitiveComponent HitComponent, PrimitiveComponent OtherComponent, const out CollisionImpactData RigidCollisionData, int ContactIndex) | |
![]() | RootMotionExtracted (SkeletalMeshComponent SkelComp, out BoneAtom ExtractedRootMotionDelta) | |
![]() | RootMotionModeChanged (SkeletalMeshComponent SkelComp) | |
![]() | byte | ScriptGetTeamNum ())) |
![]() | SetAnimPosition (name SlotName, int ChannelIndex, name InAnimSeqName, float InPosition, bool bFireNotifies, bool bLooping) | |
![]() | SetAnimWeights (array<AnimSlotInfo> SlotInfos) | |
![]() | SetBase (actor NewBase, optional vector NewFloor, optional SkeletalMeshComponent SkelComp, optional name AttachName) | |
![]() | SetCollision (optional bool bNewColActors, optional bool bNewBlockActors, optional bool bNewIgnoreEncroachers) | |
![]() | SetCollisionSize (float NewRadius, float NewHeight) | |
![]() | SetDrawScale (float NewScale) | |
![]() | SetDrawScale3D (vector NewScale3D) | |
![]() | SetForcedInitialReplicatedProperty (Property PropToReplicate, bool bAdd) | |
![]() | SetGRI (GameReplicationInfo GRI) | |
![]() | noexport | SetHardAttach (optional bool bNewHardAttach) |
![]() | SetHidden (bool bNewHidden) | |
![]() | SetHUDLocation (vector NewHUDLocation) | |
![]() | SetInitialState ())) | |
![]() | bool | SetLocation (vector NewLocation) |
![]() | SetMorphWeight (name MorphNodeName, float MorphWeight) | |
![]() | SetNetUpdateTime (float NewUpdateTime) | |
![]() | SetOnlyOwnerSee (bool bNewOnlyOwnerSee) | |
![]() | SetOwner (actor NewOwner) | |
![]() | SetPhysics (EPhysics newPhysics) | |
![]() | bool | SetRelativeLocation (vector NewLocation) |
![]() | bool | SetRelativeRotation (rotator NewRotation) |
![]() | bool | SetRotation (rotator NewRotation) |
![]() | SetSkelControlScale (name SkelControlName, float Scale) | |
![]() | SetTickGroup (ETickingGroup NewTickGroup) | |
![]() | SetTimer (float inRate, optional bool inbLoop, optional Name inTimerFunc='Timer', optional Object inObj) | |
![]() | SetZone (bool bForceRefresh) | |
![]() | ShutDown ())) | |
![]() | Sleep (float Seconds) | |
![]() | SpawnedByKismet () | |
![]() | Actor | SpecialHandling (Pawn Other) |
![]() | StopActorFaceFXAnim () | |
![]() | bool | StopsProjectile (Projectile P)) |
![]() | bool | SuggestTossVelocity (out vector TossVelocity, vector Destination, vector Start, float TossSpeed, optional float BaseTossZ, optional float DesiredZPct, optional vector CollisionSize, optional float TerminalVelocity) |
![]() | TakeDamage (int DamageAmount, Controller EventInstigator, vector HitLocation, vector Momentum, class<DamageType> DamageType, optional TraceHitInfo HitInfo, optional Actor DamageCauser)) | |
![]() | TakeRadiusDamage (Controller InstigatedBy, float BaseDamage, float DamageRadius, class<DamageType> DamageType, float Momentum, vector HurtOrigin, bool bFullDamage, Actor DamageCauser
)) | |
![]() | Tick (float DeltaTime) | |
![]() | Timer () | |
![]() | float | TimeSince (float Time )) |
![]() | TornOff () | |
![]() | Touch (Actor Other, PrimitiveComponent OtherComp, vector HitLocation, vector HitNormal) | |
![]() | 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, optional out TraceHitInfo HitInfo, optional int ExtraTraceFlags) |
![]() | TraceActors (class<actor> BaseClass, out actor Actor, out vector HitLoc, out vector HitNorm, vector End, optional vector Start, optional vector Extent, optional out TraceHitInfo HitInfo, optional int ExtraTraceFlags) | |
![]() | bool | TraceComponent (out vector HitLocation, out vector HitNormal, PrimitiveComponent InComponent, vector TraceEnd, optional vector TraceStart, optional vector Extent, optional out TraceHitInfo HitInfo) |
![]() | bool | TriggerEventClass (class<SequenceEvent> InEventClass, Actor InInstigator, optional int ActivateIndex = -1, optional bool bTest)) |
![]() | UnClock (out float time) | |
![]() | UnTouch (Actor Other) | |
![]() | bool | UsedBy (Pawn User)) |
![]() | VisibleActors (class<actor> BaseClass, out actor Actor, optional float Radius, optional vector Loc) | |
![]() | VisibleCollidingActors (class<actor> BaseClass, out actor Actor, float Radius, optional vector Loc, optional bool bIgnoreHidden) | |
| Constants Detail |
|---|
Minimum Z value for floor normal. Anything that's less, isn't a walkable floor. (0.7 corresponds to about 45 degree angle for floor)
when bReplicateRigidBodyLocation is true, the root body of a ragdoll will be replicated but this is not entirely accurate (and isn't meant to be) as the other bodies in the ragdoll may interfere this can then result in jittering from the client constantly trying to apply the replicated value so if the client's error is less than this amount from the replicated value, it will be ignored
List of extra trace flags
| Variables Detail |
|---|
All actor components which are directly or indirectly attached to the actor.
Array of actors attached to this actor.
If true (and is an encroacher) will do the encroachment check inside MoveActor even if there is no movement. This is useful for objects that may change bounding box but not actually move.
Always relevant for network.
Update even when players-only.
Blocks other nonplayer actors.
Bounces when hits ground fast.
Determines whether or not adhesion code should attempt to adhere to this actor.
Can take damage.
Determines whether or not friction code should attempt to friction to this actor.
This actor can be teleported. This property must be True for Teleporters to notice the actor.
Collides with other actors.
The actor will collide with world geometry when placed.
Collides with the world.
Set TRUE if a component is ever attached which is outside the world. OutsideWorldBounds will be called in Tick in this case.
About to be deleted.
set when we are currently replicating this Actor into a demo
Demop recording variables
If TRUE, when an InterpActor (Mover) encroaches or runs into this Actor, it is destroyed, and will not stop the mover.
Destroy this actor if it enters a pain volume.
whether we already exchanged Role/RemoteRole on the client, as removing then readding a streaming level causes all initialization to be performed again even though the actor may not have actually been reloaded
When set to TRUE will force this actor to immediately be considered for replication, instead of waiting for NetUpdateTime
Mutators will not receive CheckReplacement and AlwaysKeep calls for the actor if this property is True.
whether this Actor may return an alternate location from GetTargetLocation() when bRequestAlternateLoc is true (used as an early out when tracing to those locations, etc)
Keep HurtRadius from being reentrant,
Ignore collisions between movers and this actor.
Ignore Unreal collisions between PHYS_RigidBody pawns (vehicles/ragdolls) and this actor (only relevant if bIgnoreEncroachers is false)
Used to determine when we stop moving, so we can update PreviousLocalToWorld to stop motion blurring.
Used by engine physics - not valid for scripts.
Actor can be moved.
Set when any attribute is assigned a value in unrealscript,
Initial network update.
Should replicate initial rotation. This property should never be changed during execution, as the client and server rely on the default value of this property always being the same.
Player owns this actor.
Tear-off simulation in network play.
Specifies, that the actor can't be spawned or destroyed during the game.
If true, only replicate actor ifbNetDirtyis true - useful if no C++ changed attributes (such as physics)
Only owner can see this actor.
This actor is only relevant to its owner.
When landing, orient base on slope of floor.
Internal/path building.
Set when actor is about to be deleted (since endstate and other functions called during deletion process before bDeleteMe is set).
Is this actor still pending a full net update due to clients that weren't able to replicate the actor at the time of LastNetUpdateTime
IF true, may call PostRenderFor() even when this actor is not visible
Projectiles should potentially target this actor.
whether encroachers can push this Actor (only relevant if bIgnoreEncroachers is false and not an encroacher ourselves) if false, the encroacher gets EncroachingOn() called immediately instead of trying to safely move this actor first
Replicate instigator to client (used by bNetTemporary projectiles).
If true, replicate movement/location related properties.
Whether to route BeginPlay even if the actor is static.
Set to prevent re-initializing of actors spawned during level startup
The actor tries to find another actor for its Base at level startup if its Physics property is set to either PHYS_None or PHYS_Rotating.
f true, don't replicate actor class variables for this actor.
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.
Does not move or change over time. Don't let L.D.s change this - screws up net play.
If true, this actor is no longer replicated to new clients, and is "torn off" (becomes a ROLE_Authority) on clients to which it was being replicated.
Actor has been updated.
f true, update velocity/location after initialization for simulated proxies.
Collision and Physics treats this actor as world geometry.
The actor components which are attached directly to the actor's location/rotation.
Allow each actor to run at a different time speed
A fence to track when the primitive is detached from the scene in the rendering thread.
List of all events currently associated with this actor
Pawn responsible for damage caused by this actor.
Last time this actor was updated for replication via NetUpdateTime or bForceNetUpdate
The value of WorldInfo->TimeSeconds for the frame when this actor was last rendered. This is written from the render thread, which is up to a frame behind the game thread, so you should allow this time to be at least a frame behind the game thread's world time before you consider the actor non-visible. There's an equivalent variable in PrimitiveComponent.
List of all latent actions currently active on this actor
Internal latent function use.
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.
Priority for this actor when checking for replication in a low bandwidth or saturated situation, higher priority means it is more likely to replicate
Internal - used by UWorld::ServerTickClients()
How often (per second) this actor will be considered for replication, used to determine NetUpdateTime
Next time this actor will be considered for replication, set by SetNetUpdateTime()
Owner actor.
Actor touched during move which wants to add an effect after the movement completes.
physics volume this actor is currently in.
Location relative to base/bone (valid if base exists).
Rotation relative to base/bone (valid if base exists)
List of all events that this actor can support, for use by the editor
The ticking group this actor belongs to
List of touching actors.
If true, texture streaming code iterates over all StaticMeshComponents found on this actor when building texture streaming information.
Snap to grid in the editor.
The actor is hidden in the editor. This has no effect in the game.
The actor is hidden in the Group Browser. This has no effect in the editor viewports or in the game.
Prevent the actor from being moved in the editor.
Actor we're standing on.
Uses 'hard' attachment code.bBlockActorandbBlockPlayermust also be false.
This actor cannot then move relative to base (setlocation etc.).
If TRUE, BaseSkelComponent is used as the shadow parent for this actor.
mirrored copy of CollisionComponent's BlockRigidBody for the Actor property window for LDs (so it's next to CollisionType) purely for editing convenience and not used at all by the physics code
For encroachers, don't do the overlap check when they move. You will not get touch events for this actor moving, but it is much faster. This is an optimisation for large numbers of PHYS_RigidBody actors for example.
This actor should collide (ifbWorldGeometry && bBlockActorsis true) during path building (ignored ifbStaticis true, as actor will always collide during path building).
If true, do a zero-extent trace each frame from old to new Location when in PHYS_RigidBody. If it hits the world (ie might be tunneling), call FellOutOfWorld.
enum for LDs to select collision options - sets Actor flags and that of our CollisionComponent via PostEditChange()
If this is True, all PrimitiveComponents of the actor are hidden. If this is false, only PrimitiveComponents with HiddenGame=True are hidden.
Scaling factor, 1.0=normal size.
Scaling vector, (1.0,1.0,1.0)=normal size.
Offset from box center for drawing.
Physics will smoothly rotate actor to this rotation if bRotateToDesired.
Actor's location; use Move to set.
Change in rotation per second.
indicates that this Actor can dynamically block AI paths
Actor's tag name.
If linear error is less than this, will not be corrected by net update.
| Enumerations Detail |
|---|
COLLIDE_CustomDefault, COLLIDE_NoCollision, COLLIDE_BlockAll, COLLIDE_BlockWeapons, COLLIDE_TouchAll, COLLIDE_TouchWeapons, COLLIDE_BlockAllButWeapons, COLLIDE_TouchAllButWeapons,};
DCLICK_None, DCLICK_Left, DCLICK_Right, DCLICK_Forward, DCLICK_Back, DCLICK_Active, DCLICK_Done};
Double click move direction.
Used to remember the dodging state of a player. This will be reset to DCLICK_None when the player lands.
- DCLICK_None
- No dodging move started.
- DCLICK_Active
- In dodging move.
- DCLICK_Done
- Dodging move done.
The set of Directions an actor can be moving
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_Noneis instantiated from asimulated 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 theRemoteRoleon the authorative version of an actor or theRoleon a replicated version of the actor to this value.
PHYS_None, PHYS_Walking, PHYS_Falling, PHYS_Swimming, PHYS_Flying, PHYS_Rotating, PHYS_Projectile, PHYS_Interpolating, PHYS_Spider, PHYS_Ladder, PHYS_RigidBody, PHYS_SoftBody, PHYS_Unused};
Actor's PhysicsType is set in the Physics property. Use theSetPhysics() 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
bInterpolatingin Actor. Seems to also use thePhysRateandPhysAlphaparameters. 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
bRotateToDesiredis false, then the Actor rotates according toRotationRate. IfbRotateToDesiredis true, then the Actor rotates to the rotation specified byDesiredRotationat the speed specified byRotationRate.- PHYS_Spider
- Similar to
PHYS_Walkingexcept it applies to an Actor against any surface, not just a "ground" surface. An Actor inPHYS_Spiderwill move against a horizontal or vertical surface just like inPHYS_Walking. When the end of the surface is reached the Pawn will be set toPHYS_Falling.PHYS_Spideronly 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 isbTrailerPrePivot, which, when set to True, causes the Actor inPHYS_Trailerto be positioned away from its Owner by the vector value set inPrePivot. If not set or left at 0, the Actor inPHYS_Trailerwill have the same location as its Owner. Secondly, there isbTrailerSameRotation, which causes the Actor inPHYS_Trailerto 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.
Travelling from server to server.
- TRAVEL_Absolute
- Absolute URL.
- TRAVEL_Partial
- Partial (carry name, reset server).
- TRAVEL_Relative
- Relative URL.
| Structures Detail |
|---|
Used to indicate each slot name and how many channels they have.
NumChannels:Number of channels that are available in this slot.SlotName:Name of the slot.
Struct used for passing information from Matinee to an Actor for blending animations during a sequence.
ChannelWeights:Strength of each Channel within this Slot. Channel indexs are determined by track order in Matinee.SlotName:Name of slot that we want to play the animtion in.
Structure filled in by async line check when it completes. @warning: C++ mirroring is in UnPhysPublic.h
bCheckCompleted:Indicates that the async line check has finished, and bHit now contains the result.bCheckStarted:Indicates that there is an outstanding async line check that will be filling in this structure.bHit:Indicates result of line check. If bHit is TRUE, then the line hit some part of the level.
var array<RigidBodyContactInfo> ContactInfos;};
var vector TotalFrictionForceVector;
var vector TotalNormalForceVector;
Information about an overall collision, including contacts @warning: C++ mirroring is in UnPhysPublic.h
ContactInfos:all the contact points in the collisionTotalFrictionForceVector:the total counterforce applied of the two objects sliding against each otherTotalNormalForceVector:the total force applied as the two objects push against each other
var Actor HitActor;};
var TraceHitInfo HitInfo;
var vector HitLocation;
var vector HitNormal;
var vector RayDir;
Hit definition struct. Mainly used by Instant Hit Weapons.
HitActor:Actor HitHitInfo:Trace Hit Info (material, bonename...)HitLocation:world location of hit impactHitNormal:Hit normal of impactRayDir:Direction of ray when hitting actor
Struct used for cross level navigation point references.
var vector AppliedImpulse;};
var name BoneName;
var bool bRadialImpulse;
var vector HitLocation;
var byte ImpulseCount;
var vector ContactNormal;};
var float ContactPenetration;
var vector ContactPosition;
var vector ContactVelocity[2];
var PhysicalMaterial PhysMaterial[2];
Information about one contact between a pair of rigid bodies @warning: C++ mirroring is in UnPhysPublic.h
var vector AngVel;};
var byte bNewData;
var vector LinVel;
var vector Position;
var Quat Quaternion;
describes the physical state of a rigid body @warning: C++ mirroring is in UnPhysPublic.h
var bool bLoop;};
var float Count;
var Name FuncName;
var float Rate;
var Object TimerObj;
var name BoneName;};
var PrimitiveComponent HitComponent;
var int Item;
var int LevelIndex;
var Material Material;
var PhysicalMaterial PhysMaterial;
| Functions Detail |
|---|
ActivateEventClass Source codeIterates through the given list of events and looks for all matching events, activating them as found.
@return true if an event was found and activated
actor Source codeSpawn 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 (if that happens, there will be a log warning indicating why) Defaults to spawning at the spawner's location. @note: ActorTemplate is sent for replicated actors and therefore its properties will also be applied at initial creation on the client. However, because of this, ActorTemplate must be a static resource (an actor archetype, default object, or a bStatic/bNoDelete actor in a level package) or the spawned Actor cannot be replicated
AllActors Source code
Avoid using AllActors() too often as it iterates through the whole actor list and is therefore slow.
AllOwnedComponents Source codeIterates over all components directly or indirectly attached to this actor.
@param BaseClass - Only components deriving from BaseClass will be iterated upon.
@param OutComponent - The iteration variable.
Attach Source code
AttachComponent Source codeAdds a component to the actor's components array, attaching it to the actor.
@param NewComponent - The component to attach.
AutonomousPhysics Source code
BaseChange Source code
BasedActors Source codeReturns all actors based on the current actor (slow, like AllActors)
BecomeViewTarget Source codeCalled by PlayerController when this actor becomes its ViewTarget.
BeginAnimControl Source codeCalled when we start an AnimControl track operating on this Actor. Supplied is the set of AnimSets we are going to want to play from.
BroadcastLocalizedMessage Source codeBroadcast a localized message to all players.
Most message deal with 0 to 2 related PRIs.
BroadcastLocalizedTeamMessage Source code
Bump Source code
CalcCamera Source codeCalculate camera view point, when viewing this actor.
@param fDeltaTime delta time seconds since last update
@param out_CamLoc Camera Location
@param out_CamRot Camera Rotation
@param out_FOV Field of View
@return true if Actor should provide the camera point of view.
CanSplash Source code
ChartData Source codeDraw some value over time onto the StatChart. Toggle on and off with
CheckForErrors Source code
CheckHitInfo Source codeMake sure we pass along a valid HitInfo struct for damage. The main reason behind this is that SkeletalMeshes do require a BoneName to receive and process an impulse... So if we don't have access to it (through touch() or for any non trace damage results), we need to perform an extra trace call().
@param HitInfo, initial structure to check
@param FallBackComponent, PrimitiveComponent to use if HitInfo.HitComponent is none
@param Dir, Direction to use if a Trace needs to be performed to find BoneName on skeletalmesh. Trace from HitLocation.
@param out_HitLocation, HitLocation to use for potential Trace, will get updated by Trace.
CheckMaxEffectDistance Source code
ChildActors Source codeChildActors() returns all actors owned by this actor. Slow like AllActors()
ClampRotation Source codeClamps out_Rot between the upper and lower limits offset from the base
ClearLatentAction Source codeClears all latent actions of the specified class.
@param actionClass - type of latent action to clear
@param bAborted - was this latent action aborted?
@param exceptionAction - action to skip
ClearTimer Source codeClears a previously set timer, identical to calling SetTimer() with a <= 0.f rate.
@param inTimerFunc the name of the timer to remove or the default one if not specified
Clock Source codeThis is called at the beginning of a section of code to be timed. The variable time does not need to be initialized.
CollidingActors Source code
CollidingActors() returns colliding (bCollideActors==true) actors within a certain radius.
CollisionChanged Source codeCalled when collision values change for this actor (via SetCollision/SetCollisionSize).
ComponentList Source codeReturns each component in the Components list
ConsoleCommand Source codeExecute a console command in the context of the current level and game engine.
ConstraintBrokenNotify Source codeWhen a constraint is broken we will get this event from c++ land.
ContainsPoint Source code
CreateAudioComponent Source code
DebugFreezeGame Source codeDebug Freeze Game dumps the current script function stack and pauses the game with PlayersOnly (still allowing the player to move around).
Destroy Source codeDestroy this actor. Returns true if destroyed, false if indestructable.
Destroyed Source code
Detach Source code
DetachComponent Source codeRemoves a component from the actor's components array, detaching it from the actor.
@param ExComponent - The component to detach.
DisplayDebug Source codelist important Actor variables on canvas. HUD will call DisplayDebug() on the current ViewTarget when the ShowDebug exec is used
@param HUD - HUD with canvas to draw on
@input out_YL - Height of the current font
@input out_YPos - Y position on Canvas. out_YPos += out_YL, gives position to draw text for next debug line.
DoKismetAttachment Source codePerforms actual attachment. Can be subclassed for class specific behaviors.
DrawDebugBox Source codeDraw a debug box
DrawDebugCone Source codeDraw a debug cone
DrawDebugCoordinateSystem Source codeDraw Debug coordinate system
DrawDebugCylinder Source codeDraw a debug cylinder
DrawDebugLine Source codeDraw a debug line
DrawDebugSphere Source codeDraw a debug sphere
DynamicActors Source codeDynamicActors() only iterates through the non-static actors on the list (still relatively slow, bu much better than AllActors). This should be used in most cases and replaces AllActors in most of
EffectIsRelevant Source code
EncroachedBy Source code
EncroachingOn Source codecalled when this Actor is encroaching on Other and we couldn't find an appropriate place to push Other to
@return true to abort the move, false to allow it
@warning do not abort moves of PHYS_RigidBody actors as that will cause the Unreal location and physics engine location to mismatch
EndViewTarget Source code
Falling Source code
FastTrace Source codeSimilar to trace, this one returns true if it hits the world geometry, false if it is not long enough. It will pass right through anything that is not set as world geometry.
FellOutOfWorld Source codecalled when the actor falls out of the world 'safely' (below KillZ and such)
FindActorsOfClass Source codeSearches for actors of the specified class.
FindBase Source codeAttempts to find a valid base for this actor
FindEventsOfClass Source codeBuilds a list of all events of the specified class.
@param eventClass - type of event to search for
@param out_EventList - list of found events
@return true if any events were found
FindGoodEndView Source codeUsed by PlayerController.FindGoodView() in RoundEnded State
FindSpot Source code
FinishAnim Source code
FinishAnimControl Source codeCalled when we are done with the AnimControl track.
FlushPersistentDebugLines Source codeFlush persistent lines
ForceNetRelevant Source codeforces this actor to be net relevant if it is not already by default, only works on level placed actors (bNoDelete)
ForceUpdateComponents Source codeFlags all components as dirty and then calls UpdateComponents().
@param bCollisionUpdate [opt] As per UpdateComponents; defaults to FALSE.
@param bTransformOnly [opt] TRUE to update only the component transforms, FALSE to update the entire component.
GainedChild Source code
GetActorEyesViewPoint Source codereturns the point of view of the actor. note that this doesn't mean the camera, but the 'eyes' of the actor. For example, for a Pawn, this would define the eye height location, and view rotation (which is different from the pawn rotation which has a zeroed pitch component). A camera first person view will typically use this view point. Most traces (weapon, AI) will be done from this view point.
@param out_Location - location of view point
@param out_Rotation - view rotation of actor.
GetActorFaceFXAsset Source codeUsed by Matinee in-game to mount FaceFXAnimSets before playing animations.
GetBaseMost Source codeWalks up the Base chain from this Actor and returns the Actor at the top (the eventual Base). this->Base is NULL, returns this.
GetBoundingCylinder Source code
GetComponentsBoundingBox Source code
GetDebugName Source code
GetDestination Source codereturns the position the AI should move toward to reach this actor accounts for AI using path lanes, cutting corners, and other special adjustments
GetFaceFXAudioComponent Source codeFunction for allowing you to tell FaceFX which AudioComponent it should use for playing audio for corresponding facial animation.
GetGravityZ Source codeGet gravity currently affecting this actor
GetHumanReadableName Source codeReturns the human readable string representation of an object.
GetItemName Source code
GetLocalString Source codeGet localized message string associated with this actor.
GetLocationStringFor Source code
GetPackageGuid Source codeLooks up the GUID of a package on disk. The package must NOT be in the autodownload cache. This may require loading the header of the package in question and is therefore slow.
GetPhysicsName Source code
GetTargetLocation Source code
@param RequestedBy - the Actor requesting the target location
@param bRequestAlternateLoc (optional) - return a secondary target location if there are multiple
@return the optimal location to fire weapons at this actor
GetTeamNum Source code
GetTerminalVelocity Source codereturns terminal velocity (max speed while falling) for this actor. Unless overridden, it returns the TerminalVelocity of the PhysicsVolume in which this actor is located.
GetTimerCount Source codeGets the current count for the specified timer, defaults to 'Timer' if no function is specified. Returns -1.f if the timer is not currently active.
@param inTimerFunc the name of the timer to remove or the default one if not specified
GetTimerRate Source codeGets the current rate for the specified timer.
@note: GetTimerRate('SomeTimer') - GetTimerCount('SomeTimer') is the time remaining before 'SomeTimer' is called
@param: TimerFuncName the name of the function to check for a timer for; 'Timer' is the default
@return the rate for the given timer, or -1.f if that timer is not active
GetURLMap Source code
HealDamage Source codethe reverse of TakeDamage(); heals the specified amount
@param Amount The amount of damage to heal
@param Healer Who is doing the healing
@param DamageType What type of healing is it
HitWall Source code
HurtRadius Source codeHurt locally authoritative actors within the radius.
InterpolationChanged Source codecalled when a SeqAct_Interp action affecting this Actor received an event that changed its properties (paused, reversed direction, etc)
@note this function is called on clients for actors that are interpolated clientside via MatineeActor
@param InterpAction the SeqAct_Interp that is affecting the Actor
InterpolationFinished Source codecalled when a SeqAct_Interp action finished interpolating this Actor
@note this function is called on clients for actors that are interpolated clientside via MatineeActor
@param InterpAction the SeqAct_Interp that was affecting the Actor
InterpolationStarted Source codecalled when a SeqAct_Interp action starts interpolating this Actor via matinee
@note this function is called on clients for actors that are interpolated clientside via MatineeActor
@param InterpAction the SeqAct_Interp that is affecting the Actor
IsActorPlayingFaceFXAnim Source codeReturns TRUE if Actor is playing a FaceFX anim. Implement in sub-class.
IsBasedOn Source codeiterates up the Base chain to see whether or not this Actor is based on the given Actor
@param TestActor the Actor to test for
@return whether or not this Actor is based on TestActor
IsInPain Source code
IsInVolume Source code
IsOverlapping Source code
IsOwnedBy Source codeiterates up the Owner chain to see whether or not this Actor is owned by the given Actor
@param TestActor the Actor to test for
@return whether or not this Actor is owned by TestActor
IsPlayerOwned Source codeSearches the owner chain looking for a player.
IsStationary Source codefor AI... bots have perfect aim shooting non-pawn stationary targets.
IsTimerActive Source codeReturns true if the specified timer is active, defaults to 'Timer' if no function is specified.
@param inTimerFunc the name of the timer to remove or the default one if not specified
KilledBy Source code
Landed Source code
LocalPlayerControllers Source codeiterator LocalPlayerControllers() returns all locally rendered/controlled player controllers (typically 1 per client, unless split screen)
LostChild Source codeCalled when another actor with this actor as its owner is destroyed.
MakeNoise Source codeInform other creatures that you've made a noise they might hear (they are sent a HearNoise message).
MatchStarting Source codeCalled when gameplay actually starts.
ModifyHearSoundComponent Source codecalled when a sound is going to be played on this Actor via PlayerController::ClientHearSound() gives it a chance to modify the component that will be used (add parameter values, etc)
Move Source code
MoveSmooth Source code
MovingWhichWay Source codeThis will return the direction in LocalSpace that that actor is moving. This is useful for firing off effects based on which way the actor is moving.
NativePostRenderFor Source codeHook to allow actors to render HUD overlays for themselves. Assumes that appropriate font has already been set
NotifyLocalPlayerTeamReceived Source codeCalled only ifbNotifyLocalPlayerTeamReceivedand is a net client when local playercontroller receivesPlayerReplicationInfo.Team
NotifySkelControlBeyondLimit Source code
OnAnimEnd Source codeEvent called when an AnimNodeSequence (in the animation tree of one of this Actor's SkeletalMeshComponents) reaches the end and stops. Will not get called if bLooping is 'true' on the AnimNodeSequence. bCauseActorAnimEnd must be set 'true' on the AnimNodeSequence for this event to get generated.
@param SeqNode - Node that finished playing. You can get to the SkeletalMeshComponent by looking at SeqNode->SkelComponent
@param PlayedTime - Time played on this animation. (play rate independant).
@param ExcessTime - how much time overlapped beyond end of animation. (play rate independant).
OnAnimPlay Source codeEvent called when a PlayAnim is called AnimNodeSequence in the animation tree of one of this Actor's SkeletalMeshComponents. bCauseActorAnimPlay must be set 'true' on the AnimNodeSequence for this event to get generated.
@param SeqNode - Node had PlayAnim called. You can get to the SkeletalMeshComponent by looking at SeqNode->SkelComponent
OnAttachToActor Source codeAttach an actor to another one. Kismet action.
OnCauseDamage Source codeCalled upon receiving a SeqAct_CauseDamage action, calls TakeDamage() with the given parameters.
@param Action - damage action that was activated
OnChangeCollision Source codeHandler for collision action, allow designer to toggle collide/block actors
OnDestroy Source codeIf this actor is not already scheduled for destruction, destroy it now.
OnHealDamage Source codeCalled upon receiving a SeqAct_HealDamage action, calls HealDamage() with the given parameters.
@param Action - heal action that was activated
OnMakeNoise Source codeForce this actor to make a noise that the AI may hear
OnRanOver Source codeCalled each frame (for each wheel) when an SVehicle has a wheel in contact with this Actor. Not called on Actors that have bWorldGeometry or bStatic set to TRUE.
OnSetBlockRigidBody Source codeHandler for the SeqAct_SetBlockRigidBody action. Allows level designer to toggle the rigid-body blocking flag on an Actor, and will handle updating the physics engine etc.
OnSetPhysics Source codeHandler for the SeqAct_SetPhysics action, allowing designer to change the Physics mode of an Actor.
OnTeleport Source codeCalled upon receiving a SeqAct_Teleport action. Grabs the first destination available and attempts to teleport this actor.
@param Action - teleport action that was activated
OnToggleHidden Source codeHandler for SeqAct_ToggleHidden, just sets bHidden.
OutsideWorldBounds Source codecalled when the Actor is outside the hard limit on world bounds @note physics and collision are automatically turned off after calling this function
OverlappingActors Source codeReturns colliding (bCollideActors==true) which overlap a Sphere from location 'Loc' and 'Radius' radius.
@param BaseClass The Actor returns must be a subclass of this.
@param out_Actor returned Actor at each iteration.
@param Radius Radius of sphere for overlapping check.
@param Loc Center of sphere for overlapping check. (Optional, caller's location is used otherwise).
@param bIgnoreHidden if true, ignore bHidden actors.
OverRotated Source codeCalled by ClampRotation if the rotator was outside of the limits
PawnBaseDied Source codeThis actor is based on a pawn and that pawn has just died.
PhysicsVolumeChange Source code
PickedUpBy Source codeimplemented by pickup type Actors to do things following a successful pickup
@param P the Pawn that picked us up
@todo remove this and fix up the DenyPickupQuery() calls that use this
PlayActorFaceFXAnim Source codePlay FaceFX animations on this Actor. Returns TRUE if succeeded, if failed, a log warning will be issued.
PlayerCanSeeMe Source codePlayerCanSeeMe returns true if any player (server) or the local player (standalone or client) has a line of sight to actor's location.
PlaySound Source codePlay a sound effect.
PlayTeleportEffect Source code
PointCheckComponent Source codeRun a point check against just this PrimitiveComponent. Return TRUE if we hit. NOTE: the actual Actor we call this on is irrelevant!
PostBeginPlay Source codeCalled immediately after gameplay begins.
PostInitAnimTree Source codecalled after initializing the AnimTree for the given SkeletalMeshComponent that has this Actor as its Owner this is a good place to cache references to skeletal controllers, etc that the Actor modifies
PostRenderFor Source codeScript function called by NativePostRenderFor().
PostTeleport Source code
PostTouch Source codeCalled for PendingTouch actor after physics completes
PreBeginPlay Source codeCalled immediately before gameplay begins.
PreTeleport Source code
RanInto Source codeCalled for encroaching actors which successfully moved the other actor out of the way.
ReplaceText Source code
ReplicatedEvent Source code
Reset Source codeReset actor to initial state - used when restarting level without reloading.
RigidBodyCollision Source codeCalled when a PrimitiveComponent this Actor owns has: -bNotifyRigidBodyCollision set to true -ScriptRigidBodyCollisionThreshold > 0 -it is involved in a physics collision where the relative velocity exceeds ScriptRigidBodyCollisionThreshold
@param HitComponent the component of this Actor that collided
@param OtherComponent the other component that collided
@param RigidCollisionData information on the collision itslef, including contact points
@param ContactIndex the element in each ContactInfos' ContactVelocity and PhysMaterial arrays that corresponds to this Actor/HitComponent
RootMotionExtracted Source codeNotification called after root motion has been extracted, and before it's been used. This notification can be used to alter extracted root motion before it is forwarded to physics. It is only called when bRootMotionExtractedNotify is TRUE on the SkeletalMeshComponent. @note: It is fairly slow in Script, so enable only when really needed.
RootMotionModeChanged Source codeNotification that root motion mode changed. Called only from SkelMeshComponents that have bRootMotionModeChangeNotify set. This is useful for synchronizing movements. For intance, when using RMM_Translate, and the event is called, we know that root motion will kick in on next frame. It is possible to kill in-game physics, and then use root motion seemlessly.
ScriptGetTeamNum Source code
SetAnimPosition Source codeCalled each from while the Matinee action is running, with the desired sequence name and position we want to be at.
SetAnimWeights Source codeCalled each from while the Matinee action is running, to set the animation weights for the actor.
SetBase Source code
SetCollision Source code
SetCollisionSize Source code
SetDrawScale Source code
SetDrawScale3D Source code
SetForcedInitialReplicatedProperty Source codeadds/removes a property from a list of properties that will always be replicated when this Actor is bNetInitial, even if the code thinks the client has the same value the server already does This is a workaround to the problem where an LD places an Actor in the level, changes a replicated variable away from the defaults, then at runtime the variable is changed back to the default but it doesn't replicate because initial replication is based on class defaults Only has an effect when called on bStatic or bNoDelete Actors Only properties already in the owning class's replication block may be specified
@param PropToReplicate the property to add or remove to the list
@param bAdd true to add the property, false to remove the property
SetGRI Source code
SetHardAttach Source code
SetHidden Source codeChanges the value of bHidden.
@param bNewHidden - The value to assign to bHidden.
SetHUDLocation Source codefunction used to update where icon for this actor should be rendered on the HUD
@param NewHUDLocation is a vector whose X and Y components are the X and Y components of this actor's icon's 2D position on the HUD
SetInitialState Source codeCalled after PostBeginPlay.
SetLocation Source codeThis function sets the location of the actor it is called on. It will not work on actors withPHYS_KarmaorPHYS_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.
SetMorphWeight Source codeCalled each frame by Matinee to update the weight of a particular MorphNodeWeight.
SetNetUpdateTime Source codeUpdates NetUpdateTime to the new value for future net relevancy checks
SetOnlyOwnerSee Source codechanges the value of bOnlyOwnerSee
@param bNewOnlyOwnerSee the new value to assign to bOnlyOwnerSee
SetOwner Source code
SetPhysics Source code
SetRelativeLocation Source code
SetRelativeRotation Source codeSets the rotation relative to the actor's base.
SetRotation Source codeThis function sets the rotation of the actor it is called on. It will not work on actors withPHYS_KarmaorPHYS_KarmaRagdoll.
SetSkelControlScale Source codeCalled each frame by Matinee to update the scaling on a SkelControl.
SetTickGroup Source codeChanges the ticking group for this actor
SetTimer Source codeSets a timer to call the given function at a set interval. Defaults to calling the 'Timer' event if no function is specified. If inRate is set to 0.f it will effectively disable the previous timer. NOTE: Functions with parameters are not supported!
@param inRate the amount of time to pass between firing
@param inbLoop whether to keep firing or only fire once
@param inTimerFunc the name of the function to call when the timer fires
SetZone Source codeupdates the zone/PhysicsVolume of this Actor
@param bForceRefresh - forces the code to do a full collision check instead of exiting early if the current info is valid
ShutDown Source codeShutDown an actor.
Sleep Source codeWaits for the specified amount of time before returning.
SpawnedByKismet Source codecalled when this Actor was spawned by a Kismet actor factory (SeqAct_ActorFactory) after all other spawn events (PostBeginPlay(), etc) have been called
SpecialHandling Source code
StopActorFaceFXAnim Source codeStop any matinee FaceFX animations on this Actor.
StopsProjectile Source code
SuggestTossVelocity Source code
TakeDamage Source codeapply some amount of damage to this actor
@param Damage the base damage to apply
@param EventInstigator the Controller responsible for the damage
@param HitLocation world location where the hit occurred
@param Momentum force caused by this hit
@param DamageType class describing the damage that was done
@param HitInfo additional info about where the hit occurred
@param DamageCauser the Actor that directly caused the damage (i.e. the Projectile that exploded, the Weapon that fired, etc)
TakeRadiusDamage Source codeTake Radius Damage by default scales damage based on distance from HurtOrigin to Actor's location. This can be overridden by the actor receiving the damage for special conditions (see KAsset.uc). This then calls TakeDamage() to go through the same damage pipeline.
@param InstigatedBy, instigator of the damage
@param Base Damage
@param Damage Radius (from Origin)
@param DamageType class
@param Momentum (float)
@param HurtOrigin, origin of the damage radius.
@param bFullDamage, if true, damage not scaled based on distance HurtOrigin
@param DamageCauser the Actor that directly caused the damage (i.e. the Projectile that exploded, the Weapon that fired, etc)
Tick Source code
Timer Source code
TimeSince Source codeRetrieves difference between world time and given time
TornOff Source code
Networking - called on client when actor is torn off (bTearOff==true)
Touch Source code
TouchingActors Source codeReturns all actors touching the current actor (fast).
Trace Source codeTrace a line and see what it collides with first. Takes this actor's collision properties into account. Returns first hit actor, Level if hit level, or None if hit nothing.
TraceActors Source codeReturn all actors along a traced line. Reasonably fast (like any trace)
TraceComponent Source codeRun a line check against just this PrimitiveComponent. Return TRUE if we hit. NOTE: the actual Actor we call this on is irrelevant!
TriggerEventClass Source codeConvenience function for triggering events in the GeneratedEvents list If you need more options (activating multiple outputs, etc), call ActivateEventClass() directly
UnClock Source codeThis is called at the end of a section of code to be timed passing in the same time variable supplied to Clock.
UnTouch Source code
UsedBy Source codeCalled when being activated by the specified pawn. Default implementation searches for any SeqEvent_Used and activates them.
@return true to indicate this actor was activated
VisibleActors Source codeReturns all visible (notbHidden) actors within a radius for which a trace fromLoc(which defaults to caller'sLocation) to that actor'sLocationdoes not hit the world.
VisibleCollidingActors Source codeReturns all colliding (bCollideActors==true) actors within a certain radius for which a trace fromLoc(which defaults to caller's Location) to that actor's Location does not hit the world.
| Defaultproperties |
|---|
defaultproperties { CustomTimeDilation=1.000000 Role=ROLE_Authority bPushedByEncroachers=True bRouteBeginPlayEvenIfStatic=True bReplicateMovement=True bMovable=True bJustTeleported=True NetUpdateFrequency=100.000000 NetPriority=1.000000 DrawScale=1.000000 DrawScale3D=(X=1.000000,Y=1.000000,Z=1.000000) CollisionType=COLLIDE_NoCollision MessageClass=Class'Engine.LocalMessage' SupportedEvents(0)=Class'Engine.SeqEvent_Touch' SupportedEvents(1)=Class'Engine.SeqEvent_Destroyed' SupportedEvents(2)=Class'Engine.SeqEvent_TakeDamage' Name="Default__Actor" ObjectArchetype=Object'Core.Default__Object' } |
| Overview | Package | Class | Source | Class tree | Glossary | UnrealScript Documentation |
| previous class next class | frames no frames | |||||