server.components.Shield.Shield

Class: Shield

server/components/Shield.Shield

Hierarchy

• Essential<ToolAttributes, ShieldInstance>

  ↳ Shield

Table of contents

Constructors

• constructor

Properties

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

Methods

• Block
• EndBlock
• Init
• PlayerInit
• destroy
• getState
• onAttributeChanged
• onStart
• setAttribute
• setInstance
• setState

Constructors

constructor

• new Shield()

Overrides

Essential.constructor

Defined in

src/server/components/Shield.ts:31

Properties

Actions

• Actions: Actions

Inherited from

Essential.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

Inherited from

Essential.Disable

Defined in

src/server/components/Essential.ts:116

---

DisableAnimation

• DisableAnimation: number = Config.Animations.Shield.Holster

Overrides

Essential.DisableAnimation

Defined in

src/server/components/Shield.ts:26

---

DisabledLimb

• DisabledLimb: CharacterLimb

Overrides

Essential.DisabledLimb

Defined in

src/server/components/Shield.ts:29

---

Enable

• Enable: (End: Callback) => void

Type declaration

▸ (End): void

Parameters

Name	Type
End	Callback

Returns

void

Inherited from

Essential.Enable

Defined in

src/server/components/Essential.ts:114

---

EnableAnimation

• EnableAnimation: number = Config.Animations.Shield.Equip

Overrides

Essential.EnableAnimation

Defined in

src/server/components/Shield.ts:25

---

EnabledLimb

• EnabledLimb: CharacterLimb

Overrides

Essential.EnabledLimb

Defined in

src/server/components/Shield.ts:28

---

InputInfo

• InputInfo: InputInfo

Inherited from

Essential.InputInfo

Defined in

src/server/components/Essential.ts:22

---

Player

• Optional Player: Player

Inherited from

Essential.Player

Defined in

src/server/components/Tool.ts:64

---

attributes

• attributes: ToolAttributes

Attributes attached to this instance.

Inherited from

Essential.attributes

Defined in

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

---

id

• id: string

Inherited from

Essential.id

Defined in

src/server/components/Tool.ts:61

---

instance

• instance: ShieldInstance

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

Inherited from

Essential.instance

Defined in

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

---

janitor

• Protected janitor: Janitor<void>

Inherited from

Essential.janitor

Defined in

src/server/components/Tool.ts:59

---

maid

• maid: Maid

A maid that will be destroyed when the component is.

Inherited from

Essential.maid

Defined in

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

---

state

• state: string = "nil"

Inherited from

Essential.state

Defined in

src/server/components/Tool.ts:62

---

stateChanged

• stateChanged: Signal<fn, false>

Inherited from

Essential.stateChanged

Defined in

src/server/components/Tool.ts:65

---

timeCreated

• timeCreated: number

Inherited from

Essential.timeCreated

Defined in

src/server/components/Tool.ts:63

Methods

Block

▸ Private Block(End, janitor): void

Parameters

Name	Type
End	Callback
janitor	Janitor<void>

Returns

void

Defined in

src/server/components/Shield.ts:51

---

EndBlock

▸ Private EndBlock(End): void

Parameters

Name	Type
End	Callback

Returns

void

Defined in

src/server/components/Shield.ts:59

---

Init

▸ Init(): void

Returns

void

Overrides

Essential.Init

Defined in

src/server/components/Shield.ts:65

---

PlayerInit

▸ PlayerInit(): void

Returns

void

Overrides

Essential.PlayerInit

Defined in

src/server/components/Shield.ts:85

---

destroy

▸ destroy(): void

Destroys this component instance.

Returns

void

Inherited from

Essential.destroy

Defined in

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

---

getState

▸ getState(): string

Returns

string

Inherited from

Essential.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 "BUTTON_TOGGLE"

Parameters

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

Returns

void

Inherited from

Essential.onAttributeChanged

Defined in

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

---

onStart

▸ onStart(): void

Returns

void

Inherited from

Essential.onStart

Defined in

src/server/components/Tool.ts:76

---

setAttribute

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

Type parameters

Name	Type
T	extends "BUTTON_TOGGLE"

Parameters

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

Returns

ToolAttributes[T]

Inherited from

Essential.setAttribute

Defined in

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

---

setInstance

▸ setInstance(instance, attributes): void

Parameters

Name	Type
instance	ShieldInstance
attributes	unknown

Returns

void

Inherited from

Essential.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

Essential.setState

Defined in

src/server/components/Tool.ts:71