+ + + + + KDataReader | Asphyxia CORE Module API + + + + + +

+ +

Class KDataReader

A warpper of javascript object for reading xml-like formatted data.

Hierarchy

+ KDataReader +

Index

Constructors

constructor

Properties

Methods

Constructors

+ +

constructor

new KDataReader(obj: any): KDataReader

+
+
- Defined in asphyxia-core.d.ts:297
+
+
Parameters
+
- +
  obj: any
  +
+
Returns KDataReader
+

Properties

+ +

obj

obj: any

+ +

Wrapped javascript object

Methods

+ +

attr

attr(path?: string): KAttrMap

+ +

Get attrubutes for a tag

Example:

<data>
+  <tag status="1">
+    <inner __type="s32">1</inner>
+    <inner __type="s32">2</inner>
+  </tag>
+</data>

const data = {
+  tag: K.ATTR({ status: "1" }, {
+    inner: [
+      K.ITEM("s32", 1),
+      K.ITEM("s32", 2)
+    ]
+  })
+}

Evals:

$(data).attr("tag") // { status: "1" }
+$(data).element("tag").attr().status // "1"
+$(data).attr("tag.inner.0").__type // "s32"

Parameters

+
Optional path: string
+

bigint

bigint(path: string, def?: bigint): bigint

+ +

Get a bigint value from a tag, convert to bigint if applicable.

Example:

<data>
+  <inner __type="s64">1</inner>
+  <inner __type="s32">2</inner>
+  <invalid __type="str">abc</invalid>
+</data>

const data = {
+  inner: [
+    K.ITEM("s64", 1n),
+    K.ITEM("s32", 2)
+  ],
+  invalid: K.ITEM("str", "abc")
+}

Evals:

$(data).element("inner").bigint() // 1n
+$(data).bigint("inner.1") // 2n
+$(data).bigint("invalid", 3n) // 3n

Parameters

+
path: string
+
+
Optional def: bigint
+
+
Default return value when target path does + not exists or is not valid.
+
+

Returns bigint

+ +

bigints

bigints(path: string, def?: bigint[]): bigint[]

+ +

Get a bigint array from a tag. Only returns valid arrays + when target tag has a type of KBigIntType or KBigIntGroupType

Example:

<data>
+  <inner __type="s64" __count="2">1 2</inner>
+  <invalid __type="s32" __count="2">3 4</invalid>
+</data>

const data = {
+  inner: K.ARRAY("s64", [1n, 2n]),
+  invalid: K.ARRAY("s32", [3, 4])
+}

Evals:

$(data).bigints("inner") // [1n, 2n]
+$(data).bigints("invalid") // undefined

Parameters

+
path: string
+
+
Optional def: bigint[]
+

Returns bigint[]

+ +

bool

bool(path: string): boolean

+ +

Get a boolean value from a tag, return true only if value in the tag is number and greater than zero

Example:

<data>
+  <inner __type="bool">0</inner>
+  <inner __type="s32">2</inner>
+</data>

const data = {
+  inner: [
+    K.ITEM("bool", false),
+    K.ITEM("s32", 2)
+  ]
+}

Evals:

$(data).bool("inner.0") // false
+$(data).bool("inner.1") // true
+$(data).bool("invalid") // false

Parameters

+
path: string
+

Returns boolean

+ +

buffer

buffer(path: string, def?: Buffer): Buffer

+ +

Get a Buffer object from a tag, Only returns valid Buffer + when target tag has a type of "bin"

Example:

<data>
+  <inner __type="bin">00ff</inner>
+  <invalid __type="u8" __count="3">1 2 3</invalid>
+</data>

const data = {
+  inner: K.ITEM("bin", Buffer.from([0x00, 0xff])),
+  invalid: K.ARRAY("u8", [1, 2, 3])
+}

Evals:

$(data).buffer("inner") // <Buffer 00 ff>
+$(data).buffer("invalid") // undefined

Parameters

+
path: string
+
+
Optional def: Buffer
+

Returns Buffer

+ +

content

content(path: string, def?: any): any

+ +

Get raw content representation regardless of tag type

Example:

<data>
+  <number __type="s32">1</number>
+  <array __type="u8" __count="3">1 2 3</array>
+  <string __type="str">abc</string>
+</data>

const data = {
+  number: K.ITEM("s32", 1),
+  array: K.ARRAY("u8", [1, 2, 3]),
+  string: K.ITEM("str", "abc")
+}

Evals:

$(data).content("number") // [1]
+$(data).content("array") // [1, 2, 3]
+$(data).content("string") // "abc"

Parameters

+
path: string
+
+
Optional def: any
+

Returns any

+ +

element

element(path: string): KDataReader

+ +

Get first element named path inside a tag

Example:

<data>
+  <inner>
+    <id __type="s32">1</id>
+  </inner>
+  <inner>
+    <id __type="s32">1</id>
+  </inner>
+</data>

const data = {
+  inner: [
+    { id: K.ITEM("s32", 1) },
+    { id: K.ITEM("s32", 2) }
+  ]
+}

Evals:

$(data).element("inner") // <KDataReader>
+$(data).element("inner").obj // { id: [object] }
+$(data).element("inner").number("id") // 1

Parameters

+
path: string
+

elements

elements(path: string): KDataReader[]

+ +

Get array of all elements named path inside a tag

Example:

<data>
+  <inner>
+    <id __type="s32">1</id>
+  </inner>
+  <inner>
+    <id __type="s32">1</id>
+  </inner>
+</data>

