View source for Giving an NPC Memory

{{npc tut}}

== Entity memory ==

=== Enemies ===

==== Current ====

An NPC's current target is managed with these functions:

; <code>[[bool]] ChooseEnemy()</code>
; <code>void SetEnemy( [[CBaseEntity]] *pEnemy, [[bool]] bSetCondNewEnemy )</code>
; <code>[[CBaseEntity]]* GetEnemy()</code>
; <code>[[CBaseCombatCharacter]]* GetEnemyCombatCharacterPointer()</code>
; <code>[[float]] GetTimeEnemyAcquired()</code>
: Gets and sets the current enemy and the time at which they were acquired. Choosing is preferred over setting.
; <code>void OnEnemyChanged( [[CBaseEntity]] *pOldEnemy, [[CBaseEntity]] *pNewEnemy )</code>
: Callback, by default does nothing.

==== Available ====

The list of available enemies is managed by the <code>CAI_Enemies</code> class. ''Crucially, the same <code>CAI_Enemies</code> object is shared between all members of a squad.''

{{tip|The functions below are all in <code>CAI_BaseNPC</code>. Use <code>GetEnemies()</code> to access the enemy list directly.}}

; <code>void UpdateEnemyMemory( [[CBaseEntity]] *pEnemy, const [[Vector]] &position, [[CBaseEntity]] *pInformer )</code>
: Adds or updates an enemy.
; <code>[[Vector]] GetEnemyLKP()</code>
; <code>[[float]] GetEnemyLastTimeSeen()</code>
: The last position/time at which data on this enemy was updated.
; <code>void MarkEnemyAsEluded()</code>
; <code>[[bool]] EnemyHasEludedMe()</code>
: Eluded enemies were seen, but are now at an unknown location. They are stored in enemy memory but not normally targeted.

=== Unreachable ===

; <code>RememberUnreachable( [[CBaseEntity]] *pEntity, [[float]] duration = -1 )</code>
: Causes the NPC to ignore the entity for the specified number of seconds. -1 means the AI's default, which is usually 3 seconds.
; <code>IsUnreachable([[CBaseEntity]] *pEntity)</code>
: Test reachability.

== Memory Bits ==

'''Memory bits''' are [[flag]]s which relate to the NPC's current state (for example, <code>bits_MEMORY_SUSPICIOUS</code> and <code>bits_MEMORY_FLINCHED</code>). See <code>game/server/ai_basenpc.h</code> for a full list.

;<code>Remember([[int]] iMemory)</code>
;<code>Forget([[int]] iMemory)</code>
: Set/remove a particular bit.
;<code>HasMemory([[int]] iMemory)</code>
;<code>HasAllMemories([[int]] iMemory)</code>
: Check whether one or more memory bits are set.
;<code>CAI_SchedulesManager::GetMemoryID(const [[char]] *state_name)</code>
: Modify this function to add support for extra memory bits in schedule definitions. You shouldn't need to call it yourself.

{{navbar|Defining the NPC|Creating an NPC|Creating a condition}}

[[Category:AI Programming]]