From 5c338c3f5ea9428601b3503b3ca41854938c8a7b Mon Sep 17 00:00:00 2001 From: Hendra Gunawan <48410066+JadlionHD@users.noreply.github.com> Date: Sun, 13 Oct 2024 17:31:44 +0700 Subject: [PATCH] [skip ci]: update docs v1.6.2 --- docs/classes/Client.html | 24 ++++++++++++------------ docs/classes/ItemsDat.html | 4 ++-- docs/classes/Peer.html | 10 +++++----- docs/classes/TankPacket.html | 12 ++++++------ docs/classes/TextPacket.html | 14 +++++++------- docs/classes/Variant.html | 12 ++++++------ docs/enums/PacketTypes.html | 4 ++-- docs/enums/VariantTypes.html | 4 ++-- docs/functions/parseText.html | 2 +- docs/interfaces/ActionEvent.html | 4 ++-- docs/interfaces/Caching.html | 4 ++-- docs/interfaces/ClientOptions.html | 4 ++-- docs/interfaces/ClientType.html | 4 ++-- docs/interfaces/ENetServerOptions.html | 4 ++-- docs/interfaces/ExtendString.html | 4 ++-- docs/interfaces/ItemDefinition.html | 4 ++-- docs/interfaces/ItemsDatMeta.html | 4 ++-- docs/interfaces/LoginInfo.html | 4 ++-- docs/interfaces/NativePeerAddress.html | 4 ++-- docs/interfaces/NativePeerMethod.html | 4 ++-- docs/interfaces/PeerData.html | 4 ++-- docs/interfaces/StringOptions.html | 4 ++-- docs/interfaces/Tank.html | 4 ++-- docs/interfaces/VariantOptions.html | 6 +++--- docs/interfaces/VariantTypeBase.html | 4 ++-- docs/interfaces/VariantTypeFloat.html | 4 ++-- docs/interfaces/VariantTypeNumber.html | 4 ++-- docs/interfaces/VariantTypeString.html | 4 ++-- docs/types/Sendable.html | 2 +- docs/types/VariantArg.html | 2 +- docs/types/VariantArray.html | 2 +- typedoc.json | 1 + 32 files changed, 86 insertions(+), 85 deletions(-) diff --git a/docs/classes/Client.html b/docs/classes/Client.html index f426f24..93d73bb 100644 --- a/docs/classes/Client.html +++ b/docs/classes/Client.html @@ -1,4 +1,4 @@ -Client | growtopia.js

Class Client

Hierarchy

  • EventEmitter
    • Client

Constructors

constructor +Client | growtopia.js

Class Client

Hierarchy

  • EventEmitter
    • Client

Constructors

constructor

Properties

_client cache config @@ -17,20 +17,20 @@ removeListener send toggleNewPacket -

Constructors

constructor

Properties

_client

_client: ClientType

cache

cache: Caching

config

config: ClientOptions

Staticprefixed

prefixed: string | boolean

Methods

addListener

  • addListener<T>(event, fn, context?): this

  • Type Parameters

    • T extends string | symbol

    Parameters

    • event: T
    • fn: ((...args: any[]) => void)
        • (...args): void

        • Parameters

          • Rest...args: any[]

          Returns void

    • Optionalcontext: any

    Returns this

connect

  • connect(ipAddress, port, peerID): boolean

  • Parameters

    • ipAddress: string
    • port: number
    • peerID: number

    Returns boolean

emit

  • emit<T>(event, ...args): boolean

  • Calls each of the listeners registered for a given event.

    +

Constructors

constructor

Properties

_client

_client: ClientType

cache

cache: Caching

config

config: ClientOptions

Staticprefixed

prefixed: string | boolean

Methods

addListener

  • addListener<T>(event, fn, context?): this

  • Type Parameters

    • T extends string | symbol

    Parameters

    • event: T
    • fn: ((...args: any[]) => void)
        • (...args): void

        • Parameters

          • Rest...args: any[]

          Returns void

    • Optionalcontext: any

    Returns this

connect

  • connect(ipAddress, port, peerID): boolean

  • Parameters

    • ipAddress: string
    • port: number
    • peerID: number

    Returns boolean

emit

  • emit<T>(event, ...args): boolean

  • Calls each of the listeners registered for a given event.

    Type Parameters

    • T extends string | symbol

    Parameters

    • event: T
    • Rest...args: any[]

    Returns boolean

eventNames

  • eventNames(): (string | symbol)[]

  • Return an array listing the events for which the emitter has registered listeners.

    -

    Returns (string | symbol)[]

listen

listenerCount

  • listenerCount(event): number

  • Return the number of listeners listening to a given event.

    +

    Returns (string | symbol)[]

listen

listenerCount

  • listenerCount(event): number

  • Return the number of listeners listening to a given event.

    Parameters

    • event: string | symbol

    Returns number

listeners

  • listeners<T>(event): ((...args: any[]) => void)[]

  • Return the listeners registered for a given event.

    Type Parameters

    • T extends string | symbol

    Parameters

    • event: T

    Returns ((...args: any[]) => void)[]

off

  • off<T>(event, fn?, context?, once?): this

  • Type Parameters

    • T extends string | symbol

    Parameters

    • event: T
    • Optionalfn: ((...args: any[]) => void)
        • (...args): void

        • Parameters

          • Rest...args: any[]

          Returns void

    • Optionalcontext: any
    • Optionalonce: boolean

    Returns this

on

  • on(event, listener): this

  • Add a listener for a given event.

    -

    Parameters

    • event: "connect"
    • listener: ((netID: number) => void)
        • (netID): void

        • Parameters

          • netID: number

          Returns void

    Returns this

  • on(event, listener): this

  • Add a listener for a given event.

    -

    Parameters

    • event: "raw"
    • listener: ((netID: number, data: Buffer) => void)
        • (netID, data): void

        • Parameters

          • netID: number
          • data: Buffer

          Returns void

    Returns this

  • on<T>(event, listener): this

  • Add a listener for a given event.

    -

    Type Parameters

    Parameters

    Returns this

  • on<T>(event, listener): this

  • Add a listener for a given event.

    -

    Type Parameters

    Parameters

    Returns this

  • on<T>(event, listener): this

  • Add a listener for a given event.

    -

    Type Parameters

    Parameters

    Returns this

  • on(event, listener): this

  • Add a listener for a given event.

    -

    Parameters

    • event: "ready"
    • listener: (() => void)
        • (): void

        • Returns void

    Returns this

  • on(event, listener): this

  • Add a listener for a given event.

    -

    Parameters

    • event: "error"
    • listener: ((error: Error, data?: Buffer) => void)
        • (error, data?): void

        • Parameters

          • error: Error
          • Optionaldata: Buffer

          Returns void

    Returns this

  • on(event, listener): this

  • Add a listener for a given event.

    -

    Parameters

    • event: "disconnect"
    • listener: ((netID: number) => void)
        • (netID): void

        • Parameters

          • netID: number

          Returns void

    Returns this