const data = {
+  inner: [
+    { id: K.ITEM("s32", 1) },
+    { id: K.ITEM("s32", 2) }
+  ]
+}

Evals:

$(data).elements("inner") // [<KDataReader>, <KDataReader>]
+$(data).elements("inner")[1].number("id") // 2

Parameters

+
path: string
+

number

number(path: string, def?: number): number

+ +

Get a number value from a tag, convert to number if applicable.

Example:

<data>
+  <inner __type="s64">1</inner>
+  <inner __type="s32">2</inner>
+  <invalid __type="str">abc</invalid>
+</data>

const data = {
+  inner: [
+    K.ITEM("s64", 1n),
+    K.ITEM("s32", 2)
+  ],
+  invalid: K.ITEM("str", "abc")
+}

Evals:

$(data).element("inner").number() // 1
+$(data).number("inner.1") // 2
+$(data).number("invalid", 3) // 3

Parameters

+
path: string
+
+
Optional def: number
+
+
Default return value when target path does + not exists or is not valid.
+
+

Returns number

+ +

numbers

numbers(path: string, def?: number[]): number[]

+ +

Get a number array from a tag. Only returns valid arrays + when target tag has a type of KNumberType or KNumberGroupType

Example:

<data>
+  <inner __type="s64" __count="2">1 2</inner>
+  <invalid __type="s32" __count="2">3 4</invalid>
+</data>

const data = {
+  invalid: K.ARRAY("s64", [1n, 2n]),
+  inner: K.ARRAY("s32", [3, 4])
+}

Evals:

$(data).bigints("invalid") // undefined
+$(data).bigints("inner") // [3, 4]

Parameters

+
path: string
+
+
Optional def: number[]
+

Returns number[]

+ +

str

str(path: string, def?: string): string

+ +

Get a string from a tag, Only returns valid string + when target tag has a type of "str"

Example:

<data>
+  <inner __type="str">abc</inner>
+  <invalid __type="s32">1</invalid>
+</data>

const data = {
+  inner: K.ITEM("str", "abc"),
+  invalid: K.ITEM("s32", 1)
+}

Evals:

$(data).str("inner") // "abc"
+$(data).str("invalid") // undefined

Parameters

+
path: string
+
+
Optional def: string
+

Returns string

+ +

+ KDataReader +
- + constructor +
- + obj +
- + attr +
- + bigint +
- + bigints +
- + bool +
- + buffer +
- + content +
- + element +
- + elements +
- + number +
- + numbers +
- + str +
+

+ +

Generated using TypeDoc

+ + + + \ No newline at end of file diff --git a/typedoc/globals.html b/typedoc/globals.html new file mode 100644 index 0000000..5b0fe31 --- /dev/null +++ b/typedoc/globals.html @@ -0,0 +1,344 @@ + + + + + + Asphyxia CORE Module API + + + + + +

+ +

Asphyxia CORE Module API

Index

Namespaces

Classes

KDataReader

Interfaces

Type aliases

+ +

EPR

EPR: EamusePluginRoute

+ +

Helper type for typing your custom route.

Alias for EamusePluginRoute

+ +

EamusePluginRoute

EamusePluginRoute: (req: EamuseInfo, data: any, send: EamuseSend) => Promise<any>

+ +

Helper type for typing your custom route.

Type declaration

+
- (req: EamuseInfo, data: any, send: EamuseSend): Promise<any>
+
- +
  Parameters
  +
  - +
    req: EamuseInfo
    +
  - +
    data: any
    +
  - +
    send: EamuseSend
    +
  +
  Returns Promise<any>
  +
+

+ +

KAttrMap

KAttrMap: {}

+ +

Attribute object

Type declaration

+
[key: string]: string
+

+ +

KBigIntGroupType

KBigIntGroupType: "2s64" | "2u64" | "3s64" | "3u64" | "4s64" | "4u64" | "vs8" | "vu8" | "vs16" | "vu16"

+ +

KBigIntType

KBigIntType: "s64" | "u64"

+ +

KEncoding

KEncoding: "shift_jis" | "utf8" | "euc-jp" | "ascii" | "iso-8859-1"

+ +

Supported response encoding

+ +

KNumberGroupType

KNumberGroupType: "2s8" | "2u8" | "2s16" | "2u16" | "2s32" | "2u32" | "2f" | "2d" | "3s8" | "3u8" | "3s16" | "3u16" | "3s32" | "3u32" | "3f" | "3d" | "4s8" | "4u8" | "4s16" | "4u16" | "4s32" | "4u32" | "4f" | "4d" | "2b" | "3b" | "4b" | "vb"

+ +

KNumberType

KNumberType: "s8" | "u8" | "s16" | "u16" | "s32" | "u32" | "time" | "ip4" | "float" | "double" | "bool"

+ +

+ + +

+ +

Generated using TypeDoc

+ + + + \ No newline at end of file diff --git a/typedoc/index.html b/typedoc/index.html new file mode 100644 index 0000000..0143c55 --- /dev/null +++ b/typedoc/index.html @@ -0,0 +1,165 @@ + + + + + + Asphyxia CORE Module API + + + + + +

+ +

Asphyxia CORE Module API

+ +

Asphyxia CORE

+ +

Quick Start guide coming soon.

+ + +

+ +

Generated using TypeDoc

+ + + + \ No newline at end of file diff --git a/typedoc/interfaces/config_options.html b/typedoc/interfaces/config_options.html new file mode 100644 index 0000000..e9a6465 --- /dev/null +++ b/typedoc/interfaces/config_options.html @@ -0,0 +1,353 @@ + + + + + + CONFIG_OPTIONS | Asphyxia CORE Module API + + + + + +

