ScriptWorldCanvas class
Sprites and rectangles a level script draws in the level (jjDrawSprite() and the like).
Attached to the scene of the level, so what's drawn is in the level, at the depth of a layer. The script draws in its updates, everything is drawn until the next update of the script clears it, as in JJ2+ where a draw lasts one frame.
Base classes
- class Jazz2::UI::Canvas
- Canvas.
Public types
- struct SpriteDraw
- Frame of a sprite drawn in the level.
- struct SolidDraw
- Rectangle of a color of the palette drawn in the level.
- struct TileDraw
- Tile drawn in the level.
- struct TextDraw
- Text drawn in the level.
Public functions
- void AddSprite(const SpriteDraw& draw)
- Draws a sprite in the level until the next Clear().
- void AddSolid(const SolidDraw& draw)
- Draws a rectangle in the level until the next Clear().
- void AddTile(const TileDraw& draw)
- Draws a tile in the level until the next Clear().
- void AddText(TextDraw draw)
- Draws text in the level until the next Clear().
- void Clear()
- Removes everything drawn.
- auto OnDraw(RenderQueue& renderQueue) -> bool override
- Called when the node needs to be drawn, returning
trueif a command was added.
Public variables
- LevelHandler* EffectsOwner
- Level whose views give the copy of the scene the sprites of
SPRITE::CHROMAKEYare keyed against, see OnDraw().