Skip to content

# Boomerang

## Overview

A boomerang map entity is used to implement the hero's boomerang state.

Historical Feature

Boomerang entities exist for historical reasons and are not very customizable. In new projects, we recommend to use custom entities instead.

A boomerang entity is created when you call `hero:start_boomerang()`.

It can immobilize or hurt enemies and activate mechanisms.

Note that there is no predefined boomerang equipment item. It is your responsability to make one if you want. If you decide to make one, you will typically call `hero:start_boomerang()` from the `item:on_using()` callback of your boomerang equipment item.

## Methods Inherited from map entity

A boomerang is a particular map entity. Therefore, it inherits all methods from the type map entity.

See entity to know these methods.

## Methods of the type `boomerang`

None.

## Events inherited from map entity

Events are callback methods automatically called by the engine if you define them.

A boomerang is a particular map entity. Therefore, it inherits all events from the type map entity.

See entity to know these events.

## Events of the type `boomerang`

None.

April 1, 2025