+ +

Interface CONFIG_OPTIONS

Detail of a config

Hierarchy

+ CONFIG_OPTIONS +

Index

Properties

+ +

default

default: any

+ +

Default value of the option

+ +

Optional desc

desc: string

+ +

Provide a description for the option

+ +

Optional name

name: string

+ +

Provide a name to display in webui. If not provided, webui will use key as the name.

+ +

Optional needRestart

needRestart: boolean

+ +

Indicate whether user need to restart CORE to see changes.

+ +

Optional options

options: string[]

+ +

Only applies to 'string', provide options in a dropdown menu.

+ +

Optional range

range: [number, number]

+ +

Only applies to 'integer' and 'float'

+ +

type

type: "string" | "integer" | "float" | "boolean"

+ +

Type of the option

+ +

Optional validator

validator: (data: string) => true | string

+ +

Validator for notify user about invalid values. return true to pass the validation. return a string to send a error message to WebUI.

Type declaration

+
- (data: string): true | string
+
- +
  Parameters
  +
  - +
    data: string
    +
  +
  Returns true | string
  +
+

+ + +

+ +

Generated using TypeDoc

+ + + + \ No newline at end of file diff --git a/typedoc/interfaces/eamuseinfo.html b/typedoc/interfaces/eamuseinfo.html new file mode 100644 index 0000000..92468be --- /dev/null +++ b/typedoc/interfaces/eamuseinfo.html @@ -0,0 +1,222 @@ + + + + + + EamuseInfo | Asphyxia CORE Module API + + + + + +

+ +

Interface EamuseInfo

Information about requester

Hierarchy

+ EamuseInfo +

Index

Properties

+ +

method

method: string

+ +

model

model: string

+ +

module

module: string

+ +

+ + +

+ +

Generated using TypeDoc

+ + + + \ No newline at end of file diff --git a/typedoc/interfaces/eamusesend.html b/typedoc/interfaces/eamusesend.html new file mode 100644 index 0000000..baaee06 --- /dev/null +++ b/typedoc/interfaces/eamusesend.html @@ -0,0 +1,595 @@ + + + + + + EamuseSend | Asphyxia CORE Module API + + + + + +

+ +

Interface EamuseSend

Hierarchy

+ EamuseSend +

Index

Properties

+ +

deny

deny: (options?: EamuseSendOption) => Promise<void>

+ +

Send empty response with status code 1

Type declaration

+
- (options?: EamuseSendOption): Promise<void>
+
- +
  Parameters
  +
  - +
    Optional options: EamuseSendOption
    +
  +
  Returns Promise<void>
  +
+

+ +

object

object: (res: any, options?: EamuseSendOption) => Promise<void>

+ +

Send plain javascript object. + When constructing objects, make sure to use helper K:

{
+  outter: K.ATTR({ status: "1" }, {
+    inner: K.ITEM("s32", 1)
+  })
+}

Or follow xml-like format manually:

{
+  outter: {
+    "@attr": { status: "1" },
+    inner: {
+      "@attr": { __type: "s32" },
+      "@content": [1]
+    }
+  }
+}

param: xml-like formatted javascript object
+
param: Response options. See: EamuseSendOption
+

Type declaration

+
- (res: any, options?: EamuseSendOption): Promise<void>
+
- +
  Parameters
  +
  - +
    res: any
    +
  - +
    Optional options: EamuseSendOption
    +
  +
  Returns Promise<void>
  +
+

+ +

pug

pug: (res: string, data?: any, options?: EamuseSendOption) => Promise<void>

+ +

Send xml data using pug template system.

param: pug string as the template
+
param: Render template with specified data, + pass null or undefined to render static xml
+
param: Response options. See: EamuseSendOption
+

Type declaration

+
- (res: string, data?: any, options?: EamuseSendOption): Promise<void>
+
- +
  Parameters
  +
  - +
    res: string
    +
  - +
    Optional data: any
    +
  - +
    Optional options: EamuseSendOption
    +
  +
  Returns Promise<void>
  +
+

+ +

pugFile

pugFile: (file: string, data?: any, options?: EamuseSendOption) => Promise<void>

+ +

Render and send pug template from a file

param: Filename of the template
+
param: Render template with specified data, + pass null or undefined to render static xml
+
param: Response options. See: EamuseSendOption
+

Type declaration

+
- (file: string, data?: any, options?: EamuseSendOption): Promise<void>
+
- +
  Parameters
  +
  - +
    file: string
    +
  - +
    Optional data: any
    +
  - +
    Optional options: EamuseSendOption
    +
  +
  Returns Promise<void>
  +
+

+ +

status

status: (code: number, options?: EamuseSendOption) => Promise<void>

+ +

Send empty response with custom status code

Type declaration

+
- (code: number, options?: EamuseSendOption): Promise<void>
+
- +
  Parameters
  +
  - +
    code: number
    +
  - +
    Optional options: EamuseSendOption
    +
  +
  Returns Promise<void>
  +
+

+ +

success

success: (options?: EamuseSendOption) => Promise<void>

+ +

Send empty response with status code 0

Type declaration

+
- (options?: EamuseSendOption): Promise<void>
+
- +
  Parameters
  +
  - +
    Optional options: EamuseSendOption
    +
  +
  Returns Promise<void>
  +
+

+ +

xml

xml: (res: string, data?: any, options?: EamuseSendOption) => Promise<void>

+ +

Send xml data using ejs template system.

