archetype_cover_utility.gsc File Reference

Go to the source code of this file.

Macros
#define	COVER_AIM_ANGLE_EPSILON   10
#define	NEAR_NODE_DIST_SQR   SQR(24)

Functions
function	calculateCoverDirection (behaviorTreeEntity, stepOut)
function	canBeFlanked (behaviorTreeEntity)
function private	canBeFlankedService (behaviorTreeEntity)
function	chooseCoverDirection (behaviorTreeEntity, stepOut)
function	cleanupCoverMode (behaviorTreeEntity)
function	clearCoverShootStartTime (behaviorTreeEntity)
function private	continueLeaningAtCoverCondition (behaviorTreeEntity)
function private	coverFlankedActionTerminate (behaviorTreeEntity)
function private	coverFlankedInitialize (behaviorTreeEntity)
function private	coverIdleInitialize (behaviorTreeEntity)
function private	coverIdleTerminate (behaviorTreeEntity)
function private	coverIdleUpdate (behaviorTreeEntity)
function private	coverLeanInitialize (behaviorTreeEntity)
function private	coverLeanTerminate (behaviorTreeEntity)
function private	coverOverInitialize (behaviorTreeEntity)
function private	coverOverTerminate (behaviorTreeEntity)
function private	coverPeekInitialize (behaviorTreeEntity)
function private	coverPeekTerminate (behaviorTreeEntity)
function private	coverReloadInitialize (behaviorTreeEntity)
function	isAtCoverCondition (behaviorTreeEntity)
function	isAtCoverModeNone (behaviorTreeEntity)
function	isAtCoverModeOver (behaviorTreeEntity)
function	isAtCoverStrictCondition (behaviorTreeEntity)
function	isAtCrouchNode (behaviorTreeEntity)
function	isExposedAtCoverCondition (behaviorTreeEntity)
function private	isFlankedByEnemyAtCover (behaviorTreeEntity)
function	isSuppressedAtCoverCondition (behaviorTreeEntity)
function	keepClaimedNodeAndChooseCoverDirection (behaviorTreeEntity)
function	refillAmmoAndCleanupCoverMode (behaviorTreeEntity)
function autoexec	RegisterBehaviorScriptFunctions ()
function	resetCoverParameters (behaviorTreeEntity)
function	setCanBeFlanked (behaviorTreeEntity, canBeFlanked)
function	setCoverShootStartTime (behaviorTreeEntity)
function	shouldCoverIdleOnly (behaviorTreeEntity)
function private	shouldLeanAtCoverCondition (behaviorTreeEntity)
function private	shouldOverAtCoverCondition (entity)
function private	supportsLeanCoverCondition (behaviorTreeEntity)
function private	supportsOverCoverCondition (behaviorTreeEntity)
function private	supportsPeekCoverCondition (behaviorTreeEntity)

Macro Definition Documentation

COVER_AIM_ANGLE_EPSILON

#define COVER_AIM_ANGLE_EPSILON   10

Definition at line 18 of file archetype_cover_utility.gsc.

NEAR_NODE_DIST_SQR

#define NEAR_NODE_DIST_SQR   SQR(24)

Definition at line 355 of file archetype_cover_utility.gsc.

Function Documentation

calculateCoverDirection()

function calculateCoverDirection	(	behaviorTreeEntity	,
		stepOut
	)

Definition at line 451 of file archetype_cover_utility.gsc.

References AIM_LIMIT_TABLE_ENTRY_PILLAR_RIGHT_LEAN, AIM_RIGHT, cointoss(), COVER_AIM_ANGLE_EPSILON, COVER_FRONT_DIRECTION, COVER_LEFT_DIRECTION, COVER_RIGHT_DIRECTION, ISNODEDONTLEFT, ISNODEDONTRIGHT, NODE_COVER_LEFT, NODE_COVER_PILLAR, NODE_COVER_RIGHT, and NODE_SUPPORTS_STANCE_STAND.

Referenced by chooseCoverDirection(), and robotChooseCoverDirection().

canBeFlanked()

function canBeFlanked

(

behaviorTreeEntity

)

Definition at line 554 of file archetype_cover_utility.gsc.

Referenced by isFlankedByEnemyAtCover(), robotShouldReactAtCover(), and setCanBeFlanked().

canBeFlankedService()

function private canBeFlankedService

(

behaviorTreeEntity

)

Definition at line 323 of file archetype_cover_utility.gsc.

References setCanBeFlanked().

Referenced by RegisterBehaviorScriptFunctions().

chooseCoverDirection()

function chooseCoverDirection	(	behaviorTreeEntity	,
		stepOut
	)

