UE3:UTVehicle_Deployable (UT3)

Object >> Actor >> Pawn >> Vehicle >> SVehicle >> UTVehicleBase >> UTVehicle >> UTVehicle_Deployable

Package: 

UTGame

Direct subclasses:

UTStealthVehicle, UTVehicle_Leviathan, UTVehicle_SPMA

Copyright 1998-2007 Epic Games, Inc. All Rights Reserved.

Properties

Property group 'Deploy'

bAllowAbortDeploy

Type: bool

bRequireAllWheelsOnGround

Type: bool

Default value: True

MaxDeploySpeed

Type: float

Default value: 100.0

Internal variables

AnimPlay

Type: AnimNodeSequence

Helper to allow quick access to playing deploy animations

bDrawCanDeployTooltip

Type: bool

Check on timer to see if we can deploy/draw tool tip

DeployAnim

Type: name

Array size: 2

DeployedEnterSound

Type: SoundCue

DeployedExitSound

Type: SoundCue

DeployedState

Type: EDeployState

Modifiers: repnotify

If true, this SPMA is deployed

DeployIconOffset

Type: float

Default value: 0.95

DeploySound

Type: SoundCue

Sounds

DeploySoundComp

Type: AudioComponent

DeployTime

Type: float

How long does it take to deploy

Default value: 2.1

GetInAnim

Type: name

Array size: 2

Animations

GetOutAnim

Type: name

Array size: 2

IdleAnim

Type: name

Array size: 2

LastDeployStartTime

Type: float

TimeSinceLastDeployCheck

Type: float

Time stamp for last deploy check

ToolTipIconCoords

Type: UIRoot.TextureCoordinates

Coordinates for the tooltip textures

UndeploySound

Type: SoundCue

UnDeployTime

Type: float

How long does it take to undeploy

Default value: 2.0

Default values

Property	Value
StayUprightConstraintInstance	RB_ConstraintInstance'UTGame.Default__UTVehicle_Deployable:MyStayUprightConstraintInstance'
StayUprightConstraintSetup	RB_StayUprightSetup'UTGame.Default__UTVehicle_Deployable:MyStayUprightSetup'

Subobjects

CollisionCylinder

Class: Engine.CylinderComponent

Inherits from: UTVehicle.CollisionCylinder

No new values.

MyLightEnvironment

Class: Engine.DynamicLightEnvironmentComponent

Inherits from: UTVehicle.MyLightEnvironment

No new values.

MyStayUprightConstraintInstance

Class: Engine.RB_ConstraintInstance

Inherits from: UTVehicle.MyStayUprightConstraintInstance

No new values.

MyStayUprightSetup

Class: Engine.RB_StayUprightSetup

Inherits from: UTVehicle.MyStayUprightSetup

No new values.

SVehicleMesh

Class: Engine.SkeletalMeshComponent

Inherits from: UTVehicle.SVehicleMesh

No new values.

Enums

EDeployState

EDS_Undeployed 

EDS_Deploying 

EDS_AbortDeploying 

EDS_Deployed 

EDS_UnDeploying 

Functions

Events

CanDeploy

event bool CanDeploy (optional bool bShowMessage)

Returns:

true if this vehicle can deploy

OnAnimEnd

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

Overrides: UTVehicle.OnAnimEnd

Play the ambients when an action anim finishes

PostBeginPlay

simulated event PostBeginPlay ()

Overrides: UTVehicle.PostBeginPlay

Initialization

ReplicatedEvent

simulated event ReplicatedEvent (name VarName)

Overrides: UTVehicle.ReplicatedEvent

(Description copied from UTVehicle.ReplicatedEvent)
This event is triggered when a repnotify variable is received

Parameters:

• VarName - The name of the variable replicated

Other instance functions

AttachDriver

simulated function AttachDriver (Pawn P)

Overrides: UTVehicle.AttachDriver

Play Enter Animations

ChangeDeployState

function ChangeDeployState (EDeployState NewState)

DeployedStateChanged

simulated function DeployedStateChanged ()

DetachDriver

simulated function DetachDriver (Pawn P)

Overrides: UTVehicle.DetachDriver

Play Exit Animation

DisplayHud

simulated function DisplayHud (UTHUD Hud, Canvas Canvas, Object.Vector2D HudPOS, optional int SeatIndex)

Overrides: UTVehicle.DisplayHud

DoJump

function bool DoJump (bool bUpdating)

Overrides: Pawn.DoJump

Jump Deploys / Undeploys

IsDeployed

simulated function bool IsDeployed ()

PlayAnim

simulated function PlayAnim (name AnimName, optional float AnimDuration)

ServerToggleDeploy

reliable server function ServerToggleDeploy ()

SetVehicleDeployed

simulated function SetVehicleDeployed ()

SetVehicleUndeployed

simulated function SetVehicleUndeployed ()

SetVehicleUndeploying

simulated function SetVehicleUndeploying ()

ShouldClamp

simulated function bool ShouldClamp ()

Overrides: UTVehicle.ShouldClamp

StartEngineSound

simulated function StartEngineSound ()

Overrides: SVehicle.StartEngineSound

turns on the engine sound

StopAnim

simulated function StopAnim ()

VehiclePlayEnterSound

simulated function VehiclePlayEnterSound ()

Overrides: SVehicle.VehiclePlayEnterSound

VehiclePlayExitSound

simulated function VehiclePlayExitSound ()

Overrides: SVehicle.VehiclePlayExitSound

States

Deployed

Deployed.BeginState

event BeginState (name PreviousStateName)

Overrides: Object.BeginState (global)

Called immediately when entering a state, while within the GotoState() call that caused the state change (before any state code is executed).

Deployed.EndState

event EndState (name NextStateName)

Overrides: Object.EndState (global)

Called immediately before going out of the current state, while within the GotoState() call that caused the state change, and before BeginState() is called within the new state.

Deployed.CheckStability

function CheckStability ()

traces down to the ground from the wheels and undeploys the vehicle if wheels are too far off the ground

Deployed.DrivingStatusChanged

simulated function DrivingStatusChanged ()

Overrides: UTVehicle.DrivingStatusChanged (global)

This function is called when the driver's status has changed.

Deployed.ServerToggleDeploy

reliable server function ServerToggleDeploy ()

Overrides: ServerToggleDeploy (global)

Deploying

Deploying.BeginState

simulated event BeginState (name PreviousStateName)

Overrides: Object.BeginState (global)

Called immediately when entering a state, while within the GotoState() call that caused the state change (before any state code is executed).

Deploying.BackToUndeployed

simulated function BackToUndeployed ()

Deploying.ServerToggleDeploy

reliable server function ServerToggleDeploy ()

Overrides: ServerToggleDeploy (global)

Deploying.VehicleIsDeployed

simulated function VehicleIsDeployed ()

UnDeploying

Modifiers: simulated

UnDeploying.BeginState

simulated event BeginState (name PreviousStateName)

Overrides: Object.BeginState (global)

Called immediately when entering a state, while within the GotoState() call that caused the state change (before any state code is executed).

UnDeploying.ServerToggleDeploy

reliable server function ServerToggleDeploy ()

Overrides: ServerToggleDeploy (global)

UnDeploying.VehicleUnDeployIsFinished

simulated function VehicleUnDeployIsFinished ()