once

  • once<T>(event, fn, context?): this

  • Add a one-time listener for a given event.

    +

    Parameters

    • event: "connect"
    • listener: ((netID: number) => void)
        • (netID): void

        • Parameters

          • netID: number

          Returns void

    Returns this

  • on(event, listener): this

  • Add a listener for a given event.

    +

    Parameters

    • event: "raw"
    • listener: ((netID: number, data: Buffer) => void)
        • (netID, data): void

        • Parameters

          • netID: number
          • data: Buffer

          Returns void

    Returns this

  • on<T>(event, listener): this

  • Add a listener for a given event.

    +

    Type Parameters

    Parameters

    Returns this

  • on<T>(event, listener): this

  • Add a listener for a given event.

    +

    Type Parameters

    Parameters

    Returns this

  • on<T>(event, listener): this

  • Add a listener for a given event.

    +

    Type Parameters

    Parameters

    Returns this

  • on(event, listener): this

  • Add a listener for a given event.

    +

    Parameters

    • event: "ready"
    • listener: (() => void)
        • (): void

        • Returns void

    Returns this

  • on(event, listener): this

  • Add a listener for a given event.

    +

    Parameters

    • event: "error"
    • listener: ((error: Error, data?: Buffer) => void)
        • (error, data?): void

        • Parameters

          • error: Error
          • Optionaldata: Buffer

          Returns void

    Returns this

  • on(event, listener): this

  • Add a listener for a given event.

    +

    Parameters

    • event: "disconnect"
    • listener: ((netID: number) => void)
        • (netID): void

        • Parameters

          • netID: number

          Returns void

    Returns this

once

  • once<T>(event, fn, context?): this

  • Add a one-time listener for a given event.

    Type Parameters

    • T extends string | symbol

    Parameters

    • event: T
    • fn: ((...args: any[]) => void)
        • (...args): void

        • Parameters

          • Rest...args: any[]

          Returns void

    • Optionalcontext: any

    Returns this

removeAllListeners

  • removeAllListeners(event?): this

  • Remove all listeners, or those of the specified event.

    Parameters

    • Optionalevent: string | symbol

    Returns this

removeListener

  • removeListener<T>(event, fn?, context?, once?): this

  • Remove the listeners of a given event.

    -

    Type Parameters

    • T extends string | symbol

    Parameters

    • event: T
    • Optionalfn: ((...args: any[]) => void)
        • (...args): void

        • Parameters

          • Rest...args: any[]

          Returns void

    • Optionalcontext: any
    • Optionalonce: boolean

    Returns this

send

toggleNewPacket

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Type Parameters

Parameters

Returns this

send

toggleNewPacket

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/classes/ItemsDat.html b/docs/classes/ItemsDat.html index 686c04c..c6b50f5 100644 --- a/docs/classes/ItemsDat.html +++ b/docs/classes/ItemsDat.html @@ -1,6 +1,6 @@ -ItemsDat | growtopia.js

Class ItemsDat

Constructors

constructor +ItemsDat | growtopia.js

Class ItemsDat

Constructors

constructor

Properties

data meta

Methods

decode encode -

Constructors

constructor

Properties

data

data: Buffer

meta

meta: ItemsDatMeta = ...

Methods

decode

encode

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Constructors

constructor

Properties

data

data: Buffer

meta

meta: ItemsDatMeta = ...

Methods

decode

encode

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/classes/Peer.html b/docs/classes/Peer.html index f6bf228..39031f9 100644 --- a/docs/classes/Peer.html +++ b/docs/classes/Peer.html @@ -1,14 +1,14 @@ -Peer | growtopia.js

Class Peer<T>

Type Parameters

Constructors

constructor +Peer | growtopia.js

Class Peer<T>

Type Parameters

Constructors

constructor

Properties

data

Methods

disconnect send send -

Constructors

constructor

Properties

data

data: T

Methods

disconnect

  • disconnect(type?): void

  • Disconnects the peer.

    +

Constructors

constructor

Properties

data

data: T

Methods

disconnect

  • disconnect(type?): void

  • Disconnects the peer.

    Parameters

    • type: "now" | "later" | "normal" = "later"

      Type of disconnection. Defaults to later.

      -

    Returns void

send

  • send(...data): void

  • Sends multiple packets to a single peer.

    +

Returns void

send

Staticsend

Returns void

Staticsend

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/classes/TankPacket.html b/docs/classes/TankPacket.html index a6f5cc5..46d1572 100644 --- a/docs/classes/TankPacket.html +++ b/docs/classes/TankPacket.html @@ -1,15 +1,15 @@ TankPacket | growtopia.js

Class TankPacket

Represent a TankPacket.

-

Constructors

constructor +

Constructors

constructor

Properties

data?

Methods

parse from fromBuffer

Constructors

constructor

Properties

Optionaldata

data?: Tank

The tankpacket header and data.

-

Methods

parse

Staticfrom

  • from(data): TankPacket

  • Creates a new instance of the TankPacket class.

    +

Returns TankPacket

Properties

Optionaldata

data?: Tank

The tankpacket header and data.

+

Methods

parse

Staticfrom

StaticfromBuffer

  • fromBuffer(buf): TankPacket

  • Converts a buffer to a tank packet.

    +

Returns TankPacket

StaticfromBuffer

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Returns TankPacket

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/classes/TextPacket.html b/docs/classes/TextPacket.html index 55d8911..9b88f55 100644 --- a/docs/classes/TextPacket.html +++ b/docs/classes/TextPacket.html @@ -1,5 +1,5 @@ TextPacket | growtopia.js

Class TextPacket

TextPacket class to create text packets such as for actions or other uses.

-

Constructors

constructor +

Constructors

constructor

Properties

strings type

Methods

parse @@ -8,12 +8,12 @@

Constructors

constructor

  • new TextPacket(type, strings): TextPacket

  • Creates a new TextPacket class

    Parameters

    • type: number

      The type of the packet.

    • strings: string[]

      An array of strings to include, they will be joined by a newline character. (\n)

      -

    Returns TextPacket

Properties

strings

strings: string[]

An array of strings to include, they will be joined by a newline character. (\n)

-

type

type: number

The type of the packet.

-

Methods

parse

Staticfrom

  • from(type, ...strings): TextPacket

  • Creates a TextPacket class.

    +

Returns TextPacket

Properties

strings

strings: string[]

An array of strings to include, they will be joined by a newline character. (\n)

+

type

type: number

The type of the packet.

+

Methods

parse

