include/entity.h file

Classes

struct UnkStruct

struct Hitbox

Hitbox structure.

struct Hitbox3D

Hitbox structure supporting depth.

struct PACKED

struct Entity

Container for instantiable behavior.

struct Entity::SpriteSettings

struct Entity::SpriteRendering

union Entity::Palette

struct Entity::Palette::PaletteB

struct Entity::SpriteOrientation

struct GenericEntityData

struct GenericEntity

struct LinkedList

Entity linked list structure.

struct CarriedEntity

Enums

enum EntityKind { PLAYER = 1, ENEMY = 3, PROJECTILE = 4, OBJECT = 6, NPC = 7, PLAYER_ITEM = 8, MANAGER = 9 }

Kinds of Entity's supported by the game.

enum EntityFlags { ENT_DID_INIT = 0x1, ENT_SCRIPTED = 0x2, ENT_UNUSED1 = 0x4, ENT_UNUSED2 = 0x8, ENT_DELETED = 0x10, ENT_PERSIST = 0x20, ENT_COLLIDE = 0x80 }

Entity flags.

enum Priority { PRIO_MIN, PRIO_PLAYER, PRIO_MESSAGE, PRIO_NO_BLOCK, PRIO_4, PRIO_5, PRIO_PLAYER_EVENT, PRIO_HIGHEST }

Priority level to determine what events will block an Entity from updating.

enum AnimationState { IdleNorth = 0x0, IdleEast = 0x2, IdleSouth = 0x4, IdleWest = 0x6 }

Animation state.

enum Direction { DirectionNorth = 0x00, DirectionNorthEast = 0x04, DirectionEast = 0x08, DirectionSouthEast = 0x0c, DirectionSouth = 0x10, DirectionSouthWest = 0x14, DirectionWest = 0x18, DirectionNorthWest = 0x1c }

Direction.

enum CollisionLayer { COL_LAYER_NONE = 0x0, COL_LAYER_BOTTOM = 0x1, COL_LAYER_TOP = 0x2, COL_LAYER_BOTH = 0x3 }

Collision layer flags.

enum CollisionClass { COL_CLASS_NONE = 0x0, COL_CLASS_PLAYER = 0x1, COL_CLASS_ITEM = 0x2, COL_CLASS_FLAMMABLE = 0x3, COL_CLASS_4 = 0x4, COL_CLASS_5 = 0x5, COL_CLASS_6 = 0x6, COL_CLASS_PACCI_OBJ = 0x7 }

Collision class flags.

enum CollisionFlags { COL_FLAG_3D = 0x10, COL_FLAG_SOLID = 0x20, COL_FLAG_REFLECT = 0x80 }

Collision flags.

Typedefs

using EntityAction = void()(Entity*)

using EntityActionPtr = void(*)(Entity*)

using EntityActionArray = void(*const)(Entity*)

Functions

void DrawEntity(Entity* entity)

Draw an Entity.

void InitializeAnimation(Entity* entity, u32 animIndex)

void InitAnimationForceUpdate(Entity* entity, u32 animIndex)

void UpdateAnimationSingleFrame(Entity* entity)

void UpdateSpriteForCollisionLayer(Entity* entity)

void GetNextFrame(Entity* entity)

auto LoadExtraSpriteData(Entity* entity, const SpriteLoadData* spriteData) -> bool32

void SetExtraSpriteFrame(Entity* this, u32 param_2, u32 param_3)

void SetSpriteSubEntryOffsetData1(Entity* this, u32 param_2, u32 param_3)

void SetSpriteSubEntryOffsetData2(Entity* this, u32 param_2, u32 param_3)

auto GetSpriteSubEntryOffsetDataPointer(u32 param_1, u32 param_2) -> u8*

auto SetAffineInfo(Entity* ent, u32 param_2, u32 param_3, u32 param_4) -> bool32

auto GetFacingDirection(Entity* origin, Entity* target) -> u32

Return the direction pointing from one Entity to another.

auto ProcessMovement0(Entity* this) -> bool32

void UpdateEntities(void)

Iteratively execute every Entity.

void UpdateManagers(void)

Iteratively execute every Manager.

void DeleteManager(void* manager)

Delete a manager.

void DeleteEntityAny(Entity* entity)

Delete Manager or Entity.

