diff --git a/Types.md b/Types.md index d7e3f83..36cbca0 100644 --- a/Types.md +++ b/Types.md @@ -31,6 +31,7 @@ Another base type. This makes image operating easier than using default love.gra - `Image.modifier` - number -- Scroll factor relative to camera position. 0-inf. - `Image.rotation` - number -- Image rotation. - `Image.layer` - number -- Layer that Image renders on. +- `Image.ui` - boolean -- Whenether image moves with the camera or not. (Almost useless with modifier) ## Functions - `Image:Destroy()` - Removes the image from the list, won't render anymore. @@ -51,6 +52,7 @@ Every update updates the sprite based on it's current animation and framerate. - `Sprite.layer` - number -- Layer that Sprite renders on. - `Sprite.rotation` - number -- Sprite rotation. - `Sprite.flipX` - boolean -- If sprite gets flipped on X axis. CHANGES SPRITE POSITION TO BE EXACTLY -width. +- `Sprite.ui` - boolean -- Whenether sprite moves with the camera or not. (Almost useless with modifier) ## Functions - `Sprite:Destroy()` -- Removes the sprite from the list, won't render anymore. Cache still remains. @@ -72,6 +74,7 @@ Sprite, but doesn't play a animation and saves up space and game FPS. - `Rect.layer` - number -- Layer that Rect renders on. - `Rect.rotation` - number -- Rect rotation. - `Rect.flipX` - boolean -- If rect gets flipped on X axis. CHANGES RECT POSITION TO BE EXACTLY -width. +- `Rect.ui` - boolean -- Whenether rect moves with the camera or not. (Almost useless with modifier) # Functions - `Rect:Destroy()` -- Removs the rect from the list, won't render anymore. Cache still remains. @@ -96,4 +99,30 @@ Typically you wouldn't need to call this one, but it still needs to be here for - `Character.icon` - string -- Taken from json. ## Functions -- `Character:PlayAnimation(string)` -- Plays the animation based on json Name, FPS and Offsets. \ No newline at end of file +- `Character:PlayAnimation(string)` -- Plays the animation based on json Name, FPS and Offsets. + +## Creation +myTypes.character(string) -- JSON path. + +# Note + +I don't even know why you would call this. + +## Children +- `Note.position` - number -- Note position in song. NOT VECTOR2. +- `Note.character` - string? -- Not applied yet. +- `Note.mustPress` - boolean -- Whenether the note is for BF or Dad. +- `Note.direction` - number -- Note number direction. 1-4. +- `Note.spawned` - boolean -- Isn't called directly. Changes on Note:spawn() +- `Note.altAnim` - boolean -- This is obvious. +- `Note.hold` - boolean -- If it's a holdNote. +- `Note.last` - boolean -- If it's a tail holdNote. +- `Note.hitHealth` - number -- How much health BF gains from hit (Multiplied by 0.2 for holdNotes). +- `Note.missHealth` - number -- How much health BF looses from miss (Multiplied by 0.2 for holdNotes). + +## Functions +- `Note:destroy()` -- Destroys the spawned note sprite (if there is one) and removes the note. +- `Note:spawn()` -- Makes the note sprite and positions it. + +## Creation +myTypes.note(table, boolean, boolean, boolean) -- Raw data, section.mustHitSection, hold, holdEnd \ No newline at end of file