Tool

Tool : BackpackItem

Overview

Tool Class is used to create items for players to use in the game. This class is useful for implementing weapons, tools, equipment, and more, and provides a variety of features for players to interact with.

Description

It represents tool items in a game with properties governing transformations, behaviors, and events such as activation/deactivation, equipping/unequipping, and signal emissions.

Properties

CanBeDropped

bool

CanBeDropped is a boolean property that determines whether the tool can be dropped by the player.

Code Samples

local Tool = script.Parent

print(Tool.CanBeDropped)

Enabled

bool

Enabled is a boolean property that determines whether the tool is currently active or not.

Code Samples

local Tool = script.Parent

print(Tool.Enabled)

Grip

CFrame

Grip is a property in the Tool class representing the tool's orientation and position.

Code Samples

local Tool = script.Parent

print(Tool.Grip)

GripForward

Vector3

GripForward is a property representing the forward direction of a tool's grip.

Code Samples

local Tool = script.Parent

print(Tool.GripForward)

GripPos

Vector3

GripPos represents the position of the tool's grip.

Code Samples

local Tool = script.Parent

print(Tool.GripPos)

GripRight

Vector3

GripRight represents the right direction vector in the tool's grip frame.

Code Samples

local Tool = script.Parent

print(Tool.GripRight)

GripUp

Vector3

GripUp represents an upward direction vector of the tool's grip.

Code Samples

local Tool = script.Parent

print(Tool.GripUp)

ManualActivationOnly

bool

A boolean property determines if the tool can only be activated manually, without automatic triggering.

Code Samples

local Tool = script.Parent

print(Tool.ManualActivationOnly)

RequiresHandle

bool

RequiresHandle is a boolean property that determines whether the tool requires a handle for interaction.

Code Samples

local Tool = script.Parent

print(Tool.RequiresHandle)

ToolTip

string

A ToolTip is a string that provides additional information or guidance when hovered over.

Code Samples

local Tool = script.Parent

print(Tool.ToolTip)

Methods

Activate

— 지원예정

Parameters

Return

void

Code Samples

Deactivate

{Description Slot}

Parameters

Return

void

Code Samples

Events

Activated

{Description Slot}

Parameters

Code Samples

Deactivated

{Description Slot}

Parameters

Code Samples

Equipped

This event is triggered when the tool is equipped by the player. It allows you to define behaviors or actions that occur when the tool is made active.

Parameters

Code Samples

local Tool = script.Parent

local function OnEquipped()
    print("Tool Equipped!")
end
Tool.Equipped:Connect(OnEquipped)

Unequipped

This event is triggered when the tool is unequipped by the player. It allows you to define behaviors or actions that occur when the tool is no longer active or in use.

Parameters

Code Samples

local Tool = script.Parent

local function OnEquipped()
    print("Tool Unequipped!")
end
Tool.Unequipped:Connect(OnEquipped)