Staticfrom

  • from(type, ...strings): TextPacket

  • Creates a TextPacket class.

    Parameters

    • type: number

      The type of the packet.

    • Rest...strings: string[]

      Strings to include to the packet. They are not arrays, but instead they are arguments for the function.

      -

    Returns TextPacket

StaticfromBuffer

  • fromBuffer(packet): TextPacket

  • Creates a TextPacket class from a Buffer.

    +

Returns TextPacket

StaticfromBuffer

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Returns TextPacket

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/classes/Variant.html b/docs/classes/Variant.html index 41917db..78fbeca 100644 --- a/docs/classes/Variant.html +++ b/docs/classes/Variant.html @@ -1,5 +1,5 @@ Variant | growtopia.js

Class Variant

Represents the Variant class.

-

Constructors

constructor +

Constructors

constructor

Properties

args index options @@ -9,10 +9,10 @@

Constructors

constructor

Properties

args

args: VariantArg[]

The arguments of the Variant.

-

index

index: number = 0

options

options: VariantOptions = {}

The options for the variant.

-

Methods

parse

Staticfrom

  • from(opts?, ...args): Variant

  • Creates a new Variant class.

    +

Returns Variant

Properties

args

args: VariantArg[]

The arguments of the Variant.

+

index

index: number = 0

options

options: VariantOptions = {}

The options for the variant.

+

Methods

parse

Staticfrom

StatictoArray

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Returns Variant

StatictoArray

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/enums/PacketTypes.html b/docs/enums/PacketTypes.html index d635876..37edfe4 100644 --- a/docs/enums/PacketTypes.html +++ b/docs/enums/PacketTypes.html @@ -1,5 +1,5 @@ PacketTypes | growtopia.js

Enumeration PacketTypes

Growtopia Packet Types

-

Enumeration Members

ACTION +

Enumeration Members

ACTION CLIENT_LOG_REQ CLIENT_LOG_RES ERROR @@ -8,4 +8,4 @@ TANK TRACK UNK -

Enumeration Members

ACTION

ACTION: 3

CLIENT_LOG_REQ

CLIENT_LOG_REQ: 7

CLIENT_LOG_RES

CLIENT_LOG_RES: 8

ERROR

ERROR: 5

HELLO

HELLO: 1

STR

STR: 2

TANK

TANK: 4

TRACK

TRACK: 6

UNK

UNK: 0

Settings

Member Visibility

On This Page

Enumeration Members
+

Enumeration Members

ACTION

ACTION: 3

CLIENT_LOG_REQ

CLIENT_LOG_REQ: 7

CLIENT_LOG_RES

CLIENT_LOG_RES: 8

ERROR

ERROR: 5

HELLO

HELLO: 1

STR

STR: 2

TANK

TANK: 4

TRACK

TRACK: 6

UNK

UNK: 0

Settings

Member Visibility

On This Page

Enumeration Members
diff --git a/docs/enums/VariantTypes.html b/docs/enums/VariantTypes.html index 3d81501..ac62d50 100644 --- a/docs/enums/VariantTypes.html +++ b/docs/enums/VariantTypes.html @@ -1,9 +1,9 @@ VariantTypes | growtopia.js

Enumeration VariantTypes

Types for each Argument.

-

Enumeration Members

FLOAT_1 +

Enumeration Members

FLOAT_1 FLOAT_2 FLOAT_3 NONE SIGNED_INT STRING UNSIGNED_INT -

Enumeration Members

FLOAT_1

FLOAT_1: 1

FLOAT_2

FLOAT_2: 3

FLOAT_3

FLOAT_3: 4

NONE

NONE: 0

SIGNED_INT

SIGNED_INT: 9

STRING

STRING: 2

UNSIGNED_INT

UNSIGNED_INT: 5

Settings

Member Visibility

On This Page

Enumeration Members
+

Enumeration Members

FLOAT_1

FLOAT_1: 1

FLOAT_2

FLOAT_2: 3

FLOAT_3

FLOAT_3: 4

NONE

NONE: 0

SIGNED_INT

SIGNED_INT: 9

STRING

STRING: 2

UNSIGNED_INT

UNSIGNED_INT: 5

Settings

Member Visibility

On This Page

Enumeration Members
diff --git a/docs/functions/parseText.html b/docs/functions/parseText.html index 6065929..3b2ff7d 100644 --- a/docs/functions/parseText.html +++ b/docs/functions/parseText.html @@ -1 +1 @@ -parseText | growtopia.js

Function parseText

  • parseText(chunk): Record<string, string | number>

  • Parameters

    • chunk: Buffer

    Returns Record<string, string | number>

Settings

Member Visibility
+parseText | growtopia.js

Function parseText

  • parseText(chunk): Record<string, string | number>

  • Parameters

    • chunk: Buffer

    Returns Record<string, string | number>

Settings

Member Visibility
diff --git a/docs/interfaces/ActionEvent.html b/docs/interfaces/ActionEvent.html index bc06ccc..2ddae94 100644 --- a/docs/interfaces/ActionEvent.html +++ b/docs/interfaces/ActionEvent.html @@ -1,2 +1,2 @@ -ActionEvent | growtopia.js

Interface ActionEvent

interface ActionEvent {
    action: string;
    [key: string]: string;
}

Indexable

  • [key: string]: string

Properties

action -

Properties

action

action: string

Settings

Member Visibility

On This Page

Properties
+ActionEvent | growtopia.js

Interface ActionEvent

interface ActionEvent {
    action: string;
    [key: string]: string;
}

Indexable

  • [key: string]: string

Properties

action +

Properties

action

action: string

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/Caching.html b/docs/interfaces/Caching.html index 422efbb..edf964f 100644 --- a/docs/interfaces/Caching.html +++ b/docs/interfaces/Caching.html @@ -1,2 +1,2 @@ -Caching | growtopia.js

Interface Caching

interface Caching {
    players?: Map<number, number>;
}

Properties

players? -

Properties

Optionalplayers

players?: Map<number, number>

Settings

Member Visibility

On This Page

Properties
+Caching | growtopia.js

Interface Caching

interface Caching {
    players?: Map<number, number>;
}

Properties

players? +

Properties

Optionalplayers

players?: Map<number, number>

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/ClientOptions.html b/docs/interfaces/ClientOptions.html index fb8b984..be10038 100644 --- a/docs/interfaces/ClientOptions.html +++ b/docs/interfaces/ClientOptions.html @@ -1,3 +1,3 @@ -ClientOptions | growtopia.js

Interface ClientOptions

interface ClientOptions {
    enet?: ENetServerOptions;
}

Properties

enet? +ClientOptions | growtopia.js

Interface ClientOptions

interface ClientOptions {
    enet?: ENetServerOptions;
}

Properties

enet?