void EraseAllEntities(void)

Erase all Entity's.

void DeleteThisEntity(void)

Delete the Entity currently in execution.

void DeleteEntity(Entity* entity)

Delete an Entity.

void AppendEntityToList(Entity* entity, u32 listIndex)

Add an Entity to the end of a LinkedList.

void PrependEntityToList(Entity* entity, u32 listIndex)

Add an Entity to the start of a LinkedList.

auto FindEntityByID(u32 kind, u32 id, u32 listIndex) -> Entity*

Find an Entity for a given kind and id, and LinkedList.

auto DeepFindEntityByID(u32 kind, u32 id) -> Entity*

Search all lists for an Entity of same kind and id.

auto EntityHasDuplicateID(Entity* entity) -> bool32

Search all lists for Entity of same kind and id.

auto FindNextDuplicateID(Entity* entity, int listIndex) -> Entity*

Find an Entity of same kind and id in LinkedList.

auto FindEntity(u32 kind, u32 id, u32 listIndex, u32 type, u32 type2) -> Entity*

Find an Entity with full identifiers.

void SetEntityPriority(Entity* entity, u32 prio)

Set the default priority for entity.

auto EntityDisabled(Entity* entity) -> bool32

Check if entity is disabled.

auto AnyPrioritySet(void) -> bool32

Check if system or entity is blocking updates.

auto SetMinPriority(u32 prio) -> s32

Set the minimum Entity priority.

void RequestPriority(Entity* entity)

Request indefinite priority for an Entity.

void RevokePriority(Entity* entity)

Revoke priority from an Entity.

void RequestPriorityDuration(Entity* entity, u32 time)

Request update priority over other Entity's for a period of time.

void SetPriorityTimer(u32 time)

Set the remaining frames of Entity priority.

void RequestPriorityOverPlayer(Entity* entity)

Request priority over player update.

void RevokePriorityOverPlayer(Entity* entity)

Revoke priority over player update.

void ResetEntityPriority(void)

Reset a priority event requested by an Entity.

void SetPlayerEventPriority(void)

Set entity and system priority to PRIO_PLAYER_EVENT.

void ResetPlayerEventPriority(void)

Reset entity and system priority to defaults.

void SetRoomReloadPriority(void)

Set system priority to PRIO_PLAYER_EVENT.

void SetInitializationPriority(void)

Set system priority to PRIO_HIGHEST.

void ClearEventPriority(void)

Reset the system update priority.

void sub_0805E958(void)

void DeleteAllEntities(void)

Variables

LinkedList gEntityLists

LinkedList's which point to allocate Entities.

GenericEntity gAuxPlayerEntities

GenericEntity gEntities

CarriedEntity gCarriedEntity

u8 gEntCount

Current number of entities.

u8 gManagerCount

Current number of managers.

Defines

#define MAX_ENTITIES

#define MAX_MANAGERS

#define MAX_AUX_PLAYER_ENTITIES

#define COLLISION_MASK(layer)

#define CONTACT_NOW

#define GENERIC_ENTITY_FIELDS

#define COLLISION_OFF(entity)

#define COLLISION_ON(entity)

#define ANIM_DONE

Tile Macros

#define TILE(x, y)

#define TILE_LOCAL(x, y)

#define TILE_POS(x, y)

#define TILE_POS_X_COMPONENT

#define TILE_POS_Y_COMPONENT

#define COORD_TO_TILE(entity)

#define COORD_TO_TILE_OFFSET(entity, xOff, yOff)

Animation State Macros

#define AnimationStateFlip90(expr)

#define AnimationStateFlip180(expr)

#define AnimationStateIdle(expr)

#define AnimationStateWalk(expr)

Direction Macros

#define DirectionRound(expr)

#define DirectionRoundUp(expr)

#define DirectionIsHorizontal(expr)

#define DirectionIsVertical(expr)

#define DirectionTurnAround(expr)

#define DirectionToAnimationState(expr)

#define DirectionFromAnimationState(expr)

#define DirectionNormalize(expr)

#define Direction8Round(expr)

#define Direction8RoundUp(expr)

#define Direction8TurnAround(expr)

#define Direction8ToAnimationState(expr)

#define Direction8FromAnimationState(expr)

Enum documentation

Function documentation

Variable documentation