Skip to content

Commit

Permalink
docs(types.ts): add readd() examples (#838)
Browse files Browse the repository at this point in the history
* docs(types.ts): add readd() examples

* Update docs(types.ts): shorten readd() examples

Removed some components and text

* Update docs(types.ts) fix pos and area in read()

After removing scale, one of the sprites pos needed to be adjusted to overlap other sprite in demonstration. 
Also, area() is needed as well, because without area(), kaboom will throw an error "purpleBean is not a function" when using "purpleBean.onClick()".
Not sure if this is a bug or intended like that, but might explain one of the reasons why people get errors often.

* docs(types.ts) fix identation for readd()

Remove the extra indents
  • Loading branch information
SG-SWE073 committed Apr 5, 2024
1 parent 6fb737f commit ab2b3d6
Showing 1 changed file with 35 additions and 0 deletions.
35 changes: 35 additions & 0 deletions src/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,41 @@ export interface KaboomCtx {
make<T>(comps?: CompList<T>): GameObj<T>,
/**
* Remove and re-add the game obj, without triggering add / destroy events.
* @example
* ```js
* // Common way to use this is to have one sprite overlap another sprite, and use readd() to have the bottom sprite on top of the other.
*
* // Create two sprites.
* const greenBean = add([
* sprite("bean"),
* pos(200,140),
* color(255, 255, 255),
* area(),
* ])
*
* // This bean will overlap the green bean.
* const purpleBean = add([
* sprite("bean"),
* pos(230,140),
* color(255, 0, 255),
* area(),
* ])
*
* // Example 1: simply call readd() on the target you want on top.
* readd(greenBean)
*
* // Example 2: using onClick() or other functions with readd().
* // If you comment out the first example, and use this readd() with a function like onClick(), you
* can keep switching which sprite is above the other ( click on edge of face ).
*
* purpleBean.onClick(() => {
* readd(greenBean)
* })
*
* greenBean.onClick(() => {
* readd(purpleBean)
* })
* ```
*/
readd(obj: GameObj): void,
/**
Expand Down

0 comments on commit ab2b3d6

Please sign in to comment.