Properties

Optionalenet

enet?: ENetServerOptions

Built-in https web server

-

Settings

Member Visibility

On This Page

Properties
+

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/ClientType.html b/docs/interfaces/ClientType.html index 2bd6b15..7a5fe56 100644 --- a/docs/interfaces/ClientType.html +++ b/docs/interfaces/ClientType.html @@ -1,4 +1,4 @@ -ClientType | growtopia.js

Interface ClientType

interface ClientType {
    connect: ((ipAddress: string, port: number, peerID: number) => boolean);
    create: ((maxPeers: number, isClient: boolean) => void);
    deInit: (() => void);
    disconnect: ((peerID: number) => void);
    disconnectLater: ((peerID: number) => void);
    disconnectNow: ((peerID: number) => void);
    getPeer: ((peerID: number) => NativePeerMethod);
    ip: string;
    port: number;
    send: ((peerID: number, count: number, packets: Buffer[]) => void);
    service: (() => void);
    setEmit: ((emit: ((...args: any[]) => void)) => void);
    toggleNewPacket: (() => void);
}

Properties

connect +ClientType | growtopia.js

Interface ClientType

interface ClientType {
    connect: ((ipAddress: string, port: number, peerID: number) => boolean);
    create: ((maxPeers: number, isClient: boolean) => void);
    deInit: (() => void);
    disconnect: ((peerID: number) => void);
    disconnectLater: ((peerID: number) => void);
    disconnectNow: ((peerID: number) => void);
    getPeer: ((peerID: number) => NativePeerMethod);
    ip: string;
    port: number;
    send: ((peerID: number, count: number, packets: Buffer[]) => void);
    service: (() => void);
    setEmit: ((emit: ((...args: any[]) => void)) => void);
    toggleNewPacket: (() => void);
}

Properties

connect create deInit disconnect @@ -12,4 +12,4 @@ setEmit toggleNewPacket

Properties

connect

connect: ((ipAddress: string, port: number, peerID: number) => boolean)

Return ENetPeerState enum value

-

create

create: ((maxPeers: number, isClient: boolean) => void)

deInit

deInit: (() => void)

disconnect

disconnect: ((peerID: number) => void)

disconnectLater

disconnectLater: ((peerID: number) => void)

disconnectNow

disconnectNow: ((peerID: number) => void)

getPeer

getPeer: ((peerID: number) => NativePeerMethod)

ip

ip: string

port

port: number

send

send: ((peerID: number, count: number, packets: Buffer[]) => void)

service

service: (() => void)

setEmit

setEmit: ((emit: ((...args: any[]) => void)) => void)

toggleNewPacket

toggleNewPacket: (() => void)

Settings

Member Visibility

On This Page

Properties
+

create

create: ((maxPeers: number, isClient: boolean) => void)

deInit

deInit: (() => void)

disconnect

disconnect: ((peerID: number) => void)

disconnectLater

disconnectLater: ((peerID: number) => void)

disconnectNow

disconnectNow: ((peerID: number) => void)

getPeer

getPeer: ((peerID: number) => NativePeerMethod)

ip

ip: string

port

port: number

send

send: ((peerID: number, count: number, packets: Buffer[]) => void)

service

service: (() => void)

setEmit

setEmit: ((emit: ((...args: any[]) => void)) => void)

toggleNewPacket

toggleNewPacket: (() => void)

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/ENetServerOptions.html b/docs/interfaces/ENetServerOptions.html index a10cfb8..a87c0b9 100644 --- a/docs/interfaces/ENetServerOptions.html +++ b/docs/interfaces/ENetServerOptions.html @@ -1,5 +1,5 @@ -ENetServerOptions | growtopia.js

Interface ENetServerOptions

interface ENetServerOptions {
    ip?: string;
    maxPeers?: number;
    port?: number;
    useNewPacket?: {
        asClient?: boolean;
    };
}

Properties

ip? +ENetServerOptions | growtopia.js

Interface ENetServerOptions

interface ENetServerOptions {
    ip?: string;
    maxPeers?: number;
    port?: number;
    useNewPacket?: {
        asClient?: boolean;
    };
}

Properties

ip? maxPeers? port? useNewPacket? -

Properties

Optionalip

ip?: string

OptionalmaxPeers

maxPeers?: number

Optionalport

port?: number

OptionaluseNewPacket

useNewPacket?: {
    asClient?: boolean;
}

Settings

Member Visibility

On This Page

Properties
+

Properties

Optionalip

ip?: string

OptionalmaxPeers

maxPeers?: number

Optionalport

port?: number

OptionaluseNewPacket

useNewPacket?: {
    asClient?: boolean;
}

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/ExtendString.html b/docs/interfaces/ExtendString.html index cf7751f..1458dbb 100644 --- a/docs/interfaces/ExtendString.html +++ b/docs/interfaces/ExtendString.html @@ -1,3 +1,3 @@ -ExtendString | growtopia.js

Interface ExtendString

interface ExtendString {
    raw: Buffer;
    value: string;
}

Properties

raw +ExtendString | growtopia.js

Interface ExtendString

interface ExtendString {
    raw: Buffer;
    value: string;
}

Properties

raw value -

Properties

raw

raw: Buffer

value

value: string

Settings

Member Visibility

On This Page

Properties
+

Properties

raw

raw: Buffer

value

value: string

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/ItemDefinition.html b/docs/interfaces/ItemDefinition.html index c75e298..11ec31d 100644 --- a/docs/interfaces/ItemDefinition.html +++ b/docs/interfaces/ItemDefinition.html @@ -1,4 +1,4 @@ -ItemDefinition | growtopia.js

Interface ItemDefinition

interface ItemDefinition {
    audioVolume?: number;
    blockType?: number;
    bodyPart?: Buffer;
    bodyPartType?: number;
    breakHits?: number;
    collisionType?: number;
    extraBytes?: Buffer;
    extraFile?: ExtendString;
    extraFileHash?: number;
    extraFlags1?: number;
    extraHash1?: number;
    extraOptions?: ExtendString;
    extraOptions2?: ExtendString;
    extraTexture?: ExtendString;
    flags?: number;
    flags2?: number;
    flags3?: number;
    flags4?: number;
    flags5?: number;
    flagsCategory?: number;
    growTime?: number;
    id?: number;
    ingredient?: number;
    isMultiFace?: number;
    isRayman?: number;
    isStripeyWallpaper?: number;
    itemRenderer?: ExtendString;
    materialType?: number;
    maxAmount?: number;
    name?: ExtendString;
    petAbility?: ExtendString;
    petName?: ExtendString;
    petPrefix?: ExtendString;
    petSuffix?: ExtendString;
    punchOptions?: ExtendString;
    rarity?: number;
    resetStateAfter?: number;
    seedBase?: number;
    seedColor?: number;
    seedOverlay?: number;
    seedOverlayColor?: number;
    storageType?: number;
    texture?: ExtendString;
    texture2?: ExtendString;
    textureHash?: number;
    textureX?: number;
    textureY?: number;
    treeBase?: number;
    treeLeaves?: number;
    type?: number;
    unknownBytes1?: Buffer;
    unknownInt1?: number;
    visualEffectType?: number;
    [key: string]: any;
}

