Skip to content

# Hookshot

## Overview

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

Historical Feature

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

A hookshot entity is created when you call `hero:start_hookshot()`.

It can immobilize or hurt enemies and transport the hero to distant places.

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

## Methods Inherited from map entity

A hookshot 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 `hookshot`

None.

## Events inherited from map entity

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

A hookshot 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 `hookshot`

None.

April 1, 2025