Constructor
new NPCKnowledge(archetypeOrConfigopt, overridesopt)
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
archetypeOrConfig | string | | <optional> | "patrol" | |
overrides | Object | <optional> | {} |
Classes
Methods
(static) restore(snapshot, entityResolveropt) → {NPCKnowledge}
Creates and restores an NPCKnowledge instance from a snapshot.
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
snapshot | Object | |||
entityResolver | function | <optional> | null |
Returns:
- Type:
- NPCKnowledge
deserialize(props)
Populates the component properties from a data object during scene deserialization.
Parameters:
| Name | Type | Description |
|---|---|---|
props | Object |
forget(target) → {boolean}
Forgets a target from memory.
Parameters:
| Name | Type | Description |
|---|---|---|
target | Object | |
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:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
candidates | Array | <optional> | [] | |
obstacles | Array | <optional> | [] | |
observer | Object | <optional> | null |
Returns:
- Type:
- Array
remember(target, dataopt) → {Object|null}
Records a target into memory.
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
target | Object | | |||
data | Object | <optional> | {} |
Returns:
- Type:
- Object |
null
restore(snapshot, entityResolveropt) → {NPCKnowledge}
Restores NPCKnowledge from a serialized snapshot.
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
snapshot | Object | |||
entityResolver | function | <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:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
deltaTime | number | <optional> | 1 | |
candidates | Array | <optional> | null | |
obstacles | Array | <optional> | null | |
observer | Object | <optional> | null |
Returns:
- Type:
- Array