Indexable

  • [key: string]: any

Properties

audioVolume? +ItemDefinition | growtopia.js

Interface ItemDefinition

interface ItemDefinition {
    audioVolume?: number;
    blockType?: number;
    bodyPart?: Buffer;
    bodyPartType?: number;
    breakHits?: number;
    collisionType?: number;
    extraBytes?: Buffer;
    extraFile?: ExtendString;
    extraFileHash?: number;
    extraFlags1?: number;
    extraHash1?: number;
    extraOptions?: ExtendString;
    extraOptions2?: ExtendString;
    extraTexture?: ExtendString;
    flags?: number;
    flags2?: number;
    flags3?: number;
    flags4?: number;
    flags5?: number;
    flagsCategory?: number;
    growTime?: number;
    id?: number;
    ingredient?: number;
    isMultiFace?: number;
    isRayman?: number;
    isStripeyWallpaper?: number;
    itemRenderer?: ExtendString;
    materialType?: number;
    maxAmount?: number;
    name?: ExtendString;
    petAbility?: ExtendString;
    petName?: ExtendString;
    petPrefix?: ExtendString;
    petSuffix?: ExtendString;
    punchOptions?: ExtendString;
    rarity?: number;
    resetStateAfter?: number;
    seedBase?: number;
    seedColor?: number;
    seedOverlay?: number;
    seedOverlayColor?: number;
    storageType?: number;
    texture?: ExtendString;
    texture2?: ExtendString;
    textureHash?: number;
    textureX?: number;
    textureY?: number;
    treeBase?: number;
    treeLeaves?: number;
    type?: number;
    unknownBytes1?: Buffer;
    unknownInt1?: number;
    visualEffectType?: number;
    [key: string]: any;
}

Indexable

  • [key: string]: any

Properties

audioVolume? blockType? bodyPart? bodyPartType? @@ -51,4 +51,4 @@ unknownBytes1? unknownInt1? visualEffectType? -

Properties

OptionalaudioVolume

audioVolume?: number

OptionalblockType

blockType?: number

OptionalbodyPart

bodyPart?: Buffer

OptionalbodyPartType

bodyPartType?: number

OptionalbreakHits

breakHits?: number

OptionalcollisionType

collisionType?: number

OptionalextraBytes

extraBytes?: Buffer

OptionalextraFile

extraFile?: ExtendString

OptionalextraFileHash

extraFileHash?: number

OptionalextraFlags1

extraFlags1?: number

OptionalextraHash1

extraHash1?: number

OptionalextraOptions

extraOptions?: ExtendString

OptionalextraOptions2

extraOptions2?: ExtendString

OptionalextraTexture

extraTexture?: ExtendString

Optionalflags

flags?: number

Optionalflags2

flags2?: number

Optionalflags3

flags3?: number

Optionalflags4

flags4?: number

Optionalflags5

flags5?: number

OptionalflagsCategory

flagsCategory?: number

OptionalgrowTime

growTime?: number

Optionalid

id?: number

Optionalingredient

ingredient?: number

OptionalisMultiFace

isMultiFace?: number

OptionalisRayman

isRayman?: number

OptionalisStripeyWallpaper

isStripeyWallpaper?: number

OptionalitemRenderer

itemRenderer?: ExtendString

OptionalmaterialType

materialType?: number

OptionalmaxAmount

maxAmount?: number

Optionalname

name?: ExtendString

OptionalpetAbility

petAbility?: ExtendString

OptionalpetName

petName?: ExtendString

OptionalpetPrefix

petPrefix?: ExtendString

OptionalpetSuffix

petSuffix?: ExtendString

OptionalpunchOptions

punchOptions?: ExtendString

Optionalrarity

rarity?: number

OptionalresetStateAfter

resetStateAfter?: number

OptionalseedBase

seedBase?: number

OptionalseedColor

seedColor?: number

OptionalseedOverlay

seedOverlay?: number

OptionalseedOverlayColor

seedOverlayColor?: number

OptionalstorageType

storageType?: number

Optionaltexture

texture?: ExtendString

Optionaltexture2

texture2?: ExtendString

OptionaltextureHash

textureHash?: number

OptionaltextureX

textureX?: number

OptionaltextureY

textureY?: number

OptionaltreeBase

treeBase?: number

OptionaltreeLeaves

treeLeaves?: number

Optionaltype

type?: number

OptionalunknownBytes1

unknownBytes1?: Buffer

OptionalunknownInt1

unknownInt1?: number

OptionalvisualEffectType

visualEffectType?: number

Settings

Member Visibility

On This Page

Properties
+

Properties

OptionalaudioVolume

audioVolume?: number

OptionalblockType

blockType?: number

OptionalbodyPart

bodyPart?: Buffer

OptionalbodyPartType

bodyPartType?: number

OptionalbreakHits

breakHits?: number

OptionalcollisionType

collisionType?: number

OptionalextraBytes

extraBytes?: Buffer

OptionalextraFile

extraFile?: ExtendString

OptionalextraFileHash

extraFileHash?: number

OptionalextraFlags1

extraFlags1?: number

OptionalextraHash1

extraHash1?: number

OptionalextraOptions

extraOptions?: ExtendString

OptionalextraOptions2

extraOptions2?: ExtendString

OptionalextraTexture

extraTexture?: ExtendString

Optionalflags

flags?: number

Optionalflags2

flags2?: number

Optionalflags3

flags3?: number

Optionalflags4

flags4?: number

Optionalflags5

flags5?: number

OptionalflagsCategory

flagsCategory?: number

OptionalgrowTime

growTime?: number

Optionalid

id?: number

Optionalingredient

ingredient?: number

OptionalisMultiFace

isMultiFace?: number

OptionalisRayman

isRayman?: number

OptionalisStripeyWallpaper

isStripeyWallpaper?: number

OptionalitemRenderer

itemRenderer?: ExtendString

OptionalmaterialType

materialType?: number

OptionalmaxAmount

maxAmount?: number

Optionalname

name?: ExtendString

OptionalpetAbility

petAbility?: ExtendString

OptionalpetName

petName?: ExtendString

OptionalpetPrefix

petPrefix?: ExtendString

OptionalpetSuffix

petSuffix?: ExtendString

OptionalpunchOptions

punchOptions?: ExtendString

