Overview Package Class Source Class tree Glossary
previous class      next class frames      no frames

Tyrion.AI_Goal

Extends
Tyrion_GoalBase
Modifiers
implements ISensorNotification native abstract dependsOn ( AI_Resource )

Core.Object
|   
+-- Core.RefCount
   |   
   +-- Engine.Tyrion_GoalBase
      |   
      +-- Tyrion.AI_Goal

Direct Known Subclasses:

AI_CharacterGoal, AI_DriverGoal, AI_GunnerGoal, AI_HeadGoal, AI_MovementGoal, AI_SquadGoal, AI_VehicleGoal, AI_WeaponGoal

Variables Summary
AI_ActionachievingAction
AI_SensorWithBoundsactivationSentinel
boolbDeleted
boolbGoalAchieved
boolbGoalConsidered
boolbGoalFailed
boolbInactive
boolbPermanent
boolbTerminateIfStolen
boolbWakeUpPoster
AI_SensorWithBoundsdeactivationSentinel
intignoreCounter
intmatchedN
Array<IGoalNotification>notificationRecipients
AI_ActionparentAction
AI_Resourceresource
AI_Goal
boolbRemoveGoalOfSameType
boolbTryOnlyOnce
StringgoalName
intPriority
Inherited Variables from Core.RefCount
LatentStackLocations, m_RefCount

Functions Summary
function activate ()))
function addNotificationRecipient (IGoalNotification notificationRecipient ))
functionbool beingAchieved ()))
function changePriority (int newPriority ))
function cleanup ()))
function construct (AI_Resource r ))
function deactivate ()))
functionAI_Goal findGoalByName (Actor a, String gName ))
functionAI_Goal findGoalInCharacterByName (Character c, String gName ))
functionAI_Goal findGoalInSquadByName (SquadInfo si, String gName ))
functionAI_Goal findGoalInTurretByName (Turret turret, String gName ))
functionAI_Goal findGoalInVehicleByName (Vehicle vehicle, String gName ))
functionAI_Resource getResource ()))
function handleGoalFailure ()))
function handleGoalSuccess ()))
functionbool hasCompleted ()))
function init (AI_Resource r ))
function markGoalAsAchieved ()))
function markGoalAsFailed ()))
functionAI_Goal myAddRef ()))
function notifyCompletion (bool bAchieved ))
function onSensorMessage (AI_Sensor sensor, AI_SensorData value, Object userData ))
functionAI_Goal postGoal (AI_Action parent ))
eventint priorityFn ()))
function setUpDeactivationSentinel ()
function unPostGoal (AI_Action parent ))
functionbool wasAchieved ()))
functionbool wasConsidered ()))
functionbool wasNotAchieved ()))
Inherited Functions from Engine.Tyrion_GoalBase
findResource, getResourceClass, goalDebuggingString
Inherited Functions from Core.RefCount
AddRef, Release


Variables Detail

achievingAction Source code

var AI_Action achievingAction;

activationSentinel Source code

var AI_SensorWithBounds activationSentinel;

bDeleted Source code

var bool bDeleted;

bGoalAchieved Source code

var bool bGoalAchieved;

bGoalConsidered Source code

var bool bGoalConsidered;

bGoalFailed Source code

var bool bGoalFailed;

bInactive Source code

var bool bInactive;

bPermanent Source code

var bool bPermanent;

bTerminateIfStolen Source code

var bool bTerminateIfStolen;

bWakeUpPoster Source code

var bool bWakeUpPoster;

deactivationSentinel Source code

var AI_SensorWithBounds deactivationSentinel;

ignoreCounter Source code

var int ignoreCounter;

matchedN Source code

var int matchedN;

notificationRecipients Source code

var Array<IGoalNotification> notificationRecipients;

parentAction Source code

var AI_Action parentAction;

resource Source code

var AI_Resource resource;

AI_Goal

bRemoveGoalOfSameType Source code

var(AI_Goal) bool bRemoveGoalOfSameType;
remove an existing goal of the same type before adding this one

bTryOnlyOnce Source code

var(AI_Goal) bool bTryOnlyOnce;
when true, don't try to achieve goal more than once (i.e. remove if it fails)

goalName Source code

var(AI_Goal) String goalName;
reference to this goal for script actions

Priority Source code

var(AI_Goal) int Priority;
in the range [0, 100]; higher number means higher priority


Functions Detail

activate Source code

function activate ( ) )

addNotificationRecipient Source code

function addNotificationRecipient ( IGoalNotification notificationRecipient ) )

beingAchieved Source code

function bool beingAchieved ( ) )

changePriority Source code

function changePriority ( int newPriority ) )

cleanup Source code

function cleanup ( ) )

construct Source code

overloaded function construct ( AI_Resource r ) )

deactivate Source code

function deactivate ( ) )

findGoalByName Source code

static function AI_Goal findGoalByName ( Actor a, String gName ) )

findGoalInCharacterByName Source code

static function AI_Goal findGoalInCharacterByName ( Character c, String gName ) )

findGoalInSquadByName Source code

static function AI_Goal findGoalInSquadByName ( SquadInfo si, String gName ) )

findGoalInTurretByName Source code

static function AI_Goal findGoalInTurretByName ( Turret turret, String gName ) )

findGoalInVehicleByName Source code

static function AI_Goal findGoalInVehicleByName ( Vehicle vehicle, String gName ) )

getResource Source code

function AI_Resource getResource ( ) )

handleGoalFailure Source code

function handleGoalFailure ( ) )

handleGoalSuccess Source code

function handleGoalSuccess ( ) )

hasCompleted Source code

function bool hasCompleted ( ) )

init Source code

function init ( AI_Resource r ) )

markGoalAsAchieved Source code

function markGoalAsAchieved ( ) )

markGoalAsFailed Source code

function markGoalAsFailed ( ) )

myAddRef Source code

function AI_Goal myAddRef ( ) )

notifyCompletion Source code

function notifyCompletion ( bool bAchieved ) )

onSensorMessage Source code

function onSensorMessage ( AI_Sensor sensor, AI_SensorData value, Object userData ) )

postGoal Source code

function AI_Goal postGoal ( AI_Action parent ) )

priorityFn Source code

event int priorityFn ( ) )

setUpDeactivationSentinel Source code

function setUpDeactivationSentinel ( )

unPostGoal Source code

function unPostGoal ( AI_Action parent ) )

wasAchieved Source code

function bool wasAchieved ( ) )

wasConsidered Source code

function bool wasConsidered ( ) )

wasNotAchieved Source code

function bool wasNotAchieved ( ) )


Defaultproperties

defaultproperties
{
	priority = 50
	goalName = "<unnamed goal>"
	bWakeUpPoster = false
	bRemoveGoalOfSameType = false
	bTryOnlyOnce = false
}

Overview Package Class Source Class tree Glossary
previous class      next class frames      no frames
Creation time: st 23.5.2018 00:10:26.900 - Created with UnCodeX