param: xml string as the template
+
param: Render template with specified data, + pass null or undefined to render static xml
+
param: Response options. See: EamuseSendOption
+

Type declaration

+
- (res: string, data?: any, options?: EamuseSendOption): Promise<void>
+
- +
  Parameters
  +
  - +
    res: string
    +
  - +
    Optional data: any
    +
  - +
    Optional options: EamuseSendOption
    +
  +
  Returns Promise<void>
  +
+

+ +

xmlFile

xmlFile: (file: string, data?: any, options?: EamuseSendOption) => Promise<void>

+ +

Render and send ejs template from a file

param: Filename of the template
+
param: Render template with specified data, + pass null or undefined to render static xml
+
param: Response options. See: EamuseSendOption
+

Type declaration

+
- (file: string, data?: any, options?: EamuseSendOption): Promise<void>
+
- +
  Parameters
  +
  - +
    file: string
    +
  - +
    Optional data: any
    +
  - +
    Optional options: EamuseSendOption
    +
  +
  Returns Promise<void>
  +
+

+ +

+ EamuseSend +
- + deny +
- + object +
- + pug +
- + pugFile +
- + status +
- + success +
- + xml +
- + xmlFile +
+

+ +

Generated using TypeDoc

+ + + + \ No newline at end of file diff --git a/typedoc/interfaces/eamusesendoption.html b/typedoc/interfaces/eamusesendoption.html new file mode 100644 index 0000000..8a24519 --- /dev/null +++ b/typedoc/interfaces/eamusesendoption.html @@ -0,0 +1,277 @@ + + + + + + EamuseSendOption | Asphyxia CORE Module API + + + + + +

+ +

Interface EamuseSendOption

Response options

Hierarchy

+ EamuseSendOption +

Index

Properties

+ +

Optional compress

compress: boolean

+ +

Optional encoding

encoding: KEncoding

+ +

Encode response with specified encoding + Default: 'SHIFT_JIS'

+ +

Optional encrypt

encrypt: boolean

+ +

Optional kencode

kencode: boolean

+ +

Optional rootName

rootName: string

+ +

Replace response root tag name. + Default to child tag name of request tag, + which is usually the case and don't need to be replaced.

+ +

Optional status

status: number

+ +

+ + +

+ +

Generated using TypeDoc

+ + + + \ No newline at end of file diff --git a/typedoc/modules/_.html b/typedoc/modules/_.html new file mode 100644 index 0000000..cd76df6 --- /dev/null +++ b/typedoc/modules/_.html @@ -0,0 +1,522 @@ + + + + + + $ | Asphyxia CORE Module API + + + + + +

+ +

Namespace $

Callable

$(data: any): KDataReader

+
+
- Defined in asphyxia-core.d.ts:625
+
+
+
+
Helper for reading xml-like formatted data.
+
+
+
Parameters
+
- +
  data: any
  +
+
Returns KDataReader
+

Index

Functions

+ +

ATTR

ATTR(data: any, path?: string): KAttrMap

+
+
- Defined in asphyxia-core.d.ts:627
+
+
Parameters
+
- +
  data: any
  +
- +
  Optional path: string
  +
+
Returns KAttrMap
+

+ +

BIGINT

BIGINT(data: any, path: string, def?: bigint): bigint

+
+
- Defined in asphyxia-core.d.ts:628
+
+
Parameters
+
- +
  data: any
  +
- +
  path: string
  +
- +
  Optional def: bigint
  +
+
Returns bigint
+

+ +

BIGINTS

BIGINTS(data: any, path: string, def?: bigint[]): bigint[]

+
+
- Defined in asphyxia-core.d.ts:629
+
+
Parameters
+
- +
  data: any
  +
- +
  path: string
  +
- +
  Optional def: bigint[]
  +
+
Returns bigint[]
+

+ +

BOOL

BOOL(data: any, path: string): boolean

+
+
- Defined in asphyxia-core.d.ts:630
+
+
Parameters
+
- +
  data: any
  +
- +
  path: string
  +
+
Returns boolean
+

+ +

BUFFER

BUFFER(data: any, path: string, def?: Buffer): Buffer

+
+
- Defined in asphyxia-core.d.ts:631
+
+
Parameters
+
- +
  data: any
  +
- +
  path: string
  +
- +
  Optional def: Buffer
  +
+
Returns Buffer
+

+ +

CONTENT

CONTENT(data: any, path: string, def?: any): any

+
+
- Defined in asphyxia-core.d.ts:632
+
+
Parameters
+
- +
  data: any
  +
- +
  path: string
  +
- +
  Optional def: any
  +
+
Returns any
+

+ +

ELEMENT

ELEMENT(data: any, path: string, def?: any): any

+
+
- Defined in asphyxia-core.d.ts:633
+
+
Parameters
+
- +
  data: any
  +
- +
  path: string
  +
- +
  Optional def: any
  +
+
Returns any
+

+ +

ELEMENTS

ELEMENTS(data: any, path: string, def?: any): any

+
+
- Defined in asphyxia-core.d.ts:634
+
+
Parameters
+
- +
  data: any
  +
- +
  path: string
  +
- +
  Optional def: any
  +
+
Returns any
+

+ +

NUMBER

NUMBER(data: any, path: string, def?: number): number

+
+
- Defined in asphyxia-core.d.ts:635
+
+
Parameters
+
- +
  data: any
  +
- +
  path: string
  +
- +
  Optional def: number
  +
+
Returns number
+

+ +

NUMBERS

NUMBERS(data: any, path: string, def?: number[]): number[]

