Skip to content
This repository has been archived by the owner on Jan 13, 2025. It is now read-only.

Commit

Permalink
More docs
Browse files Browse the repository at this point in the history
  • Loading branch information
IAmMoltony committed Feb 8, 2024
1 parent 7889aec commit a0792b9
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions include/player.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -216,6 +216,8 @@ class Player

/**
* @brief Eat
* @param healthAdd How much health to add
* @param foodID The item ID of the food
*/
void eat(u8 healthAdd, InventoryItem::ID foodID);

Expand Down Expand Up @@ -392,6 +394,7 @@ class Player

/**
* @brief Add character to sign that is currently edited
* @param chInt Scancode returned by keyboard
*/
void addSignChar(int chInt);

Expand All @@ -407,6 +410,8 @@ class Player

/**
* @brief Process entities
* @param entities List of entities
* @param camera Camera
*/
void updateEntities(EntityList *entities, const Camera *camera);

Expand All @@ -417,6 +422,12 @@ class Player

/**
* @brief Update gameplay
* @param oldX Previous X position
* @param oldY Previous Y position
* @param block List of blocks
* @param entities List of entities
* @param blockParticles List of block particles
* @param camera Camera
*/
UpdateResult updateGameplay(s16 oldX, s16 oldY, Block::List *blocks, EntityList *entities, BlockParticleList *blockParticles, Camera *camera);

Expand All @@ -428,16 +439,20 @@ class Player

/**
* @brief Update ladder climbing
* @param oldY Previous Y position
* @param collideLadder Is colliding with ladder?
*/
void updateLadder(s16 oldY, bool collideLadder);

/**
* @brief Update facing
* @param camera Camera
*/
void updateFacing(const Camera *camera);

/**
* @brief Update controls
* @param collideLadder Is colliding with ladder
*
* By updating controls I mean checking if the user is pressing buttons and stuff like that
*/
Expand Down Expand Up @@ -542,6 +557,7 @@ class Player
/**
* @brief Check if the item can be added
* @param item item to check if it can be added
* @todo Move into inventory class
*/
bool canAddItem(InventoryItem::ID item);

Expand Down

0 comments on commit a0792b9

Please sign in to comment.