Optionalrarity

rarity?: number

OptionalresetStateAfter

resetStateAfter?: number

OptionalseedBase

seedBase?: number

OptionalseedColor

seedColor?: number

OptionalseedOverlay

seedOverlay?: number

OptionalseedOverlayColor

seedOverlayColor?: number

OptionalstorageType

storageType?: number

Optionaltexture

texture?: ExtendString

Optionaltexture2

texture2?: ExtendString

OptionaltextureHash

textureHash?: number

OptionaltextureX

textureX?: number

OptionaltextureY

textureY?: number

OptionaltreeBase

treeBase?: number

OptionaltreeLeaves

treeLeaves?: number

Optionaltype

type?: number

OptionalunknownBytes1

unknownBytes1?: Buffer

OptionalunknownInt1

unknownInt1?: number

OptionalvisualEffectType

visualEffectType?: number

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/ItemsDatMeta.html b/docs/interfaces/ItemsDatMeta.html index 9f3f563..93ec997 100644 --- a/docs/interfaces/ItemsDatMeta.html +++ b/docs/interfaces/ItemsDatMeta.html @@ -1,4 +1,4 @@ -ItemsDatMeta | growtopia.js

Interface ItemsDatMeta

interface ItemsDatMeta {
    itemCount?: number;
    items: ItemDefinition[];
    version?: number;
}

Properties

itemCount? +ItemsDatMeta | growtopia.js

Interface ItemsDatMeta

interface ItemsDatMeta {
    itemCount?: number;
    items: ItemDefinition[];
    version?: number;
}

Properties

itemCount? items version? -

Properties

OptionalitemCount

itemCount?: number

items

items: ItemDefinition[]

Optionalversion

version?: number

Settings

Member Visibility

On This Page

Properties
+

Properties

OptionalitemCount

itemCount?: number

items

items: ItemDefinition[]

Optionalversion

version?: number

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/LoginInfo.html b/docs/interfaces/LoginInfo.html index 2631aa2..7bf8a6a 100644 --- a/docs/interfaces/LoginInfo.html +++ b/docs/interfaces/LoginInfo.html @@ -1,4 +1,4 @@ -LoginInfo | growtopia.js

Interface LoginInfo

interface LoginInfo {
    aid?: string;
    category?: string;
    cbits?: string;
    country?: string;
    deviceVersion?: string;
    doorID?: string;
    f?: string;
    fhash?: string;
    fz?: string;
    game_version?: string;
    GDPR?: string;
    gid?: string;
    hash?: string;
    hash2?: string;
    klv?: string;
    lmode?: string;
    mac?: string;
    meta?: string;
    platformID?: string;
    player_age?: string;
    ProductId?: string;
    protocol?: string;
    requestedName?: string;
    rid?: string;
    tankIDName?: string;
    tankIDPass?: string;
    token?: string;
    totalPlaytime?: string;
    tr?: string;
    user?: string;
    UUIDToken?: string;
    vid?: string;
    wk?: string;
    zf?: string;
}

Properties

aid? +LoginInfo | growtopia.js

Interface LoginInfo

interface LoginInfo {
    aid?: string;
    category?: string;
    cbits?: string;
    country?: string;
    deviceVersion?: string;
    doorID?: string;
    f?: string;
    fhash?: string;
    fz?: string;
    game_version?: string;
    GDPR?: string;
    gid?: string;
    hash?: string;
    hash2?: string;
    klv?: string;
    lmode?: string;
    mac?: string;
    meta?: string;
    platformID?: string;
    player_age?: string;
    ProductId?: string;
    protocol?: string;
    requestedName?: string;
    rid?: string;
    tankIDName?: string;
    tankIDPass?: string;
    token?: string;
    totalPlaytime?: string;
    tr?: string;
    user?: string;
    UUIDToken?: string;
    vid?: string;
    wk?: string;
    zf?: string;
}

Properties

aid? category? cbits? country? @@ -32,4 +32,4 @@ vid? wk? zf? -

Properties

Optionalaid

aid?: string

Optionalcategory

category?: string

Optionalcbits

cbits?: string

Optionalcountry

country?: string

OptionaldeviceVersion

deviceVersion?: string

OptionaldoorID

doorID?: string

Optionalf

f?: string

Optionalfhash

fhash?: string

Optionalfz

fz?: string

Optionalgame_version

game_version?: string

OptionalGDPR

GDPR?: string

Optionalgid

gid?: string

Optionalhash

hash?: string

Optionalhash2

hash2?: string

Optionalklv

klv?: string

Optionallmode

lmode?: string

Optionalmac

mac?: string

Optionalmeta

meta?: string

OptionalplatformID

platformID?: string

Optionalplayer_age

player_age?: string

OptionalProductId

ProductId?: string

Optionalprotocol

protocol?: string

OptionalrequestedName

requestedName?: string

Optionalrid

rid?: string

OptionaltankIDName

tankIDName?: string

OptionaltankIDPass

tankIDPass?: string

Optionaltoken

token?: string

OptionaltotalPlaytime

totalPlaytime?: string

Optionaltr

tr?: string

Optionaluser

user?: string

OptionalUUIDToken

UUIDToken?: string

Optionalvid

vid?: string

Optionalwk

wk?: string

Optionalzf

zf?: string

Settings

Member Visibility

On This Page

Properties
+

Properties

Optionalaid

aid?: string

Optionalcategory

category?: string

Optionalcbits

cbits?: string

Optionalcountry

country?: string

OptionaldeviceVersion

deviceVersion?: string

OptionaldoorID

doorID?: string

Optionalf

f?: string

Optionalfhash

fhash?: string

Optionalfz

fz?: string

Optionalgame_version

game_version?: string

OptionalGDPR

GDPR?: string

Optionalgid

gid?: string

Optionalhash

hash?: string

Optionalhash2

hash2?: string

Optionalklv

klv?: string

Optionallmode

lmode?: string

Optionalmac

mac?: string

Optionalmeta

meta?: string

OptionalplatformID

platformID?: string

Optionalplayer_age

player_age?: string

OptionalProductId

ProductId?: string

Optionalprotocol

protocol?: string

OptionalrequestedName

requestedName?: string

Optionalrid

rid?: string

OptionaltankIDName

tankIDName?: string

OptionaltankIDPass

tankIDPass?: string

Optionaltoken

token?: string

OptionaltotalPlaytime

totalPlaytime?: string

Optionaltr

tr?: string

Optionaluser

user?: string

OptionalUUIDToken

UUIDToken?: string

Optionalvid

vid?: string

Optionalwk

wk?: string

Optionalzf

