I'm a doctor, not a mechanic

UE3:GameCrowdAgent internal variables (UDK)

From Unreal Wiki, The Unreal Engine Documentation Site
Revision as of 05:39, 17 January 2010 by Wormbo (Talk | contribs) (1 revision: class descriptions for UDK January update (part 2))

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search
UDK Object >> Actor >> CrowdAgentBase >> GameCrowdAgent (internal variables)

Internal variables[edit]

AmbientSoundComponent[edit]

Type: AudioComponent

Ambient sound being played

AvoidanceShare[edit]

Type: float

Share of avoidance by this agent type

Default value: 0.5

AwareUpdateFrameCount[edit]

Type: int

Modifiers: transient

Used to count how many frames since the last conform trace.

bBadHitNormal[edit]

Type: bool

flags set for debugging (set each tick)

BeaconColor[edit]

Type: Object.LinearColor

Modifiers: const

Beacon background color

Default value:

Member Value
A 0.5
B 0.5
G 0.5
R 0.5

BeaconMaxDist[edit]

Type: float

Max distance to draw debug beacon

Default value: 1500.0

BeaconOffset[edit]

Type: Object.Vector

Debug beacon offset from Location

Default value:

Member Value
X 0.0
Y 0.0
Z 140.0

BeaconTexture[edit]

Type: Texture2D

Modifiers: const

Background texture for debug beacon

Default value: Texture2D'EngineResources.WhiteSquareTexture'

BehaviorDestination[edit]

Type: GameCrowdDestination

Last destination where performed Kismet/Behavior. Cleared when have new destination. Used to keep from looping kismet/behavior at destination.

bHasNotifiedSpawner[edit]

Type: bool

True if already notified spawner about destruction

bHitObstacle[edit]

Type: bool

flags set for debugging (set each tick)

bIsInSpawnPool[edit]

Type: bool

true if agent is currently sitting in pop mgr's agent pool

bIsPanicked[edit]

Type: bool

FIXMESTEVE - only used for animation now. Need to replace with more appropriately named property

bPotentialEncounter[edit]

Type: bool

Set when updating dynamics if agent is potential encounter for updating agent - only valid in HandlePotentialAgentEncounter() event.

bSimulateThisTick[edit]

Type: bool

Whether to perform crowd simulation this tick on this agent ( updated using ShouldPerformCrowdSimulation() )

bUniformScale[edit]

Type: bool

Whether to use same scale variation in all axes

Default value: True

bWantsGroupIdle[edit]

Type: bool

Whether should idle and wait for other group members

bWantsSeePlayerNotification[edit]

Type: bool

Note currently only checks if see player when being rendered

ConformTraceFrameCount[edit]

Type: int

Modifiers: transient

Used to count how many frames since the last conform trace.

CurrentBehavior[edit]

Type: GameCrowdAgentBehavior

Current applied behavior instance

CurrentConformTraceInterval[edit]

Type: int

Current conform interval

Default value: 10

CurrentDestination[edit]

Type: GameCrowdDestination

Current destination

DesiredGroupRadiusSq[edit]

Type: float

Keep square of DesiredGroupRadius for faster testing

ExternalForce[edit]

Type: Object.Vector

Additional force applied to this crowd agent externally - zeroed each frame.

EyeZOffset[edit]

Type: float

Eye Z offset from location

Default value: 40.0

ForceUpdateTime[edit]

Type: float

World time when agent was spawned or last rendered

InitialLastRenderTime[edit]

Type: float

Initial setting of LastRenderTime (used to see if agent was ever actually rendered)

IntermediatePoint[edit]

Type: Object.Vector

Current movement destination intermediate to reaching CurrentDestination

InterpZTranslation[edit]

Type: float

If conforming to ground, this is how much to move the agent each frame between line-trace updates.

LastGroundZ[edit]

Type: float

TEMP for debugging - last ground conform hit normal Z

LastKnownGoodPosition[edit]

Type: Object.Vector

Last position validated by collision trace

LastPathingAttempt[edit]

Type: float

Last time pathing was attempted for this agent

LastUpdateTime[edit]

Type: float

Used to limit update frequency of agents that are not visible

LightEnvironment[edit]

Type: DynamicLightEnvironmentComponent

Modifiers: const, editconst

Pointer to LightEnvironment

Default value: DynamicLightEnvironmentComponent'MyLightEnvironment'

MaxLOSLifeDistanceSq[edit]

Type: float

Keep square of MaxLOSLifeDistance for faster testing

MaxSeePlayerDistSq[edit]

Type: float

Calculated from behaviors in SeePlayerList

MaxSpeed[edit]

Type: float

Current max speed

MyArchetype[edit]

Type: GameCrowdAgent

Archetype used to spawn this agent

MyGroup[edit]

Type: GameCrowdGroup

Agent group this agent is part of

MySpawner[edit]

Type: GameCrowdSpawnerInterface

Actor with GameCrowdSpawnerInterface which spawned this agent

NavigationHandle[edit]

Type: NavigationHandle


NavigationHandleClass[edit]

Type: class<NavigationHandle>

Navigation Handle used by agents requesting pathing

Default value: Class'Engine.NavigationHandle'

NearbyDynamics[edit]

Type: array<Actor>

Modifiers: transient

Nearby pawns and agents. Updated periodically (AwareUpdateInterval) using main Octree FIXMESTEVE - do we need more than one array, and should we put other dynamic actors in it?

ObstacleCheckCount[edit]

Type: int


PreferredVelocity[edit]

Type: Object.Vector

Velocity in the absence of other agent interactions

PreviousDestination[edit]

Type: GameCrowdDestination

where agent is coming from

ReachThreshold[edit]

Type: float

Random variation in how closely agent must reach destination (0.5 to 1.0)

Default value: 1.0

RecentInteractions[edit]

Type: array<RecentInteraction>


RelevantAttractors[edit]

Type: array<GameCrowdForcePoint>

Modifiers: transient

Updated by touch using main Octree

SearchExtent[edit]

Type: Object.Vector

bounding box to use for pathing queries

Default value:

Member Value
X 15.0
Y 15.0
Z 40.0

SpawnOffset[edit]

Type: Object.Vector

Used for keeping groups spawned together

WalkableFloorZ[edit]

Type: float

Used for accessing potential obstacles - not an obstacle if hitnormal.Z > WalkableFloorZ

Default value: 0.7