NPCKnowledge

NPCKnowledge ties together archetype perception settings, bounded memory, and snapshot state.

Constructor

new NPCKnowledge(archetypeOrConfigopt, overridesopt)

Parameters:
NameTypeAttributesDefaultDescription
archetypeOrConfigstring | Object<optional>
"patrol"
overridesObject<optional>
{}

Classes

NPCKnowledge

Methods

(static) restore(snapshot, entityResolveropt) → {NPCKnowledge}

Creates and restores an NPCKnowledge instance from a snapshot.

Parameters:
NameTypeAttributesDefaultDescription
snapshotObject
entityResolverfunction<optional>
null
Returns:
Type: 
NPCKnowledge

deserialize(props)

Populates the component properties from a data object during scene deserialization.

Parameters:
NameTypeDescription
propsObject

forget(target) → {boolean}

Forgets a target from memory.

Parameters:
NameTypeDescription
targetObject | string
Returns:
Type: 
boolean

getKnownTargets() → {Array}

Returns all remembered entities.

Returns:
Type: 
Array

observe(candidatesopt, obstaclesopt, observeropt) → {Array}

Performs observation on candidates and records visible/audible entities into memory.

Parameters:
NameTypeAttributesDefaultDescription
candidatesArray<optional>
[]
obstaclesArray<optional>
[]
observerObject<optional>
null
Returns:
Type: 
Array

remember(target, dataopt) → {Object|null}

Records a target into memory.

Parameters:
NameTypeAttributesDefaultDescription
targetObject | string
dataObject<optional>
{}
Returns:
Type: 
Object | null

restore(snapshot, entityResolveropt) → {NPCKnowledge}

Restores NPCKnowledge from a serialized snapshot.

Parameters:
NameTypeAttributesDefaultDescription
snapshotObject
entityResolverfunction<optional>
null
Returns:
Type: 
NPCKnowledge

serialize() → {Object}

Serializes NPCKnowledge for save game snapshots.

Returns:
Type: 
Object

toJSON() → {Object}

JSON serialization support.

Returns:
Type: 
Object

update(deltaTimeopt, candidatesopt, obstaclesopt, observeropt) → {Array}

Updates NPC knowledge: decays memory confidence and optionally processes observations.

Parameters:
NameTypeAttributesDefaultDescription
deltaTimenumber<optional>
1
candidatesArray<optional>
null
obstaclesArray<optional>
null
observerObject<optional>
null
Returns:
Type: 
Array