Functions

Last updated: October 02, 2023

ASSERT_WORLD_TABLE

ASSERT_WORLD_TABLE(table, columns?): any

Runs a compile-time check that a given world database table exists.

Important: This function does nothing at runtime.

Motivation: It’s easy to forget building datascripts after a rebuild or reinstallation before you build your scripts. This helps you catch such errors before you try reading it in the worldserver.

Type Codes: Optionally, the second argument can be used to supply a string list of type characters to check that the table has some expected number of columns with specific types. i checks for integer types, s for strings, f for floats and * for any type.

Examples:

ASSERT_WORLD_TABLE("my_table","s") // asserts "my_table" column 1 is a string.

ASSERT_WORLD_TABLE("my_table","*i") // asserts "my_table" column 2 is an integer.

ASSERT_WORLD_TABLE("my_table","si") // asserts "my_table" column 1 is a string and column 2 is an integer.

Parameters

Name Type
table string
columns? string

Returns: any

AppendFile

AppendFile(file, value): any

Parameters

Name Type
file string
value string

Returns: any

AuthDatabaseInfo

AuthDatabaseInfo(): TSDatabaseConnectionInfo

Returns: TSDatabaseConnectionInfo

AuthTable

AuthTable(classTarget): any

Parameters

Name Type
classTarget any

Returns: any

CharacterDatabaseInfo

CharacterDatabaseInfo(): TSDatabaseConnectionInfo

Returns: TSDatabaseConnectionInfo

CharactersTable

CharactersTable(classTarget): any

Parameters

Name Type
classTarget any

Returns: any

CreateArray

CreateArray<T>(obj): TSArray<T>

Type parameters

Name
T

Parameters

Name Type
obj T[]

Returns: TSArray<T>

CreateCustomPacket

CreateCustomPacket(opcode, size): TSPacketWrite

Parameters

Name Type
opcode uint32
size uint32

Returns: TSPacketWrite

CreateDictionary

CreateDictionary<K, V>(obj): TSDictionary<K, V>

Type parameters

Name
K
V

Parameters

Name Type
obj Object

Returns: TSDictionary<K, V>

CreateGUID

CreateGUID(high, counter): TSGUID

Constructs a new GUID object for global entities

Parameters

Name Type
high HighGuid
counter TSNumber<uint32>

Returns: TSGUID

CreateItem

CreateItem(entry, count): TSItem

Parameters

Name Type
entry uint32
count uint32

Returns: TSItem

CreateItemEntry

CreateItemEntry(entry, count): TSItemEntry

Parameters

Name Type
entry uint32
count uint32

Returns: TSItemEntry

CreateItemTemplate

CreateItemTemplate(entry, copyItemID?): TSItemTemplate

Parameters

Name Type Description
entry uint32 The id to be used for the new item template.
copyItemID? uint32 -

Returns: TSItemTemplate

CreateLootItem

CreateLootItem(id, reference?, chance?, lootmode?, needsQuest?, groupId?, minCount?, maxCount?): any

Parameters

Name Type
id uint32
reference? uint32
chance? float
lootmode? uint16
needsQuest? boolean
groupId? uint8
minCount? uint8
maxCount? uint8

Returns: any

CreateMutex

CreateMutex(): TSMutex

Returns: TSMutex

CreateMutexLock

CreateMutexLock(): TSMutex

deprecated use CreateMutex

Returns: TSMutex

CreateOutfit

CreateOutfit(race, gender): TSOutfit

Parameters

Name Type
race Race
gender Gender

Returns: TSOutfit

CreatePosition

CreatePosition(map, x, y, z, o): TSPosition

Parameters

Name Type
map uint32
x float
y float
z float
o float

Returns: TSPosition

CreateTSMutable

CreateTSMutable<T>(ptr): TSMutable<T, T>

Type parameters

Name
T

Parameters

Name Type
ptr T

Returns: TSMutable<T, T>

DBField

DBField(fieldTarget, name): any

Parameters

Name Type
fieldTarget any
name any

Returns: any

DBFieldVarChar

DBFieldVarChar(chars): (target: any, name: any) => void

Parameters

Name Type
chars number

Returns: fn

▸ (target, name): void

Parameters
Name Type
target any
name any

#Returns: void

DBPrimaryKey

DBPrimaryKey(pkTarget, name): any

Parameters

Name Type
pkTarget any
name any

Returns: any

DBPrimaryKeyVarChar

DBPrimaryKeyVarChar(chars): (target: any, name: any) => void

Parameters

Name Type
chars number

Returns: fn

▸ (target, name): void

Parameters
Name Type
target any
name any

#Returns: void

DeleteDBArrayEntry

DeleteDBArrayEntry<T>(con, sql): void

Type parameters

Name Type
T extends DBArrayEntry<T>

Parameters

Name Type
con (…args: any[]) => T
sql string

Returns: void

DeleteDBEntry

DeleteDBEntry<T>(con, sql): void

Type parameters

Name Type
T extends DBEntry<T>

Parameters

Name Type
con (…args: any[]) => T
sql string

Returns: void

EmptyGUID

EmptyGUID(): TSGUID

