Boomerang

Table of Contents

• Overview
• Methods inherited from map entity
• Methods of the type boomerang
• Events inherited from map entity
• Events of the type boomerang

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

Remarks

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

Overview

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 Methods of all entity types 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 Events of all entity types to know these events.

Events of the type boomerang

None.