games/impostor
4
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

ldoc return fixes

Browse Source
This commit is contained in:
Zsolt Tasnadi
2026-02-26 17:41:06 +01:00
parent e56662f6ad
commit 337f1fc132
21 changed files with 279 additions and 262 deletions
Download Patch File Download Diff File Expand all files Collapse all files

34
inc/sprite/sprite.manager.lua
View File

@@ -5,14 +5,14 @@ local _active_sprites = {}
--- Registers a sprite definition.
--- @within Sprite
--- @param sprite_data table A table containing the sprite definition.
--- @param sprite_data.id string Unique sprite identifier.
--- @param[opt] sprite_data.s number Sprite index for single-sprite mode.
--- @param[opt] sprite_data.colorkey number Default color index for transparency.
--- @param[opt] sprite_data.scale number Default scaling factor.
--- @param[opt] sprite_data.flip_x number Set to 1 to flip horizontally by default.
--- @param[opt] sprite_data.flip_y number Set to 1 to flip vertically by default.
--- @param[opt] sprite_data.rot number Default rotation in degrees.
--- @param[opt] sprite_data.sprites table Array of sub-sprite tables for composite sprites. Each entry has: `s` (number) sprite index, `x_offset` (number) horizontal offset, `y_offset` (number) vertical offset, and optional `colorkey`, `scale`, `flip_x`, `flip_y`, `rot` overrides.
--- @param sprite_data.id string Unique sprite identifier.<br/>
--- @param[opt] sprite_data.s number Sprite index for single-sprite mode.<br/>
--- @param[opt] sprite_data.colorkey number Default color index for transparency.<br/>
--- @param[opt] sprite_data.scale number Default scaling factor.<br/>
--- @param[opt] sprite_data.flip_x number Set to 1 to flip horizontally by default.<br/>
--- @param[opt] sprite_data.flip_y number Set to 1 to flip vertically by default.<br/>
--- @param[opt] sprite_data.rot number Default rotation in degrees.<br/>
--- @param[opt] sprite_data.sprites table Array of sub-sprite tables for composite sprites. Each entry has: `s` (number) sprite index, `x_offset` (number) horizontal offset, `y_offset` (number) vertical offset, and optional `colorkey`, `scale`, `flip_x`, `flip_y`, `rot` overrides.<br/>
function Sprite.register(sprite_data)
if not sprite_data or not sprite_data.id then
trace("Error: Invalid sprite object registered (missing id)!")
@@ -26,14 +26,14 @@ end
--- Schedules a sprite for drawing.
--- @within Sprite
--- @param id string The unique identifier of the sprite.
--- @param x number The x-coordinate.
--- @param y number The y-coordinate.
--- @param[opt] colorkey number The color index for transparency.
--- @param[opt] scale number The scaling factor.
--- @param[opt] flip_x number Set to 1 to flip horizontally.
--- @param[opt] flip_y number Set to 1 to flip vertically.
--- @param[opt] rot number The rotation in degrees.
--- @param id string The unique identifier of the sprite.<br/>
--- @param x number The x-coordinate.<br/>
--- @param y number The y-coordinate.<br/>
--- @param[opt] colorkey number The color index for transparency.<br/>
--- @param[opt] scale number The scaling factor.<br/>
--- @param[opt] flip_x number Set to 1 to flip horizontally.<br/>
--- @param[opt] flip_y number Set to 1 to flip vertically.<br/>
--- @param[opt] rot number The rotation in degrees.<br/>
function Sprite.show(id, x, y, colorkey, scale, flip_x, flip_y, rot)
if not _sprites[id] then
trace("Error: Attempted to show non-registered sprite with id: " .. id)
@@ -54,7 +54,7 @@ end
--- Hides a displayed sprite.
--- @within Sprite
--- @param id string The unique identifier of the sprite.
--- @param id string The unique identifier of the sprite.<br/>
function Sprite.hide(id)
_active_sprites[id] = nil
end