Creates an empty invalid guid

Returns: TSGUID

FileExists

FileExists(file): boolean

Parameters

Name Type
file string

Returns: boolean

GetActiveGameEvents

GetActiveGameEvents(): TSArray<uint16>

Returns: TSArray<uint16>

GetAuthDBConnection

GetAuthDBConnection(): TSAuthDatabaseConnection

Returns: TSAuthDatabaseConnection

GetCharactersDBConnection

GetCharactersDBConnection(): TSCharactersDatabaseConnection

Returns: TSCharactersDatabaseConnection

GetCreatureTemplate

GetCreatureTemplate(entry): TSCreatureTemplate

Parameters

Name Type
entry uint32

Returns: TSCreatureTemplate

GetCurrTime

GetCurrTime(): TSNumber<uint32>

Returns: TSNumber<uint32>

GetFactionTemplate

GetFactionTemplate(entry): TSFactionTemplate

Parameters

Name Type
entry uint32

Returns: TSFactionTemplate

GetGameObjectTemplate

GetGameObjectTemplate(entry): TSGameObjectTemplate

Parameters

Name Type
entry uint32

Returns: TSGameObjectTemplate

GetGuild

GetGuild(guid): TSGuild

Parameters

Name Type
guid uint32

Returns: TSGuild

GetGuildByLeader

GetGuildByLeader(guid): TSGuild

Parameters

Name Type
guid uint64

Returns: TSGuild

GetGuildByName

GetGuildByName(name): TSGuild

Parameters

Name Type
name string

Returns: TSGuild

GetID

GetID(table, mod, name): TSNumber<uint32>

Parameters

Name Type
table string
mod string
name string

Returns: TSNumber<uint32>

GetIDTag

GetIDTag(mod, id): TSArray<uint32>

deprecated use TAG macro

Parameters

Name Type
mod string
id string

Returns: TSArray<uint32>

GetIDTagUnique

GetIDTagUnique(mod, id): TSNumber<uint32>

deprecated use UTAG

Parameters

Name Type
mod string
id string

Returns: TSNumber<uint32>

GetItemTemplate

GetItemTemplate(entry): TSItemTemplate

Parameters

Name Type
entry uint32

Returns: TSItemTemplate

GetSpellInfo

GetSpellInfo(entry): TSSpellInfo

Parameters

Name Type
entry uint32

Returns: TSSpellInfo

GetTalentSpellCost

GetTalentSpellCost(entry): TSNumber<uint32>

Parameters

Name Type
entry uint32

Returns: TSNumber<uint32>

GetUnixTime

GetUnixTime(): TSNumber<uint64>

Returns: TSNumber<uint64>

GetWorldDBConnection

GetWorldDBConnection(): TSWorldDatabaseConnection

Returns: TSWorldDatabaseConnection

HAS_TAG

HAS_TAG(item, mod, id): bool

Parameters

Name Type
item uint32
mod string
id string

Returns: bool

IsGameEventActive

IsGameEventActive(event): boolean

Parameters

Name Type
event uint16

Returns: boolean

IsHolidayActive

IsHolidayActive(holiday): boolean

Parameters

Name Type
holiday uint16

Returns: boolean

LoadDBArrayEntry

LoadDBArrayEntry<T>(cons, ...pks): DBContainer<T>

Type parameters

Name Type
T extends DBArrayEntry<T>

Parameters

Name Type
cons (…args: any[]) => T
...pks any[]

Returns: DBContainer<T>

LoadDBEntry

LoadDBEntry<T>(value): T

Type parameters

Name Type
T extends DBEntry<T>

Parameters

Name Type
value T

Returns: T

MakeDBDict

MakeDBDict<K, V>(): TSDBDict<K, V>

Type parameters

Name
K
V

Returns: TSDBDict<K, V>

Message

Message(classTarget): any

Parameters

Name Type
classTarget any

Returns: any

ModID

ModID(): TSNumber<uint32>

Returns: TSNumber<uint32>

MsgClass

MsgClass(classTarget, name): any

Parameters

Name Type
classTarget any
name string

Returns: any

MsgClassArray

MsgClassArray(size): (field: any, name: any) => void

Parameters

Name Type
size number

Returns: fn

▸ (field, name): void

Parameters
Name Type
field any
name any

#Returns: void

MsgPrimitive

MsgPrimitive(classTarget, name): any

Parameters

Name Type
classTarget any
name string

Returns: any

MsgPrimitiveArray

MsgPrimitiveArray(capacity): (field: any, name: any) => void

Parameters

Name Type
capacity number

Returns: fn

▸ (field, name): void

Parameters
Name Type
field any
name any

#Returns: void

MsgString

MsgString(size): (field: any, name: any) => void

Parameters

Name Type
size number

Returns: fn

▸ (field, name): void

Parameters
Name Type
field any
name any

#Returns: void

MsgStringArray

MsgStringArray(arrSize, stringSize): (field: any, name: any) => void

Parameters

Name Type
arrSize number
stringSize number

Returns: fn

▸ (field, name): void

Parameters
Name Type
field any
name any

#Returns: void

