Tool

Tools are objects that can be held by the player.

Inherits: PhysicalModel

Properties

• Droppable: boolean
• IconImage: ImageAsset
• Holder: NPC

Methods

Activate() → nil

Activates the tool, similarly to pressing the mouse button.

Deactivate() → nil

Deactivates the tool, similarly to releasing the mouse button.

PlayAnimation(animationName: string) → nil

Plays the specified animation on the holder of the tool.

Events

• Equipped: Fires when this tool has been equipped
• Unequipped: Fires when this tool has been unequipped
• Activated: Fires when this tool has been activated (via mouse press or Tool:Activate)
• Deactivated: Fires when this tool has been deactivated (via mouse release or Tool:Deactivate)