Carried object

Table of Contents

• Overview
  • Carried object sprites
• Methods inherited from map entity
• Methods of the type carried object
  • carried_object:get_carrier()
  • carried_object:get_damage_on_enemies()
  • carried_object:set_damage_on_enemies(damage_on_enemies)
  • carried_object:get_destruction_sound()
  • carried_object:set_destruction_sound(destruction_sound_id)
• Events inherited from map entity
• Events of the type carried object
  • carried_object:on_lifted()
  • carried_object:on_thrown()
  • carried_object:on_breaking()

A carried object is a map entity that the hero is lifting, carrying or throwing.

Overview

A carried object is created automatically by the engine when the hero lifts a map entity, typically a destructible object. The carried object takes the sprite and the features of the lifted entity it is created from.

The hero can then walk with his carried object and throw it. He can even go to another map: the carried object is preserved.

Carried object sprites

Two sprites for a carried object are automatically created by the engine. You can access them like for any other entity, specifying their name in entity:get_sprite([name]).

• "main" (default): Main sprite representing the carried object. Its animation set is the one of the original entity he was created from (like a destructible object). It should have animations "stopped", "walking" and "destroy", with the same direction as the hero. These animations will be played depending on the actions of the hero on the carried object. If the carried object was created from a destructible object that can explode, then animations "stopped_explosion_soon" and "walking_explosion_soon" will be played instead.
• "shadow": Shadow displayed under the carried object when thrown. Its animation set is "entities/shadow", with the animation name "big".

Methods inherited from map entity

Carried objects are particular map entities. Therefore, they inherit all methods from the type map entity.

See Methods of all entity types to know these methods.

Methods of the type carried object

The following methods are specific to carried objects.

carried_object:get_carrier()

Returns the entity that carried this object.

• Return value (entity): The carrier entity.

carried_object:get_damage_on_enemies()

Returns the number of life points that an enemy loses when the hero throws this object at it.

• Return value (number): The number of life points to remove to an enemy hit by this object. 0 means that enemies will ignore this object.

carried_object:set_damage_on_enemies(damage_on_enemies)

Sets the number of life points that an enemy loses when the hero throws this object at it.

• damage_on_enemies (number): The number of life points to remove to an enemy hit by this object. 0 means that enemies will ignore this object.

carried_object:get_destruction_sound()

Returns the sound to be played when this object is cut or broken.

• Return value (string): Id of the destruction sound. nil means that no sound will be played.

carried_object:set_destruction_sound(destruction_sound_id)

Sets the sound to be played when this object is cut or broken.

• destruction_sound_id (string): Id of the destruction sound. nil means that no sound will be played.

Events inherited from map entity

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

Carried objects are particular map entities. Therefore, they inherit all events from the type map entity.

See Events of all entity types to know these events.

Events of the type carried object

The following events are specific to carried objects.

carried_object:on_lifted()

Called when this object has finished being lifted and is now actually carried.

carried_object:on_thrown()

Called when this object starts being thrown.

carried_object:on_breaking()

Called when this object falls on the ground and starts breaking.