I don't need to test my programs. I have an error-correcting modem.
UE3:Actor instance functions (UDK)
Contents
- 1 Instance functions
- 1.1 ActivateEventClass
- 1.2 ApplyFluidSurfaceImpact
- 1.3 CalcCamera
- 1.4 CanActorPlayFaceFXAnim
- 1.5 CanSplash
- 1.6 CheckForErrors
- 1.7 CheckHitInfo
- 1.8 CheckMaxEffectDistance
- 1.9 ClearLatentAction
- 1.10 DisplayDebug
- 1.11 DoKismetAttachment
- 1.12 EffectIsRelevant
- 1.13 FindActorsOfClass
- 1.14 FindEventsOfClass
- 1.15 FindGoodEndView
- 1.16 GetAimAdhesionExtent
- 1.17 GetAimFrictionExtent
- 1.18 GetDebugName
- 1.19 GetHumanReadableName
- 1.20 GetItemName
- 1.21 GetLocationStringFor
- 1.22 GetPhysicsName
- 1.23 GetRemainingTimeForTimer
- 1.24 HurtRadius
- 1.25 IsActorPlayingFaceFXAnim
- 1.26 IsClient
- 1.27 IsInPain
- 1.28 IsInVolume
- 1.29 IsOwningClient
- 1.30 IsServer
- 1.31 IsStationary
- 1.32 KilledBy
- 1.33 MatchStarting
- 1.34 NotifyLocalPlayerTeamReceived
- 1.35 OnAttachToActor
- 1.36 OnChangeCollision
- 1.37 OnDestroy
- 1.38 OnModifyHealth
- 1.39 OnSetBlockRigidBody
- 1.40 OnSetPhysics
- 1.41 OnSetVelocity
- 1.42 OnTeleport
- 1.43 OnToggleHidden
- 1.44 PawnBaseDied
- 1.45 PickedUpBy
- 1.46 PlayTeleportEffect
- 1.47 PostTeleport
- 1.48 PreTeleport
- 1.49 SetGRI
- 1.50 StopsProjectile
- 1.51 TakeRadiusDamage
- 1.52 TriggerEventClass
- 1.53 TriggerGlobalEventClass
- 1.54 UsedBy
- 1.55 VolumeBasedDestroy
- Actor instance functions in other games:
- U2, U2XMP, UT2004, UT3
- Other member categories for this class:
- enums, events, internal variables, native functions, structs
This is an auto-generated page and may need human attention. Please remove the {{autogenerated}} tag if the page seems reasonably complete or replace it with the {{expand}} tag if the page is not yet complete. |
Instance functions[edit]
ActivateEventClass[edit]
Iterates through the given list of events and looks for all matching events, activating them as found.
Returns:
- true if an event was found and activated
ApplyFluidSurfaceImpact[edit]
Called when this actor touches a fluid surface
CalcCamera[edit]
Calculate camera view point, when viewing this actor.
Parameters:
- fDeltaTime - delta time seconds since last update
- out_CamLoc - Camera Location
- out_CamRot - Camera Rotation
- out_FOV - Field of View
Returns:
- true if Actor should provide the camera point of view.
CanActorPlayFaceFXAnim[edit]
Returns FALSE if Actor can play facefx Implement in sub-class.
CanSplash[edit]
Called when this actor touches a WaterVolume to let the volume know if it may spawn an effect.
CheckForErrors[edit]
CheckHitInfo[edit]
Make 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().
Parameters:
- HitInfo - initial structure to check
- FallBackComponent - PrimitiveComponent to use if HitInfo.HitComponent is none
- Dir - Direction to use if a Trace needs to be performed to find BoneName on skeletalmesh. Trace from HitLocation.
- out_HitLocation - HitLocation to use for potential Trace, will get updated by Trace.
CheckMaxEffectDistance[edit]
ClearLatentAction[edit]
Clears all latent actions of the specified class.
Parameters:
- actionClass - type of latent action to clear
- bAborted - was this latent action aborted?
- exceptionAction - action to skip
DisplayDebug[edit]
list important Actor variables on canvas. HUD will call DisplayDebug() on the current ViewTarget when the ShowDebug exec is used
Parameters:
- HUD - HUD with canvas to draw on
- out_YL - Height of the current font
- out_YPos - Y position on Canvas. out_YPos += out_YL, gives position to draw text for next debug line.
DoKismetAttachment[edit]
Performs actual attachment. Can be subclassed for class specific behaviors.
EffectIsRelevant[edit]
FindActorsOfClass[edit]
Searches for actors of the specified class.
FindEventsOfClass[edit]
Builds a list of all events of the specified class.
Parameters:
- eventClass - type of event to search for
- out_EventList - list of found events
- bIncludeDisabled - will not filter out the events with bEnabled = FALSE
Returns:
- true if any events were found
FindGoodEndView[edit]
Used by PlayerController.FindGoodView() in RoundEnded State
GetAimAdhesionExtent[edit]
Returns aim-adhesion zone extents for this actor. Extents are in world units centered around Actor's location, and assumed to be oriented to face the viewer (like a billboard sprite).
GetAimFrictionExtent[edit]
Returns aim-friction zone extents for this actor. Extents are in world units centered around Actor's location, and assumed to be oriented to face the viewer (like a billboard sprite).
GetDebugName[edit]
GetHumanReadableName[edit]
GetItemName[edit]
GetLocationStringFor[edit]
GetPhysicsName[edit]
GetRemainingTimeForTimer[edit]
HurtRadius[edit]
IsActorPlayingFaceFXAnim[edit]
Returns TRUE if Actor is playing a FaceFX anim. Implement in sub-class.
IsClient[edit]
IsInPain[edit]
IsInVolume[edit]
IsOwningClient[edit]
IsServer[edit]
IsStationary[edit]
KilledBy[edit]
MatchStarting[edit]
NotifyLocalPlayerTeamReceived[edit]
OnAttachToActor[edit]
Attach an actor to another one. Kismet action.
OnChangeCollision[edit]
Handler for collision action, allow designer to toggle collide/block actors
OnDestroy[edit]
If this actor is not already scheduled for destruction, destroy it now.
OnModifyHealth[edit]
OnSetBlockRigidBody[edit]
Handler 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[edit]
Handler for the SeqAct_SetPhysics action, allowing designer to change the Physics mode of an Actor.
OnSetVelocity[edit]
Handler for the SeqAct_SetVelocity action. Allows level designer to impart a velocity on the actor.
OnTeleport[edit]
Called upon receiving a SeqAct_Teleport action. Grabs the first destination available and attempts to teleport this actor.
Parameters:
- Action - teleport action that was activated
OnToggleHidden[edit]
Handler for SeqAct_ToggleHidden, just sets bHidden.
PawnBaseDied[edit]
PickedUpBy[edit]
implemented by pickup type Actors to do things following a successful pickup
Parameters:
- P - the Pawn that picked us up
Todo: remove this and fix up the DenyPickupQuery() calls that use this
PlayTeleportEffect[edit]
PostTeleport[edit]
PreTeleport[edit]
SetGRI[edit]
StopsProjectile[edit]
TakeRadiusDamage[edit]
Take 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.
Parameters:
- InstigatedBy - instigator of the damage
- BaseDamage -
- DamageRadius - from Origin)
- DamageType - class
- Momentum - float)
- HurtOrigin - origin of the damage radius.
- bFullDamage - if true, damage not scaled based on distance HurtOrigin
- DamageCauser - the Actor that directly caused the damage (i.e. the Projectile that exploded, the Weapon that fired, etc)
- DamageFalloff - allows for nonlinear damage falloff from the point. Default is linera.
Returns:
- Returns amount of damage applied.
TriggerEventClass[edit]
Convenience function for triggering events in the GeneratedEvents list If you need more options (activating multiple outputs, etc), call ActivateEventClass() directly
TriggerGlobalEventClass[edit]
trigger a "global" Kismet event (one that doesn't have an Originator, generally because it's triggered by a game-time object)
UsedBy[edit]
Called when being activated by the specified pawn. Default implementation searches for any SeqEvent_Used and activates them.
Returns:
- true to indicate this actor was activated
VolumeBasedDestroy[edit]
Called when an Actor should be destroyed by a pain volume.