Interface Sockets<T>

Type parameters

T

Hierarchy

Sockets

Implemented by

ItemSockets

Index

Methods

Methods

color

color(color: SocketColor, ...sockets: SocketId[]): T

- Defined in packages/mods/src/containers/item/components/Sockets/Sockets.ts:49
Parameters
- color: SocketColor
- Rest ...sockets: SocketId[]
Returns T

colorBatch

colorBatch(...batch: ColorBatch[]): T

- Defined in packages/mods/src/containers/item/components/Sockets/Sockets.ts:50
Parameters
- Rest ...batch: ColorBatch[]
Returns T

colors

colors(): SocketColor[]

- Defined in packages/mods/src/containers/item/components/Sockets/Sockets.ts:48
Returns SocketColor[]

count

count(): number

- Defined in packages/mods/src/containers/item/components/Sockets/Sockets.ts:25
Returns number

current amount of sockets

isLinked

isLinked(a: SocketId, b: SocketId): boolean

- Defined in packages/mods/src/containers/item/components/Sockets/Sockets.ts:35
checks if {a} and {b} are linked

Parameters
- a: SocketId
  
  the socket to check
- b: SocketId
  
  the socket for which to check if it is linked to a
Returns boolean

link

link(...sockets: SocketId[]): T

- Defined in packages/mods/src/containers/item/components/Sockets/Sockets.ts:41
links each pair of

Parameters
- Rest ...sockets: SocketId[]
Returns T

mapColors

mapColors(fn: (socket: Socket, index: SocketId, item: T) => Socket): T

- Defined in packages/mods/src/containers/item/components/Sockets/Sockets.ts:51
Parameters
- fn: (socket: Socket, index: SocketId, item: T) => Socket
  - - (socket: Socket, index: SocketId, item: T): Socket
    - Parameters
      - socket: Socket
      - index: SocketId
      - item: T
      Returns Socket
Returns T

max

max(): number

- Defined in packages/mods/src/containers/item/components/Sockets/Sockets.ts:17
deprecated

use maxSockets() instead

Returns number

the maximum amount of sockets

maxLinks

maxLinks(): number

- Defined in packages/mods/src/containers/item/components/Sockets/Sockets.ts:29
Returns number

the biggest number of linked sockets

maxSockets

maxSockets(): number

- Defined in packages/mods/src/containers/item/components/Sockets/Sockets.ts:21
Returns number

the maximum amount of sockets

socket

socket(n: number, options?: Partial<SocketOptions>): T

- Defined in packages/mods/src/containers/item/components/Sockets/Sockets.ts:47
sets the number of sockets to n

Parameters
- n: number
- Optional options: Partial<SocketOptions>
  
  set {keep_links} to true if it should not reroll links
Returns T

toJson

toJson(): Array<Socket & { group: number }>

- Defined in packages/mods/src/containers/item/components/Sockets/Sockets.ts:52
Returns Array<Socket & { group: number }>

Generated using TypeDoc