+
+
- Defined in asphyxia-core.d.ts:636
+
+
Parameters
+
- +
  data: any
  +
- +
  path: string
  +
- +
  Optional def: number[]
  +
+
Returns number[]
+

+ +

STR

STR(data: any, path: string, def?: string): string

+
+
- Defined in asphyxia-core.d.ts:637
+
+
Parameters
+
- +
  data: any
  +
- +
  path: string
  +
- +
  Optional def: string
  +
+
Returns string
+

+ + +

+ +

Generated using TypeDoc

+ + + + \ No newline at end of file diff --git a/typedoc/modules/db.html b/typedoc/modules/db.html new file mode 100644 index 0000000..bd12636 --- /dev/null +++ b/typedoc/modules/db.html @@ -0,0 +1,482 @@ + + + + + + DB | Asphyxia CORE Module API + + + + + +

+ +

Namespace DB

Database operation.

There are two pools of data for each plugin: PluginSpace and ProfileSpace

If refid is a string, query will match a specific profile data in ProfileSpace.

If refid is null, query will match all profile data in ProfileSpace. + (doesn't apply to DB.FindOne and DB.Insert)

If refid is not provided, query will match data in PluginSpace.

NOTE: since WebUI can delete data in ProfileSpace, + you should refrain from referencing refid in your document to prevent getting unclearable garbage data.

If you need to make rival/friend feature, we recommend you to get all profile data by passing null to refid. + There will be 16 profiles maximum which is small enough to manage.

Index

Functions

+ +

Count

Count(refid: string | null, query: object): Promise<number>
Count(query: object): Promise<number>

+
+
- Defined in asphyxia-core.d.ts:897
+
+
Parameters
+
- +
  refid: string | null
  +
- +
  query: object
  +
+
Returns Promise<number>
+
+
+
- Defined in asphyxia-core.d.ts:898
+
+
Parameters
+
- +
  query: object
  +
+
Returns Promise<number>
+

+ +

Find

Find(refid: string | null, query: object): Promise<any>
Find(query: object): Promise<any>

+
+
- Defined in asphyxia-core.d.ts:854
+
+
Parameters
+
- +
  refid: string | null
  +
- +
  query: object
  +
+
Returns Promise<any>
+
+
+
- Defined in asphyxia-core.d.ts:855
+
+
Parameters
+
- +
  query: object
  +
+
Returns Promise<any>
+

+ +

FindOne

FindOne(refid: string, query: object): Promise<any>
FindOne(query: object): Promise<any>

+
+
- Defined in asphyxia-core.d.ts:851
+
+
Parameters
+
- +
  refid: string
  +
- +
  query: object
  +
+
Returns Promise<any>
+
+
+
- Defined in asphyxia-core.d.ts:852
+
+
Parameters
+
- +
  query: object
  +
+
Returns Promise<any>
+

+ +

Insert

Insert(refid: string, doc: object): Promise<any>
Insert(doc: object): Promise<any>

+
+
- Defined in asphyxia-core.d.ts:857
+
+
Parameters
+
- +
  refid: string
  +
- +
  doc: object
  +
+
Returns Promise<any>
+
+
+
- Defined in asphyxia-core.d.ts:858
+
+
Parameters
+
- +
  doc: object
  +
+
Returns Promise<any>
+

+ +

Remove

Remove(refid: string | null, query: object): Promise<number>
Remove(query: object): Promise<number>

+
+
- Defined in asphyxia-core.d.ts:860
+
+
Parameters
+
- +
  refid: string | null
  +
- +
  query: object
  +
+
Returns Promise<number>
+
+
+
- Defined in asphyxia-core.d.ts:861
+
+
Parameters
+
- +
  query: object
  +
+
Returns Promise<number>
+

+ +

Update

Update(refid: string | null, query: object, update: object): Promise<{ docs: any[]; updated: number }>
Update(query: object, update: object): Promise<{ docs: any[]; updated: number }>

+
+
- Defined in asphyxia-core.d.ts:863
+
+
Parameters
+
- +
  refid: string | null
  +
- +
  query: object
  +
- +
  update: object
  +
+
Returns Promise<{ docs: any[]; updated: number }>
+
+
+
- Defined in asphyxia-core.d.ts:871
+
+
Parameters
+
- +
  query: object
  +
- +
  update: object
  +
+
Returns Promise<{ docs: any[]; updated: number }>
+

+ +

Upsert

Upsert(refid: string | null, query: object, update: object): Promise<{ docs: any[]; updated: number; upsert: boolean }>
Upsert(query: object, update: object): Promise<{ docs: any[]; updated: number; upsert: boolean }>

+
+
- Defined in asphyxia-core.d.ts:879
+
+
Parameters
+
- +
  refid: string | null
  +
- +
  query: object
  +
- +
  update: object
  +
+
Returns Promise<{ docs: any[]; updated: number; upsert: boolean }>
+
+
+
- Defined in asphyxia-core.d.ts:888
+
+
Parameters
+
- +
  query: object
  +
- +
  update: object
  +
+
Returns Promise<{ docs: any[]; updated: number; upsert: boolean }>
+

+ +

Generated using TypeDoc

+ + + + \ No newline at end of file diff --git a/typedoc/modules/io.html b/typedoc/modules/io.html new file mode 100644 index 0000000..ab70827 --- /dev/null +++ b/typedoc/modules/io.html @@ -0,0 +1,427 @@ + + + + + + IO | Asphyxia CORE Module API + + + + + +

+ +

Namespace IO

Filesystem IO

These are designed to match nodejs fs module. Along with custom filesystem implementation for reading compressed data.

DO NOT use IO for savedata. Please use DB namespace so your data can be managed by WebUI.

Also, due to difference between operating systems, you should always prepare your files using ascii path. + Both UTF-8 and local encodings will have cross-platform compatibility issues.

Index

Functions

+ +

ReadDir

ReadDir(path: string): Promise<{ name: string; type: "file" | "dir" | "unsupported" }[]>

+
+
- Defined in asphyxia-core.d.ts:731
+
+
+
+
Asynchronously read a directory.
+
+
+
Parameters
+
- +
  path: string
  +
  +
  A path to a directory.
  +
  +
+
Returns Promise<{ name: string; type: "file" | "dir" | "unsupported" }[]>
+

+ +

ReadFile

ReadFile(path: string, options: { encoding?: null; flag?: string } | undefined | null): Promise<Buffer>
ReadFile(path: string, options: { encoding: string; flag?: string } | string): Promise<string>
ReadFile(path: string, options: { encoding?: string | null; flag?: string } | string | undefined | null): Promise<string | Buffer>
ReadFile(path: string): Promise<Buffer>

+
+
- Defined in asphyxia-core.d.ts:765
+
+
+
+
Asynchronously reads the entire contents of a file.
+
+
+
Parameters
+
- +
  path: string
  +
  +
  A path to a file. + If a file descriptor is provided, the underlying file will not be closed automatically.
  +
  +
- +
  options: { encoding?: null; flag?: string } | undefined | null
  +
  +
  An object that may contain an optional flag. + If a flag is not provided, it defaults to 'r'.
  +
  +
+
Returns Promise<Buffer>
+
+
+
- Defined in asphyxia-core.d.ts:777
+
+
+
+
Asynchronously reads the entire contents of a file.
+
+
+
Parameters
+
- +
  path: string
  +
  +
  A path to a file. + If a file descriptor is provided, the underlying file will not be closed automatically.
  +
  +
- +
  options: { encoding: string; flag?: string } | string
  +
  +
  Either the encoding for the result, or an object that contains the encoding and an optional flag. + If a flag is not provided, it defaults to 'r'.
  +
  +
+
Returns Promise<string>
+
+
+
- Defined in asphyxia-core.d.ts:789
+
+
+
+
Asynchronously reads the entire contents of a file.
+
+
+
Parameters
+
- +
  path: string
  +
  +
  A path to a file. + If a file descriptor is provided, the underlying file will not be closed automatically.
  +
  +
- +
  options: { encoding?: string | null; flag?: string } | string | undefined | null
  +
  +
  Either the encoding for the result, or an object that contains the encoding and an optional flag. + If a flag is not provided, it defaults to 'r'.
  +
  +
+
Returns Promise<string | Buffer>
+
+
+
- Defined in asphyxia-core.d.ts:799
+
+
+
+
Asynchronously reads the entire contents of a file.
+
+
+
Parameters
+
- +
  path: string
  +
  +
  A path to a file. + If a file descriptor is provided, the underlying file will not be closed automatically.
  +
  +
+
Returns Promise<Buffer>
+

+ +

Resolve

Resolve(path: string): string

+
+
- Defined in asphyxia-core.d.ts:725
+
+
+
+
Resolve a relative path starting from your plugin directory to an absolute path.
+
+
+
Parameters
+
- +
  path: string
  +
+
Returns string
+

+ +

WriteFile

WriteFile(path: string, data: any, options: { encoding?: string | null; flag?: string; mode?: number | string } | string | null): Promise<void>
WriteFile(path: string, data: any): Promise<void>

+
+
- Defined in asphyxia-core.d.ts:744
+
+
+
+
Asynchronously writes data to a file, replacing the file if it already exists.
+
+
+
Parameters
+
- +
  path: string
  +
  +
  A path to a file. + If a file descriptor is provided, the underlying file will not be closed automatically.
  +
  +
- +
  data: any
  +
  +
  The data to write. If something other than a Buffer or Uint8Array is provided, the value is coerced to a string.
  +
  +
- +
  options: { encoding?: string | null; flag?: string; mode?: number | string } | string | null
  +
  +
  Either the encoding for the file, or an object optionally specifying the encoding, file mode, and flag. + If encoding is not supplied, the default of 'utf8' is used. + If mode is not supplied, the default of 0o666 is used. + If mode is a string, it is parsed as an octal integer. + If flag is not supplied, the default of 'w' is used.
  +
  +
+
Returns Promise<void>
+
+
+
- Defined in asphyxia-core.d.ts:756
+
+
+
+
Asynchronously writes data to a file, replacing the file if it already exists.
+
+
+
Parameters
+
- +
  path: string
  +
  +
  A path to a file. + If a file descriptor is provided, the underlying file will not be closed automatically.
  +
  +
- +
  data: any
  +
  +
  The data to write. If something other than a Buffer or Uint8Array is provided, the value is coerced to a string.
  +
  +
+
Returns Promise<void>
+

+ +

Generated using TypeDoc

+ + + + \ No newline at end of file diff --git a/typedoc/modules/k.html b/typedoc/modules/k.html new file mode 100644 index 0000000..eae45cb --- /dev/null +++ b/typedoc/modules/k.html @@ -0,0 +1,487 @@ + + + + + + K | Asphyxia CORE Module API + + + + + +

+ +

Namespace K

K stands for Konstruct

Helper for constructing xml-like javascript object.

Index

Functions

ARRAY
ATTR
ITEM

Functions

+ +

ARRAY

ARRAY(type: "u8" | "s8", content: Buffer, attr?: KAttrMap): any
ARRAY(type: KNumberType, content: number[], attr?: KAttrMap): any
ARRAY(type: KBigIntType, content: bigint[], attr?: KAttrMap): any

+
+
- Defined in asphyxia-core.d.ts:706
+
+
+
+
Example:
+
```
{
+  tag: K.ARRAY('s32', [1, 2, 3], {attr: "4"})
+}
```
Represents:
+
```
<tag __type="s32" __count="3" attr="2">1 2 3</tag>
```
+
+
+
Parameters
+
- +
  type: "u8" | "s8"
  +
  +
  __type attribute, which is used during encoding and compression
  +
  +
- +
  content: Buffer
  +
  +
  array of data, __count attribute will be automatically set to content.length
  +
  +
- +
  Optional attr: KAttrMap
  +
  +
  attribute map in addition to __type and __count
  +
  +
+
Returns any
+
+
+
- Defined in asphyxia-core.d.ts:707
+
+
Parameters
+
- +
  type: KNumberType
  +
- +
  content: number[]
  +
- +
  Optional attr: KAttrMap
  +
+
Returns any
+
+
+
- Defined in asphyxia-core.d.ts:708
+
+
Parameters
+
- +
  type: KBigIntType
  +
- +
  content: bigint[]
  +
- +
  Optional attr: KAttrMap
  +
+
Returns any
+

+ +

ATTR

ATTR(attr: KAttrMap, inner?: any): any

+
+
- Defined in asphyxia-core.d.ts:665
+
+
+
+
Example:
+
```
{
+  tag: K.ATTR({attr: "1"}, {
+    inner: [{}, {}]
+  })
+}
```
Represents:
+
```
<tag attr="1">
+  <inner/>
+  <inner/>
+</tag>
```
+
+
+
Parameters
+
- +
  attr: KAttrMap
  +
  +
  Attribute map
  +
  +
- +
  Optional inner: any
  +
  +
  Inner tag/data
  +
  +
+
Returns any
+

+ +

ITEM

ITEM(type: "str", content: string, attr?: KAttrMap): any
ITEM(type: "bin", content: Buffer, attr?: KAttrMap): any
ITEM(type: "ip4", content: string, attr?: KAttrMap): any
ITEM(type: "bool", content: boolean, attr?: KAttrMap): any
ITEM(type: KNumberType, content: number, attr?: KAttrMap): any
ITEM(type: KBigIntType, content: bigint, attr?: KAttrMap): any
ITEM(type: KNumberGroupType, content: number[], attr?: KAttrMap): any
ITEM(type: KBigIntGroupType, content: bigint[], attr?: KAttrMap): any

+
+
- Defined in asphyxia-core.d.ts:682
+
+
+
+
Example:
+
```
{
+  tag: K.ITEM('s32', 1, {attr: "2"})
+}
```
Represents:
+
```
<tag __type="s32" attr="2">1</tag>
```
+
+
+
Parameters
+
- +
  type: "str"
  +
  +
  __type attribute, which is used during encoding and compression
  +
  +
- +
  content: string
  +
  +
  data of specified type
  +
  +
- +
  Optional attr: KAttrMap
  +
  +
  attribute map in addition to __type
  +
  +
+
Returns any
+
+
+
- Defined in asphyxia-core.d.ts:683
+
+
Parameters
+
- +
  type: "bin"
  +
- +
  content: Buffer
  +
- +
  Optional attr: KAttrMap
  +
+
Returns any
+
+
+
- Defined in asphyxia-core.d.ts:684
+
+
Parameters
+
- +
  type: "ip4"
  +
- +
  content: string
  +
- +
  Optional attr: KAttrMap
  +
+
Returns any
+
+
+
- Defined in asphyxia-core.d.ts:685
+
+
Parameters
+
- +
  type: "bool"
  +
- +
  content: boolean
  +
- +
  Optional attr: KAttrMap
  +
+
Returns any
+
+
+
- Defined in asphyxia-core.d.ts:686
+
+
Parameters
+
- +
  type: KNumberType
  +
- +
  content: number
  +
- +
  Optional attr: KAttrMap
  +
+
Returns any
+
+
+
- Defined in asphyxia-core.d.ts:687
+
+
Parameters
+
- +
  type: KBigIntType
  +
- +
  content: bigint
  +
- +
  Optional attr: KAttrMap
  +
+
Returns any
+
+
+
- Defined in asphyxia-core.d.ts:688
+
+
Parameters
+
- +
  type: KNumberGroupType
  +
- +
  content: number[]
  +
- +
  Optional attr: KAttrMap
  +
+
Returns any
+
+
+
- Defined in asphyxia-core.d.ts:689
+
+
Parameters
+
- +
  type: KBigIntGroupType
  +
- +
  content: bigint[]
  +
- +
  Optional attr: KAttrMap
  +
+
Returns any
+

+ +

Generated using TypeDoc

+ + + + \ No newline at end of file diff --git a/typedoc/modules/r.html b/typedoc/modules/r.html new file mode 100644 index 0000000..e84c4d3 --- /dev/null +++ b/typedoc/modules/r.html @@ -0,0 +1,405 @@ + + + + + + R | Asphyxia CORE Module API + + + + + +

+ +

Namespace R

R stands for Register

These functions can only be called in plugins' register() function.

Index

Functions

+ +

Config

Config(key: string, options: CONFIG_OPTIONS): void

+
+
- Defined in asphyxia-core.d.ts:278
+
+
+
+
Register a configuration option.
+
+
+
Parameters
+
- +
  key: string
  +
  +
  config key
  +
  +
- +
  options: CONFIG_OPTIONS
  +
  +
  See CONFIG_OPTIONS
  +
  NOTE: options.validator will only notify user about invalid value. It wouldn't stop user from saving invalid value.
  +
  +
+
Returns void
+

+ +

Contributor

Contributor(name: string, link?: string): void

+
+
- Defined in asphyxia-core.d.ts:268
+
+
+
+
Register a contributor.
+
+
Contributors will show up in WebUI.
+
+
Parameters
+
- +
  name: string
  +
  +
  Contributor's name
  +
  +
- +
  Optional link: string
  +
  +
  Contributor's homepage
  +
  +
+
Returns void
+

+ +

GameCode

GameCode(code: string): void

+
+
- Defined in asphyxia-core.d.ts:258
+
+
+
+
Register a target game code to your plugin for checking savedata.
+
+
You should only call this from your plugin's register() function.
+
+
Parameters
+
- +
  code: string
  +
  +
  Model code of your target machine, + usually three capital letters
  +
  +
+
Returns void
+

+ +

Route

Route(method: string, handler: EamusePluginRoute | boolean): void

+
+
- Defined in asphyxia-core.d.ts:237
+
+
+
+
Register your custom route.
+
+
You should only call this from your plugin's register() function.
+
+
Parameters
+
- +
  method: string
  +
  +
  Method name of your target route, + usually looks like "module.get"
  +
  +
- +
  handler: EamusePluginRoute | boolean
  +
  +
  Your custom route function/method following the type EamusePluginRoute. + A boolean can be passed if you don't need any processing: + - true: Sending empty response with status code 0 + - false: Sending empty response with status code 1
  +
  +
+
Returns void
+

+ +

Unhandled

Unhandled(handler?: EamusePluginRoute): void

+
+
- Defined in asphyxia-core.d.ts:247
+
+
+
+
Register all unhandled routes for a game.
+
+
You should only call this from your plugin's register() function.
+
+
Parameters
+
- +
  Optional handler: EamusePluginRoute
  +
  +
  Your custom route function/method following the type EamusePluginRoute. + If undefined, the router will apply a default handler that prints method names.
  +
  +
+
Returns void
+

+ +

WebUIEvent

WebUIEvent(event: string, callback: (data: any) => void | Promise<void>): void

+
+
- Defined in asphyxia-core.d.ts:287
+
+
+
+
Register a WebUI event callback
+
+
Which can be called in WebUI using emit(event) function or a post message to /emit/<event>
+
Callback can be async function if you want to use await for your DB operations.
+
+
Parameters
+
- +
  event: string
  +
- +
  callback: (data: any) => void | Promise<void>
  +
  - +
    - (data: any): void | Promise<void>
    +
    - +
      Parameters
      +
      - +
        data: any
        +
      +
      Returns void | Promise<void>
      +
    +
  +
+
Returns void
+

+ +

Generated using TypeDoc

+ + + + \ No newline at end of file diff --git a/typedoc/modules/u.html b/typedoc/modules/u.html new file mode 100644 index 0000000..ae71405 --- /dev/null +++ b/typedoc/modules/u.html @@ -0,0 +1,256 @@ + + + + + + U | Asphyxia CORE Module API + + + + + +

+ +

Namespace U

U stands for Utilities

You can find miscellaneous helpers here

Index

Functions

+ +

GetConfig

GetConfig(key: string): any

+
+
- Defined in asphyxia-core.d.ts:827
+
+
+
+
Get config from user configuration file.
+
+
+
Parameters
+
- +
  key: string
  +
  +
  +
+
Returns any
+

+ +

parseXML

parseXML(xml: string, simplify?: boolean): any

+
+
- Defined in asphyxia-core.d.ts:821
+
+
+
+
Convert xml string to javascript object. Output will always be plain javascript string.
+
+
+
Parameters
+
- +
  xml: string
  +
  +
  xml string
  +
  +
- +
  Optional simplify: boolean
  +
  +
  if true, the parser will ignore attributes and only generate string values. (default: true)
  +
  +
+
Returns any
+

+ +

toXML

toXML(data: any): string

+
+
- Defined in asphyxia-core.d.ts:813
+
+
+
+
Convert json data to xml string.
+
+
+
Parameters
+
- +
  data: any
  +
  +
  xml-like javascript object
  +
  +
+
Returns string
+

+ +

Generated using TypeDoc

+ + + + \ No newline at end of file

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

obj: any

Returns KDataReader

Properties

obj

Methods

attr

Parameters

Optional path: string

Returns KAttrMap

bigint

Parameters

path: string

Optional def: bigint

Returns bigint

bigints

Parameters

path: string

Optional def: bigint[]

Returns bigint[]

bool

Parameters

path: string

Returns boolean

buffer

Parameters

path: string

Optional def: Buffer

Returns Buffer

content

Parameters

path: string

Optional def: any

Returns any

element

Parameters

path: string

Returns KDataReader

elements

Parameters

path: string

Returns KDataReader[]

number

Parameters

path: string

Optional def: number

Returns number

numbers

Parameters

path: string

Optional def: number[]

Returns number[]

str

Parameters

path: string

Optional def: string

Returns string

Index

Namespaces

Classes

Interfaces

Type aliases

Type aliases

EPR

EamusePluginRoute

Type declaration

Parameters

req: EamuseInfo

data: any

send: EamuseSend

Returns Promise<any>

KAttrMap

Type declaration