NULL_GAMEOBJECT

NULL_GAMEOBJECT(): TSGameObject

Returns: TSGameObject

NULL_MAP

NULL_MAP(): TSMap

Returns: TSMap

NULL_PLAYER

NULL_PLAYER(): TSPlayer

Returns: TSPlayer

NULL_SPELLINFO

NULL_SPELLINFO(): TSSpellInfo

Returns: TSSpellInfo

NULL_UNIT

NULL_UNIT(): TSUnit

Returns: TSUnit

PrepareAuthQuery

PrepareAuthQuery(query): TSPreparedStatementAuth

Parameters

Name Type
query string

Returns: TSPreparedStatementAuth

PrepareCharactersQuery

PrepareCharactersQuery(query): TSPreparedStatementCharacters

Parameters

Name Type
query string

Returns: TSPreparedStatementCharacters

PrepareWorldQuery

PrepareWorldQuery(query): TSPreparedStatementWorld

Parameters

Name Type
query string

Returns: TSPreparedStatementWorld

QueryAuth

QueryAuth(query): TSDatabaseResult

Parameters

Name Type
query string

Returns: TSDatabaseResult

QueryAuthAsync

QueryAuthAsync(query): void

Parameters

Name Type
query string

Returns: void

QueryCharacters

QueryCharacters(query): TSDatabaseResult

Parameters

Name Type
query string

Returns: TSDatabaseResult

QueryCharactersAsync

QueryCharactersAsync(query): void

Parameters

Name Type
query string

Returns: void

QueryDBEntry

QueryDBEntry<T>(con, sql): TSArray<T>

Type parameters

Name Type
T extends DBEntry<T>

Parameters

Name Type
con (…args: any[]) => T
sql string

Returns: TSArray<T>

QueryWorld

QueryWorld(query): TSDatabaseResult

Parameters

Name Type
query string

Returns: TSDatabaseResult

QueryWorldAsync

QueryWorldAsync(query): void

Parameters

Name Type
query string

Returns: void

ReadDirectory

ReadDirectory(directory): string[]

Parameters

Name Type
directory string

Returns: string[]

ReadFile

ReadFile(file, def?): string

Parameters

Name Type
file string
def? string

Returns: string

SendWorldMessage

SendWorldMessage(message): any

Parameters

Name Type
message string

Returns: any

StartGameEvent

StartGameEvent(event_id): void

Parameters

Name Type
event_id uint16

Returns: void

StopGameEvent

StopGameEvent(event_id): void

Parameters

Name Type
event_id uint16

Returns: void

SyncHttpGet

SyncHttpGet(url): string

Parameters

Name Type
url string

Returns: string

TAG

TAG(mod, id): TSArray<uint32>

Parameters

Name Type
mod string
id string

Returns: TSArray<uint32>

TS_ZONE_CATEGORY

TS_ZONE_CATEGORY(color): ZoneCategory

Parameters

Name Type
color uint32

Returns: ZoneCategory

TS_ZONE_SCOPED

TS_ZONE_SCOPED(cat): void

Parameters

Name Type
cat uint32

Returns: void

TS_ZONE_SCOPED_N

TS_ZONE_SCOPED_N(cat): void

Parameters

Name Type
cat uint32

Returns: void

ToDouble

ToDouble(val): TSNumber<double>

Parameters

Name Type
val string

Returns: TSNumber<double>

ToFloat

ToFloat(val): TSNumber<float>

Parameters

Name Type
val string

Returns: TSNumber<float>

ToInt16

ToInt16(val): TSNumber<int16>

Parameters

Name Type
val string

Returns: TSNumber<int16>

ToInt32

ToInt32(val): TSNumber<int32>

Parameters

Name Type
val string

Returns: TSNumber<int32>

ToInt64

ToInt64(val): TSNumber<int64>

Parameters

Name Type
val string

Returns: TSNumber<int64>

ToInt8

ToInt8(val): TSNumber<int8>

Parameters

Name Type
val string

Returns: TSNumber<int8>

ToStr

ToStr(val): any

Parameters

Name Type
val number

Returns: any

ToUInt16

ToUInt16(val): TSNumber<int16>

Parameters

Name Type
val string

Returns: TSNumber<int16>

ToUInt32

ToUInt32(val): TSNumber<uint32>

Parameters

Name Type
val string

Returns: TSNumber<uint32>

ToUInt64

ToUInt64(val): TSNumber<uint64>

Parameters

Name Type
val string

Returns: TSNumber<uint64>

ToUInt8

ToUInt8(val): TSNumber<uint8>

Parameters

Name Type
val string

Returns: TSNumber<uint8>

UTAG

UTAG(mod, id): TSNumber<uint32>

Parameters

Name Type
mod string
id string

Returns: TSNumber<uint32>

WorldDatabaseInfo

WorldDatabaseInfo(): TSDatabaseConnectionInfo

Returns: TSDatabaseConnectionInfo

WorldTable

WorldTable(classTarget): any

Parameters

Name Type
classTarget any

Returns: any

WriteFile

WriteFile(file, value): any

Parameters

Name Type
file string
value any

Returns: any