Definition at line 438 of file archetype_cover_utility.gsc.

References calculateCoverDirection(), COVER_DIRECTION, GetBlackBoardAttribute(), PREVIOUS_COVER_DIRECTION, and SetBlackBoardAttribute().

Referenced by coverBlindfireShootActionStart(), coverLeanInitialize(), coverPeekInitialize(), keepClaimedNodeAndChooseCoverDirection(), robotCoverScanInitialize(), and stepOutInitialize().

cleanupCoverMode()

function cleanupCoverMode

(

behaviorTreeEntity

)

Definition at line 564 of file archetype_cover_utility.gsc.

References COVER_MODE, COVER_MODE_NONE, GetBlackBoardAttribute(), isAtCoverCondition(), PREVIOUS_COVER_MODE, and SetBlackBoardAttribute().

Referenced by coverFlankedInitialize(), coverIdleTerminate(), coverLeanTerminate(), coverOverTerminate(), coverPeekTerminate(), prepareToChangeStanceToCrouch(), prepareToChangeStanceToStand(), refillAmmoAndCleanupCoverMode(), RegisterBehaviorScriptFunctions(), resetCoverParameters(), robotCoverOverTerminate(), robotCoverScanTerminate(), and robotScanExposedPainTerminate().

clearCoverShootStartTime()

function clearCoverShootStartTime

(

behaviorTreeEntity

)

Definition at line 544 of file archetype_cover_utility.gsc.

Referenced by coverLeanTerminate(), coverOverTerminate(), resetCoverParameters(), and robotCoverOverTerminate().

continueLeaningAtCoverCondition()

function private continueLeaningAtCoverCondition

(

behaviorTreeEntity

)

Definition at line 180 of file archetype_cover_utility.gsc.

References shouldLeanAtCoverCondition().

Referenced by RegisterBehaviorScriptFunctions().

coverFlankedActionTerminate()

function private coverFlankedActionTerminate

(

behaviorTreeEntity

)

Definition at line 346 of file archetype_cover_utility.gsc.

References releaseClaimNode().

Referenced by RegisterBehaviorScriptFunctions().

coverFlankedInitialize()

function private coverFlankedInitialize

(

behaviorTreeEntity

)

Definition at line 328 of file archetype_cover_utility.gsc.

References cleanupCoverMode(), DESIRED_STANCE, keepClaimNode(), SetBlackBoardAttribute(), setCanBeFlanked(), and STANCE_STAND.

Referenced by RegisterBehaviorScriptFunctions().

coverIdleInitialize()

function private coverIdleInitialize

(

behaviorTreeEntity

)

Definition at line 292 of file archetype_cover_utility.gsc.

References COVER_ALERT_MODE, COVER_MODE, keepClaimNode(), and SetBlackBoardAttribute().

Referenced by RegisterBehaviorScriptFunctions().

coverIdleTerminate()

function private coverIdleTerminate

(

behaviorTreeEntity

)

Definition at line 306 of file archetype_cover_utility.gsc.

References cleanupCoverMode(), and releaseClaimNode().

Referenced by RegisterBehaviorScriptFunctions().

coverIdleUpdate()

function private coverIdleUpdate

(

behaviorTreeEntity

)

Definition at line 298 of file archetype_cover_utility.gsc.

References releaseClaimNode().

Referenced by RegisterBehaviorScriptFunctions().

coverLeanInitialize()

function private coverLeanInitialize

(

behaviorTreeEntity

)

Definition at line 191 of file archetype_cover_utility.gsc.

References chooseCoverDirection(), COVER_LEAN_MODE, COVER_MODE, keepClaimNode(), SetBlackBoardAttribute(), and setCoverShootStartTime().

Referenced by RegisterBehaviorScriptFunctions().

coverLeanTerminate()

function private coverLeanTerminate

(

behaviorTreeEntity

)

Definition at line 199 of file archetype_cover_utility.gsc.

References chooseFrontCoverDirection(), cleanupCoverMode(), and clearCoverShootStartTime().

Referenced by RegisterBehaviorScriptFunctions().

coverOverInitialize()

function private coverOverInitialize

(

behaviorTreeEntity

)

Definition at line 276 of file archetype_cover_utility.gsc.

References COVER_MODE, COVER_OVER_MODE, keepClaimNode(), SetBlackBoardAttribute(), and setCoverShootStartTime().

Referenced by RegisterBehaviorScriptFunctions().

coverOverTerminate()

function private coverOverTerminate

(

behaviorTreeEntity

)

Definition at line 283 of file archetype_cover_utility.gsc.

References cleanupCoverMode(), and clearCoverShootStartTime().