zf?: string

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/NativePeerAddress.html b/docs/interfaces/NativePeerAddress.html index bd27355..7607c8f 100644 --- a/docs/interfaces/NativePeerAddress.html +++ b/docs/interfaces/NativePeerAddress.html @@ -1,3 +1,3 @@ -NativePeerAddress | growtopia.js

Interface NativePeerAddress

interface NativePeerAddress {
    address: string;
    port: number;
}

Properties

address +NativePeerAddress | growtopia.js

Interface NativePeerAddress

interface NativePeerAddress {
    address: string;
    port: number;
}

Properties

address port -

Properties

address

address: string

port

port: number

Settings

Member Visibility

On This Page

Properties
+

Properties

address

address: string

port

port: number

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/NativePeerMethod.html b/docs/interfaces/NativePeerMethod.html index c284b4c..f3f5851 100644 --- a/docs/interfaces/NativePeerMethod.html +++ b/docs/interfaces/NativePeerMethod.html @@ -1,4 +1,4 @@ -NativePeerMethod | growtopia.js

Interface NativePeerMethod

interface NativePeerMethod {
    getAddress: (() => NativePeerAddress);
    getChannelCount: (() => number);
    getConnectID: (() => number);
    getIncomingBandwidth: (() => unknown);
    getOutgoingBandwidth: (() => number);
    getPacketsLost: (() => number);
    getPacketsSent: (() => number);
    getRTT: (() => number);
    getState: (() => number);
    getTotalWaitingData: (() => number);
}

Properties

getAddress +NativePeerMethod | growtopia.js

Interface NativePeerMethod

interface NativePeerMethod {
    getAddress: (() => NativePeerAddress);
    getChannelCount: (() => number);
    getConnectID: (() => number);
    getIncomingBandwidth: (() => unknown);
    getOutgoingBandwidth: (() => number);
    getPacketsLost: (() => number);
    getPacketsSent: (() => number);
    getRTT: (() => number);
    getState: (() => number);
    getTotalWaitingData: (() => number);
}

Properties

getAddress getChannelCount getConnectID getIncomingBandwidth @@ -8,4 +8,4 @@ getRTT getState getTotalWaitingData -

Properties

getAddress

getAddress: (() => NativePeerAddress)

getChannelCount

getChannelCount: (() => number)

getConnectID

getConnectID: (() => number)

getIncomingBandwidth

getIncomingBandwidth: (() => unknown)

getOutgoingBandwidth

getOutgoingBandwidth: (() => number)

getPacketsLost

getPacketsLost: (() => number)

getPacketsSent

getPacketsSent: (() => number)

getRTT

getRTT: (() => number)

getState

getState: (() => number)

getTotalWaitingData

getTotalWaitingData: (() => number)

Settings

Member Visibility

On This Page

Properties
+

Properties

getAddress

getAddress: (() => NativePeerAddress)

getChannelCount

getChannelCount: (() => number)

getConnectID

getConnectID: (() => number)

getIncomingBandwidth

getIncomingBandwidth: (() => unknown)

getOutgoingBandwidth

getOutgoingBandwidth: (() => number)

getPacketsLost

getPacketsLost: (() => number)

getPacketsSent

getPacketsSent: (() => number)

getRTT

getRTT: (() => number)

getState

getState: (() => number)

getTotalWaitingData

getTotalWaitingData: (() => number)

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/PeerData.html b/docs/interfaces/PeerData.html index a865358..fab5872 100644 --- a/docs/interfaces/PeerData.html +++ b/docs/interfaces/PeerData.html @@ -1,3 +1,3 @@ -PeerData | growtopia.js

Interface PeerData

interface PeerData {
    enet: NativePeerMethod;
    netID: number;
}

Properties

enet +PeerData | growtopia.js

Interface PeerData

interface PeerData {
    enet: NativePeerMethod;
    netID: number;
}

Properties

enet netID -

Properties

enet

enet: NativePeerMethod

netID

netID: number

Settings

Member Visibility

On This Page

Properties
+

Properties

enet

enet: NativePeerMethod

netID

netID: number

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/StringOptions.html b/docs/interfaces/StringOptions.html index 0d168a2..9d20ba8 100644 --- a/docs/interfaces/StringOptions.html +++ b/docs/interfaces/StringOptions.html @@ -1,3 +1,3 @@ -StringOptions | growtopia.js

Interface StringOptions

interface StringOptions {
    encoded?: boolean;
    id?: number;
}

Properties

encoded? +StringOptions | growtopia.js

Interface StringOptions

interface StringOptions {
    encoded?: boolean;
    id?: number;
}

Properties

encoded? id? -

Properties

Optionalencoded

encoded?: boolean

Optionalid

id?: number

Settings

Member Visibility

On This Page

Properties
+

Properties

Optionalencoded

encoded?: boolean

Optionalid

id?: number

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/Tank.html b/docs/interfaces/Tank.html index 7a0cc8a..1fac5e5 100644 --- a/docs/interfaces/Tank.html +++ b/docs/interfaces/Tank.html @@ -1,5 +1,5 @@ Tank | growtopia.js

Interface Tank

Represents the data needed for the TankPacket.

-
interface Tank {
    buildRange?: number;
    data?: (() => Buffer);
    info?: number;
    netID?: number;
    packetType?: number;
    punchID?: number;
    punchRange?: number;
    state?: number;
    targetNetID?: number;
    type?: number;
    xPos?: number;
    xPunch?: number;
    xSpeed?: number;
    yPos?: number;
    yPunch?: number;
    ySpeed?: number;
}

Properties

buildRange? +
interface Tank {
    buildRange?: number;
    data?: (() => Buffer);
    info?: number;
    netID?: number;
    packetType?: number;
    punchID?: number;
    punchRange?: number;
    state?: number;
    targetNetID?: number;
    type?: number;
    xPos?: number;
    xPunch?: number;
    xSpeed?: number;
    yPos?: number;
    yPunch?: number;
    ySpeed?: number;
}

Properties

buildRange? data? info? netID? @@ -15,4 +15,4 @@ yPos? yPunch? ySpeed? -

Properties

OptionalbuildRange

buildRange?: number

Optionaldata

data?: (() => Buffer)

Optionalinfo

info?: number

OptionalnetID

netID?: number

OptionalpacketType

packetType?: number

OptionalpunchID

punchID?: number

OptionalpunchRange

punchRange?: number

Optionalstate

state?: number

OptionaltargetNetID

targetNetID?: number

Optionaltype

type?: number

OptionalxPos

xPos?: number

OptionalxPunch

xPunch?: number

OptionalxSpeed

xSpeed?: number

OptionalyPos

yPos?: number

OptionalyPunch

yPunch?: number

OptionalySpeed

ySpeed?: number

Settings

Member Visibility

On This Page

Properties
+

Properties

OptionalbuildRange

buildRange?: number

Optionaldata

data?: (() => Buffer)

