NSUNI/NSLAR Library a250670
Loading...
Searching...
No Matches

Contains the definition for action identifiers that are used across different parts of the library. More...

Classes

struct  nnl::action::Id
 Represents a unique identifier for an action. More...

Enumerations

enum class  nnl::action::ActionCategory { nnl::action::ActionCategory::kMovement = 0 , nnl::action::ActionCategory::kCombat = 1 , nnl::action::ActionCategory::kDamage = 2 , nnl::action::ActionCategory::kCutscene = 3 }
 Defines the categories of actions. More...

Variables

constexpr std::size_t nnl::action::kNumActionCategories = 4
 Defines the number of action categories;.
constexpr std::size_t nnl::action::kMaxActionIndex = 0x3FFF
 Defines the maximum index of an action in a category;.

Detailed Description

Contains the definition for action identifiers that are used across different parts of the library.

See also
nnl::action::Id
nnl::action::ActionConfig
nnl::colbox::ColBoxConfig

Class Documentation

◆ nnl::action::Id

struct nnl::action::Id

Represents a unique identifier for an action.

The action_category member determines the type of an action, while the action_index provides a unique identifier for the action within that category. Together, they form a complete identifier for an action.

See also
nnl::action::ActionConfig
nnl::colbox::ColBoxConfig

Public Attributes

ActionCategory action_category = ActionCategory::kMovement
 Type of the action.
u16 action_index = 0
 The index within the category.

Member Data Documentation

◆ action_category

ActionCategory nnl::action::Id::action_category = ActionCategory::kMovement

Type of the action.

◆ action_index

u16 nnl::action::Id::action_index = 0

The index within the category.

See also
nnl::action::kMaxNumActionsPerCat

Enumeration Type Documentation

◆ ActionCategory

enum class nnl::action::ActionCategory
strong

Defines the categories of actions.

Each category groups related actions with their animations and effects.

See also
nnl::action::Id
Enumerator
kMovement 

Related to moving the entity.

kCombat 

Related to attacking behaviors.

kDamage 

Related to receiving damage.

kCutscene 

Related to scripted events or cutscenes.

Variable Documentation

◆ kMaxActionIndex

std::size_t nnl::action::kMaxActionIndex = 0x3FFF
constexpr

Defines the maximum index of an action in a category;.

See also
nnl::action::ActionCategory
nnl::action::kNumActionCategories

◆ kNumActionCategories

std::size_t nnl::action::kNumActionCategories = 4
constexpr

Defines the number of action categories;.

See also
nnl::action::ActionCategory
nnl::action::kMaxNumActionsPerCat