UE3:GameAIController (UDK)

Object >> Actor >> Controller >> AIController >> GameAIController

Package:

GameFramework

Implemented interfaces:

Interface_NavigationHandle

Known classes within GameAIController:

GameAICommand

Properties

Property group 'Debug'

AILogFilter

Type: array<name>

Modifiers: config

List of categories to filter

bAIDrawDebug

Type: bool

Modifiers: config

bAILogging

Type: bool

Modifiers: config

bAILogToWindow

Type: bool

Modifiers: config

bFlushAILogEachLine

Type: bool

Modifiers: config

bMapBasedLogName

Type: bool

Modifiers: config

Internal variables

AILogFile

Type: FileLog

Modifiers: transient

Debug log file,

See: AILog

bAIBroken

Type: bool

Modifiers: transient

bHasRunawayCommandList

Type: bool

Modifiers: transient

Whether this AI has a runaway loop or not. If it does we are going to do AbortCommand( CommandList ) at the end of Tick(). *

CommandList

Type: GameAICommand

Modifiers: transient, const

Current command stack, with the last element being the currently active (ticked) one

DemoActionString

Type: string

Subobjects

Sprite

Class: Engine.SpriteComponent

Inherits from: AIController.Sprite

Property	Value
ReplacementPrimitive	None

Functions

Native functions

AbortCommand

native final function bool AbortCommand (GameAICommand AbortCmd, optional class<GameAICommand> AbortClass)

AbortCommand Aborts a command (and all of its children)

Parameters:

• AbortCmd - the command to abort (can be NULL, in which case AbortClass will be used to determine which command to abort
• AbortClass - not used unless AbortCmd is NULL, in which case the first command int he stack of class 'AbortClass' will be aborted (and all its children)

CheckCommandCount

native final function CheckCommandCount ()

checks the command stack for too many commands and/or infinite recursion

DumpCommandStack

native final function DumpCommandStack ()

FindCommandOfClass

native noexport final function coerce GameAICommand FindCommandOfClass (class<GameAICommand> SearchClass)

finds and returns the lowest command of the specified class on the stack (will return subclasses of the specified class)

GetActiveCommand

native final function GameAICommand GetActiveCommand ()

GetAICommandInStack

native function GameAICommand GetAICommandInStack (const class<GameAICommand> InClass)

This will search the CommandList for the passed in command class. *

PopCommand

native final function PopCommand (GameAICommand ToBePoppedCommand)

PopCommand will pop the passed command (and everything above it in the stack)

Parameters:

• ToBePoppedCommand - the command to pop

PushCommand

native final function PushCommand (GameAICommand NewCommand)

Events

AILog_Internal

event AILog_Internal (coerce string LogText, optional name LogCategory, optional bool bForce)

Destroyed

event Destroyed ()

Overrides: Controller.Destroyed

=

DEBUG

=

GeneratePathToActor

event bool GeneratePathToActor (Actor Goal, optional float WithinDistance, optional bool bAllowPartialPath)

GeneratePathToLocation

event bool GeneratePathToLocation (Object.Vector Goal, optional float WithinDistance, optional bool bAllowPartialPath)

GetActionString

simulated final event string GetActionString ()

Other instance functions

RecordDemoAILog

protected function RecordDemoAILog (coerce string LogText)

SetDesiredRotation

function SetDesiredRotation (Object.Rotator TargetDesiredRotation, bool InLockDesiredRotation, bool InUnlockWhenReached, float InterpolationTime)

SetDesiredRotation Calls Pawn's SetDesiredRotation: Simple interface to Pawn

States

DEBUGSTATE

=

DEBUG STATES

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

DEBUGSTATE.ContinuedState

event ContinuedState ()

Overrides: Object.ContinuedState (global)

Called on the state that is no longer paused because of a PopState().

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

DEBUGSTATE.PausedState

event PausedState ()

Overrides: Object.PausedState (global)

Called on the state that is being paused because of a PushState().

DEBUGSTATE.PoppedState

event PoppedState ()

Overrides: Object.PoppedState (global)

Called immediately in the current state that is being popped off of the state stack, before the new state is activated.

DEBUGSTATE.PushedState

event PushedState ()

Overrides: Object.PushedState (global)

Called immediately in the new state that was pushed onto the state stack, before any state code is executed.