Optionalinfo

info?: number

OptionalnetID

netID?: number

OptionalpacketType

packetType?: number

OptionalpunchID

punchID?: number

OptionalpunchRange

punchRange?: number

Optionalstate

state?: number

OptionaltargetNetID

targetNetID?: number

Optionaltype

type?: number

OptionalxPos

xPos?: number

OptionalxPunch

xPunch?: number

OptionalxSpeed

xSpeed?: number

OptionalyPos

yPos?: number

OptionalyPunch

yPunch?: number

OptionalySpeed

ySpeed?: number

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/VariantOptions.html b/docs/interfaces/VariantOptions.html index 1760830..f8e193e 100644 --- a/docs/interfaces/VariantOptions.html +++ b/docs/interfaces/VariantOptions.html @@ -1,6 +1,6 @@ VariantOptions | growtopia.js

Interface VariantOptions

Options for the Variant Packet

-
interface VariantOptions {
    delay?: number;
    netID?: number;
}

Properties

delay? +
interface VariantOptions {
    delay?: number;
    netID?: number;
}

Properties

delay? netID?

Properties

Optionaldelay

delay?: number

They delay (in ms) on when the client will execute the packet.

-

OptionalnetID

netID?: number

The netID of the variant.

-

Settings

Member Visibility

On This Page

Properties
+

OptionalnetID

netID?: number

The netID of the variant.

+

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/VariantTypeBase.html b/docs/interfaces/VariantTypeBase.html index 08a4436..45d8729 100644 --- a/docs/interfaces/VariantTypeBase.html +++ b/docs/interfaces/VariantTypeBase.html @@ -1,4 +1,4 @@ -VariantTypeBase | growtopia.js

Interface VariantTypeBase

interface VariantTypeBase {
    index: number;
    type: number;
    typeName: string;
}

Hierarchy (view full)

Properties

index +VariantTypeBase | growtopia.js

Interface VariantTypeBase

interface VariantTypeBase {
    index: number;
    type: number;
    typeName: string;
}

Hierarchy (view full)

Properties

index type typeName -

Properties

index

index: number

type

type: number

typeName

typeName: string

Settings

Member Visibility

On This Page

Properties
+

Properties

index

index: number

type

type: number

typeName

typeName: string

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/VariantTypeFloat.html b/docs/interfaces/VariantTypeFloat.html index f69b224..57484fb 100644 --- a/docs/interfaces/VariantTypeFloat.html +++ b/docs/interfaces/VariantTypeFloat.html @@ -1,5 +1,5 @@ -VariantTypeFloat | growtopia.js

Interface VariantTypeFloat

interface VariantTypeFloat {
    index: number;
    type: number;
    typeName: string;
    value: number[];
}

Hierarchy (view full)

Properties

index +VariantTypeFloat | growtopia.js

Interface VariantTypeFloat

interface VariantTypeFloat {
    index: number;
    type: number;
    typeName: string;
    value: number[];
}

Hierarchy (view full)

Properties

index type typeName value -

Properties

index

index: number

type

type: number

typeName

typeName: string

value

value: number[]

Settings

Member Visibility

On This Page

Properties
+

Properties

index

index: number

type

type: number

typeName

typeName: string

value

value: number[]

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/VariantTypeNumber.html b/docs/interfaces/VariantTypeNumber.html index ddb7795..65d3d29 100644 --- a/docs/interfaces/VariantTypeNumber.html +++ b/docs/interfaces/VariantTypeNumber.html @@ -1,5 +1,5 @@ -VariantTypeNumber | growtopia.js

Interface VariantTypeNumber

interface VariantTypeNumber {
    index: number;
    type: number;
    typeName: string;
    value: number;
}

Hierarchy (view full)

Properties

index +VariantTypeNumber | growtopia.js

Interface VariantTypeNumber

interface VariantTypeNumber {
    index: number;
    type: number;
    typeName: string;
    value: number;
}

Hierarchy (view full)

Properties

index type typeName value -

Properties

index

index: number

type

type: number

typeName

typeName: string

value

value: number

Settings

Member Visibility

On This Page

Properties
+

Properties

index

index: number

type

type: number

typeName

typeName: string

value

value: number

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/VariantTypeString.html b/docs/interfaces/VariantTypeString.html index 07c0df4..d5f4b69 100644 --- a/docs/interfaces/VariantTypeString.html +++ b/docs/interfaces/VariantTypeString.html @@ -1,5 +1,5 @@ -VariantTypeString | growtopia.js

Interface VariantTypeString

interface VariantTypeString {
    index: number;
    type: number;
    typeName: string;
    value: string;
}

Hierarchy (view full)

Properties

index +VariantTypeString | growtopia.js

Interface VariantTypeString

interface VariantTypeString {
    index: number;
    type: number;
    typeName: string;
    value: string;
}

Hierarchy (view full)

Properties

index type typeName value -

Properties

index

index: number

type

type: number

typeName

typeName: string

value

value: string

Settings

Member Visibility

On This Page

Properties
+

Properties

index

index: number

type

type: number

typeName

typeName: string

value

value: string

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/types/Sendable.html b/docs/types/Sendable.html index 5c41a95..706ab8c 100644 --- a/docs/types/Sendable.html +++ b/docs/types/Sendable.html @@ -1,2 +1,2 @@ Sendable | growtopia.js

Type Alias Sendable

Sendable:
    | Buffer
    | TextPacket
    | TankPacket
    | Variant

Represents the available type of Objects that are sendable to peers.

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/docs/types/VariantArg.html b/docs/types/VariantArg.html index ad675b0..74f2d69 100644 --- a/docs/types/VariantArg.html +++ b/docs/types/VariantArg.html @@ -1,2 +1,2 @@ VariantArg | growtopia.js

Type Alias VariantArg

VariantArg: string | number[] | number

The argument type for the variant.

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/docs/types/VariantArray.html b/docs/types/VariantArray.html index 5afd019..dcb16aa 100644 --- a/docs/types/VariantArray.html +++ b/docs/types/VariantArray.html @@ -1 +1 @@ -VariantArray | growtopia.js

Type Alias VariantArray

VariantArray: VariantTypeString | VariantTypeNumber | VariantTypeFloat

Settings

Member Visibility
+VariantArray | growtopia.js

Type Alias VariantArray

VariantArray: VariantTypeString | VariantTypeNumber | VariantTypeFloat

Settings

Member Visibility
diff --git a/typedoc.json b/typedoc.json index 3ba4daa..384a564 100644 --- a/typedoc.json +++ b/typedoc.json @@ -1,5 +1,6 @@ { "entryPoints": ["./src/index.ts"], + "cname": "gtjs.jad.li", "out": "docs", "theme": "default", "entryPointStrategy": "expand",