Dictionary - leotgo/bright-souls GitHub Wiki
Here you will find definitions for the terminology used throughout the source code.
Index
Terms and Definitions
Actor
Definition
An actor is an abstract base type that represents any game entity which has Attributes and gameplay related behavior.
Examples
- Enemies;
- An interactable door;
- The source of a sound;
- A fire node in the ground.
Attribute
Definition
Attributes are valued characteristics of an actor which can be:
- Written/read;
- Changed in runtime through console;
- Observed;
- Serialized;
Examples
| Name | Type | Description |
|---|---|---|
| Health | float | Represents current character health. |
| MaxHealth | float | Represents maximum character health. |
| Stamina | float | Represents current character stamina. |
| Faction | CharacterFaction | Represents the character faction identifier. |
| Status | CharacterStatus | Represents the current status for a character. |
Attribute Container
Definition
An Attribute Container is a semantic abstraction used to categorize and aggregate multiple attributes used by an actor. It contains at one or many attributes, and methods to retrieve certain attribute types.
Example 1
Character Behavior Attributes
Aggregates attributes related to the Gameplay Behavior exposed by the character.
- CharacterFaction
- CharacterStatus
Example 2
Player Combat Attributes
Aggregates attributes related to the combat state of the player.
- MaxHealth
- Stamina
- MaxStamina
- Poise