Referenced by RegisterBehaviorScriptFunctions().

coverPeekInitialize()

function private coverPeekInitialize

(

behaviorTreeEntity

)

Definition at line 91 of file archetype_cover_utility.gsc.

References chooseCoverDirection(), COVER_ALERT_MODE, COVER_MODE, keepClaimNode(), and SetBlackBoardAttribute().

Referenced by RegisterBehaviorScriptFunctions().

coverPeekTerminate()

function private coverPeekTerminate

(

behaviorTreeEntity

)

Definition at line 98 of file archetype_cover_utility.gsc.

References chooseFrontCoverDirection(), and cleanupCoverMode().

Referenced by RegisterBehaviorScriptFunctions().

coverReloadInitialize()

function private coverReloadInitialize

(

behaviorTreeEntity

)

Definition at line 69 of file archetype_cover_utility.gsc.

References COVER_ALERT_MODE, COVER_MODE, keepClaimNode(), and SetBlackBoardAttribute().

Referenced by RegisterBehaviorScriptFunctions().

isAtCoverCondition()

function isAtCoverCondition

(

behaviorTreeEntity

)

Definition at line 371 of file archetype_cover_utility.gsc.

Referenced by ArchetypeHumanOnBehaveCallback(), cleanupCoverMode(), and RegisterBehaviorScriptFunctions().

isAtCoverModeNone()

function isAtCoverModeNone

(

behaviorTreeEntity

)

Definition at line 391 of file archetype_cover_utility.gsc.

References COVER_MODE, COVER_MODE_NONE, and GetBlackBoardAttribute().

Referenced by RegisterBehaviorScriptFunctions().

isAtCoverModeOver()

function isAtCoverModeOver

(

behaviorTreeEntity

)

Definition at line 384 of file archetype_cover_utility.gsc.

References COVER_MODE, COVER_OVER_MODE, and GetBlackBoardAttribute().

Referenced by RegisterBehaviorScriptFunctions().

isAtCoverStrictCondition()

function isAtCoverStrictCondition

(

behaviorTreeEntity

)

Definition at line 378 of file archetype_cover_utility.gsc.

Referenced by RegisterBehaviorScriptFunctions().

isAtCrouchNode()

function isAtCrouchNode

(

behaviorTreeEntity

)

Definition at line 356 of file archetype_cover_utility.gsc.

References isStanceAllowedAtNode(), NEAR_NODE_DIST_SQR, NODE_EXPOSED, NODE_GUARD, NODE_PATH, STANCE_CROUCH, and STANCE_STAND.

Referenced by RegisterBehaviorScriptFunctions().

isExposedAtCoverCondition()

function isExposedAtCoverCondition

(

behaviorTreeEntity

)

Definition at line 398 of file archetype_cover_utility.gsc.

Referenced by RegisterBehaviorScriptFunctions().

isFlankedByEnemyAtCover()

function private isFlankedByEnemyAtCover

(

behaviorTreeEntity

)

Definition at line 315 of file archetype_cover_utility.gsc.

References canBeFlanked().

Referenced by RegisterBehaviorScriptFunctions().

isSuppressedAtCoverCondition()

function isSuppressedAtCoverCondition

(

behaviorTreeEntity

)

Definition at line 418 of file archetype_cover_utility.gsc.

Referenced by RegisterBehaviorScriptFunctions(), and shouldReturnToCoverCondition().

keepClaimedNodeAndChooseCoverDirection()

function keepClaimedNodeAndChooseCoverDirection

(

behaviorTreeEntity

)

Definition at line 424 of file archetype_cover_utility.gsc.

References chooseCoverDirection(), and keepClaimNode().

Referenced by coverPrepareToThrowGrenade(), and RegisterBehaviorScriptFunctions().

refillAmmoAndCleanupCoverMode()

function refillAmmoAndCleanupCoverMode

(

behaviorTreeEntity

)

Definition at line 75 of file archetype_cover_utility.gsc.

References cleanupCoverMode(), and refillAmmo().

Referenced by RegisterBehaviorScriptFunctions().

RegisterBehaviorScriptFunctions()

function autoexec RegisterBehaviorScriptFunctions

(

)

Definition at line 20 of file archetype_cover_utility.gsc.

