UE3:UTVehicle events (UDK)

Object >> Actor >> Pawn >> Vehicle >> SVehicle >> UTVehicleBase >> UTVehicle (events)

UTVehicle events in other games:

UT3

Other member categories for this class:

instance functions, internal variables, structs, Hoverboard instance functions, Hoverboard internal variables, Manta defaults, Manta properties, Manta Content defaults, Scorpion defaults, Scorpion instance functions, Scorpion internal variables, Scorpion Content defaults

Events

ApplyMorphHeal

simulated event ApplyMorphHeal (int Amount)

Since vehicles can be healed, we need to apply the healing to each MorphTarget. Since damage modeling is client-side and healing is server-side, we evenly apply healing to all nodes

Parameters:

• Amount - How much health to heal

CheckReset

event CheckReset ()

Vehicle has been in the middle of nowhere with no driver for a while, so consider resetting it

ContinueOnFoot

event bool ContinueOnFoot ()

Overrides: Vehicle.ContinueOnFoot

ContinueOnFoot() - used by AI Called from route finding if route can only be continued on foot.

Returns:

true if driver left vehicle

Destroyed

simulated event Destroyed ()

Overrides: SVehicle.Destroyed

Called when the vehicle is destroyed. Clean up the seats/effects/etc

DisplayWeaponBar

event DisplayWeaponBar (Canvas canvas, UTHUD HUD)

DriverLeave

event bool DriverLeave (bool bForceLeave)

Overrides: Vehicle.DriverLeave

Called when the driver leaves the vehicle

Parameters:

• bForceLeave - Is true if the driver was forced out

FellOutOfWorld

simulated event FellOutOfWorld (class<DamageType> dmgType)

Overrides: Pawn.FellOutOfWorld

called when the actor falls out of the world 'safely' (below KillZ and such)

GetBarrelLocationAndRotation

simulated event GetBarrelLocationAndRotation (int SeatIndex, out Object.Vector SocketLocation, optional out Object.Rotator SocketRotation)

GetHomingTarget

event Actor GetHomingTarget (UTProjectile Seeker, Controller InstigatedBy)

GetHomingTarget is called from projectiles looking to seek to this vehicle. It returns the actor the projectile should target

Parameters:

• Seeker - The projectile that seeking this vehcile
• InstigatedBy - Who is controlling that projectile

Returns:

the target to see

GetViewRotation

simulated event Object.Rotator GetViewRotation ()

Overrides: Pawn.GetViewRotation

(Description copied from Pawn.GetViewRotation)

Returns:

the rotation the Pawn is looking

HealDamage

event bool HealDamage (int Amount, Controller Healer, class<DamageType> DamageType)

Overrides: Pawn.HealDamage

This function is called to heal the vehicle

See: Actor.HealDamage()

HoldGameObject

simulated event HoldGameObject (UTCarriedObject GameObj)

Overrides: UTVehicleBase.HoldGameObject

HoldGameObject() Attach GameObject to mesh.

Parameters:

• GameObj - Game object to hold

IncomingMissile

event IncomingMissile (Projectile P)

This function is called from an incoming missile that is targetting this vehicle

Parameters:

• P - The incoming projectile

JumpOutCheck

event JumpOutCheck ()

JumpOutCheck() Check if bot wants to jump out of vehicle, which is currently descending towards its destination

LockOnWarning

simulated event LockOnWarning (UTProjectile IncomingMissile)

LockOnWarning() called by seeking missiles to warn vehicle they are incoming

MorphTargetDestroyed

simulated event MorphTargetDestroyed (int MorphNodeIndex)

The event is called from the native function ApplyMorphDamage when a node is destroyed (health <= 0).

Parameters:

• MorphNodeIndex - The Index of the node that was destroyed

OnAnimEnd

event OnAnimEnd (AnimNodeSequence SeqNode, float PlayedTime, float ExcessTime)

Overrides: Actor.OnAnimEnd

(Description copied from Actor.OnAnimEnd)
Event 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.

Parameters:

• SeqNode - Node that finished playing. You can get to the SkeletalMeshComponent by looking at SeqNode->SkelComponent
• PlayedTime - Time played on this animation. (play rate independant).
• ExcessTime - how much time overlapped beyond end of animation. (play rate independant).

OnPropertyChange

event OnPropertyChange (name PropName)

PlayTakeHitEffects

simulated event PlayTakeHitEffects ()

plays take hit effects; called from PlayHit() on server and whenever LastTakeHitInfo is received on the client

PostBeginPlay

simulated event PostBeginPlay ()

Overrides: SVehicle.PostBeginPlay

Initialization

PostRenderFor

simulated event PostRenderFor (PlayerController PC, Canvas Canvas, Object.Vector CameraPosition, Object.Vector CameraDir)

Overrides: Actor.PostRenderFor

PostRenderFor() Hook to allow pawns to render HUD overlays for themselves. Assumes that appropriate font has already been set

Parameters:

• PC - The Player Controller who is rendering this pawn
• Canvas - The canvas to draw on

RanInto

event RanInto (Actor Other)

Overrides: Actor.RanInto

RanInto() called for encroaching actors which successfully moved the other actor out of the way

Parameters:

• Other - The pawn that was hit

RBPenetrationDestroy

event RBPenetrationDestroy ()

Called when a contact with a large penetration occurs.

ReceivedHealthChange

simulated event ReceivedHealthChange ()

called when the client receives a change to Health if LastTakeHitInfo changed in the same received bunch, always called *after* PlayTakeHitEffects() (this is so we can use the damage info first for more accurate modelling and only use the direct health change for corrections)

ReplicatedEvent

simulated event ReplicatedEvent (name VarName)

Overrides: Vehicle.ReplicatedEvent

This event is triggered when a repnotify variable is received

Parameters:

• VarName - The name of the variable replicated

RigidBodyCollision

simulated event RigidBodyCollision (PrimitiveComponent HitComponent, PrimitiveComponent OtherComponent, const out Actor.CollisionImpactData Collision, int ContactIndex)

Overrides: SVehicle.RigidBodyCollision

(Description copied from Actor.RigidBodyCollision)
Called 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

Parameters:

• HitComponent - the component of this Actor that collided
• OtherComponent - the other component that collided
• RigidCollisionData - information on the collision itslef, including contact points
• ContactIndex - the element in each ContactInfos' ContactVelocity and PhysMaterial arrays that corresponds to this Actor/HitComponent

SelfDestruct

event SelfDestruct (Actor ImpactedActor)

SetKeyVehicle

event SetKeyVehicle ()

SetTeamNum

event SetTeamNum (byte T)

Team is changed when vehicle is possessed

TakeDamage

simulated event TakeDamage (int Damage, Controller EventInstigator, Object.Vector HitLocation, Object.Vector Momentum, class<DamageType> DamageType, optional Actor.TraceHitInfo HitInfo, optional Actor DamageCauser)

Overrides: Vehicle.TakeDamage

See: Actor.TakeDamage()

TakeFireDamage

event TakeFireDamage ()

This event occurs when the physics determines the vehicle is upside down or empty and on fire. Called from AUTVehicle::TickSpecial()

TakeWaterDamage

event TakeWaterDamage ()

TakeWaterDamage() called every tick when AccumulatedWaterDamage>0 and PhysicsVolume.bWaterVolume=true

Parameters:

• DeltaTime - The amount of time passed since it was last called

TornOff

simulated event TornOff ()

Overrides: Pawn.TornOff

This event is called when the pawn is torn off