# hideSprite

[Built-ins](README.md)

Canonical ID: `sprites.hide`. Nederlands: `verbergSprite`.

Removes one retained sprite by name. Hiding an absent name is harmless. It does not remove the underlying project image, change other sprites, or erase immediate shapes. Showing the same name afterward creates a new stacking position. Scene clear and Reset Scene also remove retained sprites.

## Signature

```text
hideSprite(name)
```

## Arguments

| Parameter | Type | Requirement |
|---|---|---|
| `name` | Text | Nonempty sprite name to remove. |

## Return value

`None`.

## Example

```pliro
# language: en
showSprite("hero", "assets/hero.png", 100, 200, 48, 64)
wait(0.2)
hideSprite("hero")
```

Package `assets/hero.png`; the sprite appears briefly, then disappears.

## Notes and common mistakes

Use the function name for your source language. Its [canonical ID](../concepts/canonical-identity.md) is a shared documentation label; you do not type that ID as a call. Giving your own variable or function the same name can hide the built-in. Supply the documented [arguments](../concepts/parameters-and-arguments.md) and value types. Pliro reports mismatches when checking can detect them, or when the call runs.

A **host** is the app or environment running your program. To see a drawing, it needs a **renderer**, the part that draws on screen. The [command-line](../concepts/command-line.md) command `pliro run` shows text but does not draw these graphics. The [host support table](../guides/hosts.md) explains which effects work in the IDE, browser, native app, and phone preview. A native build reports an unsupported capability instead of leaving it out.

The example requires the named files inside a .bipli project. Packaged assets are currently limited to 12 MiB each. Paths under assets/ are project references, not arbitrary files or URLs. Current native export does not implement playSound.

## Related entries

[showSprite](showSprite.md) · [Programming guides](../guides/sprites.md) · [Host support](../guides/hosts.md) · [Calls and arguments](../syntax/calls.md)