ggxxacpr::Entity Class Reference

Wraps a GGXXACPR_Entity struct pointer and provides conversions and generic entity-oriented interpretations of its data. More...

#include <ggxxacpr.hpp>

Public Member Functions
	Entity (GGXXACPR_Entity *ref=nullptr)
bool	isValid ()
	Checks if the underlying reference is valid.
GGXXACPR_Entity *	getRaw ()
	Returns the underlying GGXXACPR_Entity struct pointer.
EntityId	id ()
bool	isFacingRight ()
bool	isLeftSide ()
Entity	prev ()
Entity	next ()
ActionState	actionState ()
auto	actId ()
	The current action id.
auto	actTimer ()
auto	playerIndex ()
	the player index of the player that owns this entity.
GuardState	guardState ()
AttackState	attackState ()
ModelCoordinate	corePos ()
	The position of the player's center point in model space.
Scale	scale ()
	The scaling factor that should be applied to this player's colliders.
WorldCoordinate	position ()
	The position of the player.
WorldCoordinate	velocity ()
	Player velocity given in world coordinates per frame.
Angle	angle ()
	Angle of the entity's sprite.
int16_t	drawPriority ()
	Determines which sprites draw in which order.
uint8_t	damage ()
	The damage value of the current action.
uint8_t	hitstopTime ()
	A counter for hitstop.

Detailed Description

Wraps a GGXXACPR_Entity struct pointer and provides conversions and generic entity-oriented interpretations of its data.

This wrapper only exposes data that has a known use and only provides setters for data that has a known effect when changed. For full, direct data access, call Entity::getRaw() and use the GGXXACPR_Entity interface.

Constructor & Destructor Documentation

Entity()

ggxxacpr::Entity::Entity ( GGXXACPR_Entity * ref = nullptr )

inline

            : raw(ref) {}

Member Function Documentation

actId()

auto ggxxacpr::Entity::actId ( )

inline

The current action id.

Many projectile entities share a common entity id and are only distinguished by animation id.

{ return raw->actId; }

actionState()

ActionState ggxxacpr::Entity::actionState ( )

inline

                                  {
            return static_cast<ActionState>(raw->actionState);
        }

actTimer()

auto ggxxacpr::Entity::actTimer ( )

inline

{ return raw->actTimer; }

angle()

Angle ggxxacpr::Entity::angle ( )

inline

Angle of the entity's sprite.

{ return { raw->angle }; }

attackState()

AttackState ggxxacpr::Entity::attackState ( )

inline

                                  {
            return static_cast<AttackState>(raw->attackState);
        }

corePos()

ModelCoordinate ggxxacpr::Entity::corePos ( )

inline

The position of the player's center point in model space.

Combines GGXXACPR_Entity::coreX and GGXXACPR_Entity::coreY.

{ return {raw->coreX, raw->coreY}; }

damage()

uint8_t ggxxacpr::Entity::damage ( )

inline

The damage value of the current action.

{ return raw->actHeader.damage; }

drawPriority()

int16_t ggxxacpr::Entity::drawPriority ( )

inline

Determines which sprites draw in which order.

Higher values draw first, lower values draw over higher values. Essentially a position on the z-axis / depth buffer.

{ return raw->drawPriority; }

getRaw()

GGXXACPR_Entity * ggxxacpr::Entity::getRaw ( )

inline

Returns the underlying GGXXACPR_Entity struct pointer.

                                  {
            return raw;
        }

guardState()

GuardState ggxxacpr::Entity::guardState ( )

inline

                                {
            return static_cast<GuardState>(raw->guardState);
        }

hitstopTime()

uint8_t ggxxacpr::Entity::hitstopTime ( )

inline

A counter for hitstop.

{ return raw->hitstopTime; }

id()

EntityId ggxxacpr::Entity::id ( )

inline

                      {
            return static_cast<EntityId>(raw->id);
        }

isFacingRight()

bool ggxxacpr::Entity::isFacingRight ( )

inline

                             {
            return static_cast<bool>(raw->bIsFacingRight);
        }

isLeftSide()

bool ggxxacpr::Entity::isLeftSide ( )

inline

                          {
            return static_cast<bool>(raw->bIsLeftSide);
        }

isValid()

bool ggxxacpr::Entity::isValid ( )

inline

Checks if the underlying reference is valid.

                       {
            return raw != nullptr && raw->id != 0;
        }

next()

Entity ggxxacpr::Entity::next ( )

inline

{ return raw->nextPtr; }

playerIndex()

auto ggxxacpr::Entity::playerIndex ( )

inline

the player index of the player that owns this entity.

{ return raw->playerIndex; }

position()

WorldCoordinate ggxxacpr::Entity::position ( )

inline

The position of the player.

Sometimes called the "origin point" or "pivot".

{ return {raw->xPos, raw->yPos}; }

prev()

Entity ggxxacpr::Entity::prev ( )

inline

{ return raw->prevPtr; }

scale()

Scale ggxxacpr::Entity::scale ( )

inline

The scaling factor that should be applied to this player's colliders.

An interpretation of GGXXACPR_Entity::scale and GGXXACPR_Entity::scaleY.

{ return { raw->scale, raw->scaleY }; }

velocity()

WorldCoordinate ggxxacpr::Entity::velocity ( )

inline

Player velocity given in world coordinates per frame.

{ return {raw->xVelocity, raw->yVelocity}; }

---

The documentation for this class was generated from the following file:

• ggxxacpr.hpp