Skip to content

Commit

Permalink
NobleSprite: Minor docs spelling fixes.
Browse files Browse the repository at this point in the history
  • Loading branch information
Mark-LaCroix committed Apr 28, 2024
1 parent 49a5d3d commit 2f611cd
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions modules/NobleSprite.lua
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
-- An extention of Playdate's sprite object, incorporating `Noble.Animation` and other Noble Engine features.
-- An extension of Playdate's sprite object, incorporating `Noble.Animation` and other Noble Engine features.
-- Use this in place of `playdate.graphics.sprite` in most cases.
--
-- `NobleSprite` is a child class of `playdate.graphics.sprite`, so see the Playdate SDK documentation for additional methods and properties.
Expand All @@ -13,7 +13,7 @@ class("NobleSprite").extends(Graphics.sprite)
--- Do not call an "init" method directly. Use `NobleSprite()` (see usage examples).
-- @string[opt] __view This can be: the path to an image or spritesheet image file, an image object (`Graphics.image`) or an animation object (`Noble.Animation`)
-- @bool[opt=false] __viewIsSpritesheet Set this to `true` to indicate that `__view` is a spritesheet. Will only be considered if `__view` is a string path to an image.
-- @bool[opt=false] __singleState If this sprite has just one animation, set this to true. It saves you from having to use Noble.Anmiation.addState()
-- @bool[opt=false] __singleState If this sprite has just one animation, set this to true. It saves you from having to use Noble.Animation.addState()
-- @bool[opt=true] __singleStateLoop If using a single state animation, should it loop?
--
-- @usage
Expand Down

0 comments on commit 2f611cd

Please sign in to comment.