diff options
| author | Loek Le Blansch <loek@pipeframe.xyz> | 2024-11-15 20:39:07 +0100 | 
|---|---|---|
| committer | Loek Le Blansch <loek@pipeframe.xyz> | 2024-11-15 20:39:07 +0100 | 
| commit | e8cd950b8ebd152d76d588d4fedc7f4c239b0835 (patch) | |
| tree | 7919d13a79d52f1365bc19bf1b435a6264ee5512 /src/crepe/api/Animator.h | |
| parent | 5bee4515c1089ce3499bc3b74780db94f0c02306 (diff) | |
| parent | 9f6475e7b0698c414138e2a8140b47f01ce9c5d1 (diff) | |
merge `master` into `loek/cleanup`
Diffstat (limited to 'src/crepe/api/Animator.h')
| -rw-r--r-- | src/crepe/api/Animator.h | 20 | 
1 files changed, 11 insertions, 9 deletions
diff --git a/src/crepe/api/Animator.h b/src/crepe/api/Animator.h index 3573403..53f4b91 100644 --- a/src/crepe/api/Animator.h +++ b/src/crepe/api/Animator.h @@ -9,11 +9,11 @@ class AnimatorSystem;  class SDLContext;  /** - * \brief The Animator component is used to animate sprites by managing the movement - *        and frame changes within a sprite sheet. + * \brief The Animator component is used to animate sprites by managing the movement and frame + * changes within a sprite sheet.   * - * This component allows for controlling sprite animation through rows and columns of a sprite sheet. - * It can be used to play animations, loop them, or stop them. + * This component allows for controlling sprite animation through rows and columns of a sprite + * sheet. It can be used to play animations, loop them, or stop them.   */  class Animator : public Component { @@ -27,15 +27,17 @@ public:  	 * \brief Constructs an Animator object that will control animations for a sprite sheet.  	 *  	 * \param id The unique identifier for the component, typically assigned automatically. -	 * \param spritesheet A reference to the Sprite object which holds the sprite sheet for animation. +	 * \param spritesheet A reference to the Sprite object which holds the sprite sheet for +	 * animation.  	 * \param row The maximum number of rows in the sprite sheet.  	 * \param col The maximum number of columns in the sprite sheet. -	 * \param col__animate The specific col index of the sprite sheet to animate. This allows selecting which col to animate from multiple col in the sheet. +	 * \param col_animate The specific col index of the sprite sheet to animate. This allows +	 * selecting which col to animate from multiple col in the sheet.  	 * -	 * This constructor sets up the Animator with the given parameters, and initializes the animation system. +	 * This constructor sets up the Animator with the given parameters, and initializes the +	 * animation system.  	 */ -	Animator(game_object_id_t id, Sprite & spritesheet, int row, int col, -			 int col_animate); +	Animator(uint32_t id, Sprite & spritesheet, int row, int col, int col_animate);  	~Animator(); // dbg_trace  	Animator(const Animator &) = delete;  |