Difference between revisions of "UE3:UTVehicleFactory (UDK)"

Revision as of 06:24, 17 January 2010 (edit) (Talk) ← Older edit	Latest revision as of 07:03, 17 January 2010 (edit) (undo) Wormbo (Talk | contribs) m (1 revision: class descriptions for UDK January update (part 9))
(No difference)

---

Latest revision as of 07:03, 17 January 2010

Package: 

UTGame

Direct subclasses:

UTVehicleFactory_Cicada, UTVehicleFactory_Manta, UTVehicleFactory_Scorpion

This class in other games:

UT3

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.

Vehicle spawner.

Properties[edit]

Property group 'UTVehicleFactory'[edit]

bDisabled[edit]

Type: bool

vehicle factory can't be activated while this is set

bForceAvoidReversing[edit]

Type: bool

if set, force bAvoidReversing to true on the vehicle for the AI

bKeyVehicle[edit]

Type: bool

If set, vehicles from this factory will be key vehicles (for AI) and show up on minimap

bMayReverseSpawnDirection[edit]

Type: bool

Reverse spawn direction depending on which team controls vehicle factory

bStartNeutral[edit]

Type: bool

Not applicable to Warfare

InitialGunRotations[edit]

Type: array<Object.Rotator>

This array holds the initial gun rotations for a spawned vehicle.

TeamSpawningControl[edit]

Type: ETeamSpawning

allows setting this vehicle factory to only spawn when one team controls this factory

Internal variables[edit]

bHasLockedVehicle[edit]

Type: bool

Whether vehicles spawned at this factory are initially team locked

bReplicateChildVehicle[edit]

Type: bool

if set, replicate ChildVehicle reference

ChildVehicle[edit]

Type: UTVehicle

HUDLocation[edit]

Type: Object.Vector

RespawnProgress[edit]

Type: float

RespawnRateModifier[edit]

Type: float

Timer for determining when to spawn vehicles

Default value: 1.0

ReverseObjective[edit]

Type: UTGameObjective

SpawnZOffset[edit]

Type: float

TeamNum[edit]

Type: int

Reverse spawn dir if controlled by same team controlling this objective

Default value: 255

VehicleClass[edit]

Type: class<UTVehicle>

actual vehicle class to spawn. DO NOT SET THIS IN DEFAULT PROPERTIES - set VehicleClassPath instead

VehicleClassPath[edit]

Type: string

full package.class for the vehicle class. You should set this in the default properties, NOT VehicleClass. this indirection is needed for the cooker, so it can fully clear references to vehicles that won't be spawned on the target platform if the direct class reference were in the default properties, this wouldn't be possible without deleting the factory outright, which we can't do without breaking paths

Default values[edit]

Property	Value
bAlwaysRelevant	True
bBlockable	True
bHidden	True
bSkipActorPropertyReplication	True
bStatic	False
Components[1]	ArrowComponent'Arrow'
Components[2]	CylinderComponent'CollisionCylinder'
Components[3]	PathRenderingComponent'PathRenderer'
Components[4]	DynamicLightEnvironmentComponent'MyLightEnvironment'
Components[5]	SkeletalMeshComponent'SVehicleMesh'
NetUpdateFrequency	1.0
RemoteRole	ROLE_SimulatedProxy
SupportedEvents[4]	Class'UTGame.UTSeqEvent_VehicleFactory'

Subobjects[edit]

Arrow[edit]

Class: Engine.ArrowComponent

Inherits from: NavigationPoint.Arrow

Property	Value
ReplacementPrimitive	None

CollisionCylinder[edit]

Class: Engine.CylinderComponent

Inherits from: NavigationPoint.CollisionCylinder

Property	Value
ReplacementPrimitive	None

MyLightEnvironment[edit]

Class: Engine.DynamicLightEnvironmentComponent

No new values.

PathRenderer[edit]

Class: Engine.PathRenderingComponent

Inherits from: NavigationPoint.PathRenderer

Property	Value
ReplacementPrimitive	None

Sprite[edit]

Class: Engine.SpriteComponent

Inherits from: NavigationPoint.Sprite

Property	Value
ReplacementPrimitive	None

SVehicleMesh[edit]

Class: Engine.SkeletalMeshComponent

Property	Value
AlwaysLoadOnClient	False
AlwaysLoadOnServer	False
bUpdateSkelWhenNotRendered	False
HiddenGame	True
LightEnvironment	DynamicLightEnvironmentComponent'UTGame.Default__UTVehicleFactory:MyLightEnvironment'
ReplacementPrimitive	None

Enums[edit]

ETeamSpawning[edit]

allows setting this vehicle factory to only spawn when one team controls this factory

TS_All 

TS_AxonOnly 

TS_NecrisOnly 

Functions[edit]

Native functions[edit]

GetTeamNum[edit]

Overrides: Actor.GetTeamNum

SetHUDLocation[edit]

Overrides: Actor.SetHUDLocation

function used to update where icon for this actor should be rendered on the HUD

Parameters:

• 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

Events[edit]

PostBeginPlay[edit]

Overrides: Actor.PostBeginPlay

SetInitialState[edit]

Overrides: Actor.SetInitialState

SpawnVehicle[edit]

Other instance functions[edit]

Activate[edit]

AddToClosestObjective[edit]

CanActivateForTeam[edit]

Deactivate[edit]

GetSpawnRotation[edit]

OnToggle[edit]

Overrides: NavigationPoint.OnToggle

Toggle the blocked state of a navigation point.

RenderMapIcon[edit]

TarydiumBoost[edit]

TriggerSpawnedEvent[edit]

VehicleDestroyed[edit]

VehicleTaken[edit]

called when someone starts driving our child vehicle

States[edit]

Active[edit]

Active.BeginState[edit]

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).

Active.EndState[edit]

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.

Active.SpawnVehicle[edit]

Overrides: SpawnVehicle (global)

Active.Activate[edit]

Overrides: Activate (global)

Active.TarydiumBoost[edit]

Overrides: TarydiumBoost (global)

Active.VehicleDestroyed[edit]

Overrides: VehicleDestroyed (global)