References BT_REGISTER_API, canBeFlankedService(), cleanupCoverMode(), continueLeaningAtCoverCondition(), coverFlankedActionTerminate(), coverFlankedInitialize(), coverIdleInitialize(), coverIdleTerminate(), coverIdleUpdate(), coverLeanInitialize(), coverLeanTerminate(), coverOverInitialize(), coverOverTerminate(), coverPeekInitialize(), coverPeekTerminate(), coverReloadInitialize(), isAtCoverCondition(), isAtCoverModeNone(), isAtCoverModeOver(), isAtCoverStrictCondition(), isAtCrouchNode(), isExposedAtCoverCondition(), isFlankedByEnemyAtCover(), isSuppressedAtCoverCondition(), keepClaimedNodeAndChooseCoverDirection(), refillAmmoAndCleanupCoverMode(), resetCoverParameters(), shouldCoverIdleOnly(), shouldLeanAtCoverCondition(), shouldOverAtCoverCondition(), supportsLeanCoverCondition(), supportsOverCoverCondition(), and supportsPeekCoverCondition().

resetCoverParameters()

function resetCoverParameters

(

behaviorTreeEntity

)

Definition at line 430 of file archetype_cover_utility.gsc.

References chooseFrontCoverDirection(), cleanupCoverMode(), and clearCoverShootStartTime().

Referenced by coverCleanUpToThrowGrenade(), RegisterBehaviorScriptFunctions(), riotshieldTacticalWalkStart(), robotTacticalWalkActionStart(), and tacticalWalkActionStart().

setCanBeFlanked()

function setCanBeFlanked	(	behaviorTreeEntity	,
		canBeFlanked
	)

Definition at line 559 of file archetype_cover_utility.gsc.

References canBeFlanked().

Referenced by canBeFlankedService(), coverFlankedInitialize(), riotshieldTacticalWalkStart(), robotTacticalWalkActionStart(), and tacticalWalkActionStart().

setCoverShootStartTime()

function setCoverShootStartTime

(

behaviorTreeEntity

)

Definition at line 549 of file archetype_cover_utility.gsc.

Referenced by coverLeanInitialize(), coverOverInitialize(), and robotCoverOverInitialize().

shouldCoverIdleOnly()

function shouldCoverIdleOnly

(

behaviorTreeEntity

)

Definition at line 403 of file archetype_cover_utility.gsc.

References get_behavior_attribute(), and IS_TRUE.

Referenced by RegisterBehaviorScriptFunctions().

shouldLeanAtCoverCondition()

function private shouldLeanAtCoverCondition

(

behaviorTreeEntity

)

Definition at line 127 of file archetype_cover_utility.gsc.

References AIM_LEFT, AIM_LIMIT_TABLE_ENTRY_COVER, AIM_LIMIT_TABLE_ENTRY_COVER_LEFT_LEAN, AIM_LIMIT_TABLE_ENTRY_COVER_RIGHT_LEAN, AIM_RIGHT, COVER_AIM_ANGLE_EPSILON, ISNODEDONTLEFT, ISNODEDONTRIGHT, NODE_COVER_LEFT, NODE_COVER_PILLAR, and NODE_COVER_RIGHT.

Referenced by continueLeaningAtCoverCondition(), and RegisterBehaviorScriptFunctions().

shouldOverAtCoverCondition()

function private shouldOverAtCoverCondition

(

entity

)

Definition at line 238 of file archetype_cover_utility.gsc.

References AIM_DOWN, AIM_LEFT, AIM_LIMIT_TABLE_ENTRY_COVER_CONCEALED_OVER, AIM_LIMIT_TABLE_ENTRY_COVER_OVER, AIM_RIGHT, AIM_UP, COVER_AIM_ANGLE_EPSILON, and isCoverConcealed().

Referenced by RegisterBehaviorScriptFunctions().

supportsLeanCoverCondition()

function private supportsLeanCoverCondition

(

behaviorTreeEntity

)

Definition at line 107 of file archetype_cover_utility.gsc.

References ISNODEDONTLEFT, ISNODEDONTRIGHT, NODE_COVER_LEFT, NODE_COVER_PILLAR, and NODE_COVER_RIGHT.

Referenced by RegisterBehaviorScriptFunctions().

supportsOverCoverCondition()

function private supportsOverCoverCondition

(

behaviorTreeEntity

)

Definition at line 208 of file archetype_cover_utility.gsc.

References COVER_MODE_OVER, GetBlackBoardAttribute(), NODE_COVER_CROUCH, NODE_COVER_LEFT, NODE_COVER_RIGHT, NODE_COVER_STAND, STANCE, STANCE_CROUCH, and STANCE_STAND.

Referenced by RegisterBehaviorScriptFunctions().

supportsPeekCoverCondition()

function private supportsPeekCoverCondition

(

behaviorTreeEntity

)

Definition at line 86 of file archetype_cover_utility.gsc.

Referenced by RegisterBehaviorScriptFunctions().