server.components.Essential.Essential

Class: Essential<A, I>

server/components/Essential.Essential

The base class for both the shield and sword.

states - "Enabled", "Disabled"

Type parameters

Name	Type
A	extends ToolAttributes
I	extends ToolInstance

Hierarchy

• Tool<A, I>

  ↳ Essential

  ↳↳ Shield

  ↳↳ Weapon

Table of contents

Constructors

• constructor

Properties

• Actions
• Disable
• DisableAnimation
• DisabledLimb
• Enable
• EnableAnimation
• EnabledLimb
• EssentialAnimation
• InputInfo
• Motor6D
• Player
• attributes
• id
• instance
• janitor
• maid
• state
• stateChanged
• timeCreated

Methods

• GetLimb
• Init
• PlayerInit
• SetMotor6D
• Setup
• create
• destroy
• getState
• onAttributeChanged
• onStart
• setAttribute
• setInstance
• setState

Constructors

constructor

• new Essential<A, I>()

Type parameters

Name	Type
A	extends ToolAttributes
I	extends ToolInstance<I>

Inherited from

Tool.constructor

Properties

Actions

• Actions: Actions

Overrides

Tool.Actions

Defined in

src/server/components/Essential.ts:118

---

Disable

• Disable: (End: Callback) => void

Type declaration

▸ (End): void

Parameters

Name	Type
End	Callback

Returns

void

Defined in

src/server/components/Essential.ts:116

---

DisableAnimation

• Protected Abstract DisableAnimation: number

Defined in

src/server/components/Essential.ts:15

---

DisabledLimb

• Protected Abstract DisabledLimb: CharacterLimb

Defined in

src/server/components/Essential.ts:17

---

Enable

• Enable: (End: Callback) => void

Type declaration

▸ (End): void

Parameters

Name	Type
End	Callback

Returns

void

Defined in

src/server/components/Essential.ts:114

---

EnableAnimation

• Protected Abstract EnableAnimation: number

Defined in

src/server/components/Essential.ts:14

---

EnabledLimb

• Protected Abstract EnabledLimb: CharacterLimb

Defined in

src/server/components/Essential.ts:16

---

EssentialAnimation

• Private Optional EssentialAnimation: AnimationTrack

Defined in

src/server/components/Essential.ts:19

---

InputInfo

• InputInfo: InputInfo

Overrides

Tool.InputInfo

Defined in

src/server/components/Essential.ts:22

---

Motor6D

• Private Optional Motor6D: Motor6D

Defined in

src/server/components/Essential.ts:20

---

Player

• Optional Player: Player

Inherited from

Tool.Player

Defined in

src/server/components/Tool.ts:64

---

attributes

• attributes: A

Attributes attached to this instance.

Inherited from

Tool.attributes

Defined in

node_modules/@flamework/components/out/index.d.ts:20

---

id

• id: string

Inherited from

Tool.id

Defined in

src/server/components/Tool.ts:61

---

instance

• instance: I

The instance this component is attached to. This should only be called in a component lifecycle event.

Inherited from

Tool.instance

Defined in

node_modules/@flamework/components/out/index.d.ts:25

---

janitor

• Protected janitor: Janitor<void>

Inherited from

Tool.janitor

Defined in

src/server/components/Tool.ts:59

---

maid

• maid: Maid

A maid that will be destroyed when the component is.

Inherited from

Tool.maid

Defined in

node_modules/@flamework/components/out/index.d.ts:16

---

state

• state: string = "nil"

Inherited from

Tool.state

Defined in

src/server/components/Tool.ts:62

---

stateChanged

• stateChanged: Signal<fn, false>

Inherited from

Tool.stateChanged

Defined in

src/server/components/Tool.ts:65

---

timeCreated

• timeCreated: number

Inherited from

Tool.timeCreated

Defined in

src/server/components/Tool.ts:63

Methods

GetLimb

▸ Private GetLimb(limbName): BasePart

Parameters

Name	Type
limbName	CharacterLimb

Returns

BasePart

Defined in

src/server/components/Essential.ts:46

---

Init

▸ Optional Abstract Init(): void

Returns

void

Inherited from

Tool.Init

Defined in

src/server/components/Tool.ts:56

---

PlayerInit

▸ Optional Abstract PlayerInit(): void

Returns

void

Inherited from

Tool.PlayerInit

Defined in

src/server/components/Tool.ts:57

---

SetMotor6D

▸ Private SetMotor6D(limb): void

Parameters

Name	Type
limb	BasePart

Returns

void

Defined in

src/server/components/Essential.ts:66

---

Setup

▸ Private Setup(): void

Returns

void

Defined in

src/server/components/Essential.ts:76

---

create

▸ Private create(option): (End: Callback) => void

Parameters

Name	Type
option	"Enable" | "Disable"

Returns

fn

▸ (End): void

Parameters

Name	Type
End	Callback

Returns

void

Defined in

src/server/components/Essential.ts:85

---

destroy

▸ destroy(): void

Destroys this component instance.

Returns

void

Inherited from

Tool.destroy

Defined in

node_modules/@flamework/components/out/index.d.ts:39

---

getState

▸ getState(): string

Returns

string

Inherited from

Tool.getState

Defined in

src/server/components/Tool.ts:67

---

onAttributeChanged

▸ onAttributeChanged<K>(name, cb): void

Connect a callback to the change of a specific attribute.

Type parameters

Name	Type
K	extends string | number | symbol

Parameters

Name	Type	Description
name	K	The name of the attribute
cb	(newValue: A[K], oldValue: A[K]) => void	The callback

Returns

void

Inherited from

Tool.onAttributeChanged

Defined in

node_modules/@flamework/components/out/index.d.ts:35

---

onStart

▸ onStart(): void

Returns

void

Inherited from

Tool.onStart

Defined in

src/server/components/Tool.ts:76

---

setAttribute

▸ setAttribute<T>(key, value, postfix?): A[T]

Type parameters

Name	Type
T	extends string | number | symbol

Parameters

Name	Type
key	T
value	A[T]
postfix?	boolean

Returns

A[T]

Inherited from

Tool.setAttribute

Defined in

node_modules/@flamework/components/out/index.d.ts:27

---

setInstance

▸ setInstance(instance, attributes): void

Parameters

Name	Type
instance	I
attributes	unknown

Returns

void

Inherited from

Tool.setInstance

Defined in

node_modules/@flamework/components/out/index.d.ts:26

---

setState

▸ setState(state): void

Parameters

Name	Type
state	string

Returns

void

Inherited from

Tool.setState

Defined in

src/server/components/Tool.ts:71