canary/docs/lua-api/lua_api.json
Eduardo Dantas b0092a9b87
feat(pvp): add Expert PvP world type and combat rules (#4033)
Add Expert PvP world type and combat rules

This commit adds Expert Open PvP support to Canary as an explicit world type through worldType = expert-pvp.

The implementation introduces a dedicated ExpertPvp component for Expert specific combat, relation, field, movement, collision, and marking rules. Existing combat, spell, tile, player, game, and protocol code remain as thin integration points, while the Expert PvP decisions live under src creatures players components pvp.

This keeps the new behavior isolated from the existing world types and avoids spreading Expert PvP specific rules across unrelated systems.

The existing PvP world type handling was also clarified. retro-pvp is now the explicit Retro Open PvP value, while pvp remains supported as a compatibility alias for retro-pvp. no-pvp and pvp-enforced remain outside the Expert PvP decision path.

Main world type changes

• Adds worldType expert-pvp

• Makes retro-pvp the explicit Retro Open PvP config value

• Keeps pvp as a compatibility alias for retro-pvp

• Changes the default config value from pvp to retro-pvp

• Removes the old toggleServerIsRetroPVP config option

• Updates Lua helpers so IsRetroPVP reads the world type string

• Adds IsExpertPVP for Lua scripts

• Keeps no-pvp and pvp-enforced behavior outside the Expert PvP component

The ExpertPvp component centralizes relation classification and decision making for the new world type. It evaluates PvP mode, actor and target relation, combat action type, field ownership, side effects, player collision, and viewer specific situation marks.

The component covers relations such as self, access players, party allies, guild allies, war enemies, direct attackers, protected ally attackers, direct targets, skulled targets, neutral players, monsters, player summons, and NPCs.

Main Expert PvP rules included

• Dove mode behavior

• White Hand behavior

• Yellow Hand behavior

• Red Fist behavior

• Direct combat decisions

• Rune target decisions

• Area spell decisions

• Summon combat decisions

• Field step decisions

• Field damage decisions

• Player walkthrough decisions

• Pathfinding probe decisions

• Viewer specific field visual decisions

• Viewer relative creature situation marks

Combat integration now asks ExpertPvp before allowing Expert PvP relevant actions. This applies to direct attacks, runes, aggressive area spells, mana and health combat, conditions, dispels, default combat actions, and field damage.

When Expert PvP handles an action, it can allow or block the action and apply the correct side effects. These side effects include fight state, PZ lock behavior, skull actions, square feedback, and unjustified kill tracking where applicable.

Secure mode behavior is handled through the Expert PvP relation rules instead of the older broad secure mode check. This allows secure mode retaliation without applying unjustified protection zone locks in cases where the Expert PvP relation allows the response.

Magic Wall and Wild Growth now carry Expert PvP cast time context. When Expert PvP is enabled, these fields are created as safe field variants and receive owner context so the server can evaluate relation dependent behavior later.

Magic Wall and Wild Growth changes

• Stores the field owner context when the rune is cast

• Stores the owner PvP mode at cast time

• Tracks owner targets and attackers at cast time

• Uses safe visual field items as the base item in Expert PvP

• Resolves viewer specific appearance through protocol serialization

• Evaluates collision and pathfinding from the field context

• Evaluates field stepping side effects through ExpertPvp

• Prevents Expert PvP owned safe fields from being removed like regular no-pvp safe fields

• Keeps normal no-pvp behavior for non Expert PvP worlds

Tile and pathfinding logic now consult ExpertPvp for Expert owned fields. This allows Magic Wall and Wild Growth to appear or behave differently depending on the viewer and the PvP relation, while still using the existing movement and tile query paths as the final authority.

Player walkthrough and body blocking were updated so Expert PvP can decide whether a player can walk through another player outside legacy safe zones. Party, guild, war, attacker, protected ally, and target relations are used to keep collision behavior aligned with Expert PvP hand modes.

PvP situation tracking was added so player relations can affect persistent creature marks. The server can now send viewer relative creature marks for the current client profile and refresh visible marks when relevant state changes.

Situation mark updates happen when needed for events such as party changes, guild changes, attacked player tracking, player removal, and visible relation changes.

Protocol changes

• Adds ExpertPvpModeByte as a protocol feature flag

• Enables Expert PvP mode byte support for the Tibia 11.00 profile

• Keeps Tibia 11.00 on the verified four byte Set Tactics layout

• Keeps current 15.25 on its verified three byte tactics layout

• Defaults unsupported profiles safely to Dove mode

• Avoids appending speculative PvP mode bytes to the current 15.25 profile

• Sends Expert PvP controls only when the protocol profile supports them

• Sends viewer relative creature marks only through supported packet layouts

The current 15.25 profile keeps its verified tactics payload layout and does not receive a speculative extra PvP byte. This prevents client desync or crash risk. Unsupported profiles are forced safely to Dove when Expert PvP is enabled but the protocol cannot represent the mode.

Player state now includes a dedicated PvP component. The selected Expert PvP mode is stored on the player and persisted to the database.

Persistence and database changes

• Adds PlayerPvp component

• Adds player getPvpMode and setPvpMode support

• Saves expert_pvp_mode during player save

• Loads expert_pvp_mode during player load

• Adds players.expert_pvp_mode to schema.sql

• Bumps database version to 59

• Adds migration 59 for the players.expert_pvp_mode column

• Skips the migration safely if the column already exists

Lua API support was expanded so scripts can inspect PvP state and attach field context where needed.

Lua API changes

• Adds Player getPvpMode

• Adds Player hasAttacked

• Adds Item setExpertPvpFieldContext

• Updates generated Lua API documentation

• Updates Magic Wall and Wild Growth scripts to attach Expert PvP field context

The PR also updates blessing and death loss behavior to use the new Retro PvP world type detection instead of the removed toggleServerIsRetroPVP config. This keeps existing Retro PvP behavior while moving the decision to the explicit world type model.

Additional behavior covered

• Party relation handling

• Guild relation handling

• War enemy relation handling

• Skull relation handling

• Aggressor relation handling

• Protected ally relation handling

• Field ownership behavior

• Viewer specific field visuals

• Body blocking and player collision

• Situation marks and persistent creature marks

• Defensive PZ lock behavior

• Secure mode retaliation behavior

• Blessing cost and Twist of Fate behavior under Retro PvP detection

Out of scope

• Frag sharing

• player_kills.weight schema changes

• Debug commands

• Unrelated PvP features

• Broad behavior changes to existing world types

Documentation and tests

• Adds Expert PvP implementation roadmap documentation

• Adds Expert PvP porting plan documentation

• Links the new documentation from the systems overview

• Documents the behavioral contract

• Documents the implementation roadmap

• Documents the in game regression matrix

• Adds Expert PvP unit coverage

• Adds protocol profile coverage for Expert PvP mode support

• Adds regression scenarios for all world types

Validation performed

• Built canary target

• Built canary_ut target

• Built canary_it target

• Expert PvP and protocol profile tests passed with 49 of 49 tests

• Full unit binary passed with 311 of 311 tests

• Integration binary passed with 40 of 40 tests

• Manual scenarios were exercised during implementation

• Tested secure mode retaliation

• Tested defensive PZ lock behavior

• Tested Magic Wall and Wild Growth cast time relations

• Tested viewer specific visuals and collision

• Tested situation marks

Test configuration

• Platform Windows x64

• Compiler Microsoft Visual C plus plus 19.44

• Protocol coverage Tibia 11.00 and current 15.25 profiles

Known validation note

Two isolated CTest invocations terminated during global teardown after their test bodies passed. The same behavior reproduces on the main baseline. Running the unit suite in one process passes all 311 tests.

Overall this commit adds Expert Open PvP as a gated world type with dedicated relation based combat and field rules. It keeps existing world types protected from Expert PvP behavior, persists the selected PvP mode, supports protocol safe PvP mode handling, updates Lua APIs and documentation, and adds regression coverage for the new rules.
2026-08-10 18:42:55 -03:00

9569 lines
257 KiB
JSON

{
"typeAliases": {
"CombatType": "integer",
"DistanceEffect": "integer",
"MagicEffect": "integer",
"ReturnValue": "integer",
"SoundEffect": "integer",
"TileState": "integer"
},
"classes": {
"Action": [
{
"name": "aid",
"params": [
"aids: number"
],
"return": "boolean",
"source": "src/lua/functions/events/action_functions.cpp"
},
{
"name": "allowFarUse",
"params": [
"value: boolean"
],
"return": "boolean",
"source": "src/lua/functions/events/action_functions.cpp"
},
{
"name": "blockWalls",
"params": [
"value: boolean"
],
"return": "boolean",
"source": "src/lua/functions/events/action_functions.cpp"
},
{
"name": "checkFloor",
"params": [
"value: boolean"
],
"return": "boolean",
"source": "src/lua/functions/events/action_functions.cpp"
},
{
"name": "id",
"params": [
"ids: number"
],
"return": "boolean",
"source": "src/lua/functions/events/action_functions.cpp"
},
{
"name": "onUse",
"params": [
"callback: fun(player: Player, item: Item, fromPosition: Position, target: Creature|Item, toPosition: Position, isHotkey: boolean): boolean"
],
"return": "boolean",
"source": "src/lua/functions/events/action_functions.cpp"
},
{
"name": "position",
"params": [
"positions: Position",
"itemIdOrName: number|string"
],
"return": "boolean",
"source": "src/lua/functions/events/action_functions.cpp"
},
{
"name": "register",
"params": [],
"return": "boolean",
"source": "src/lua/functions/events/action_functions.cpp"
},
{
"name": "uid",
"params": [
"uids: number"
],
"return": "boolean",
"source": "src/lua/functions/events/action_functions.cpp"
}
],
"Bank": [
{
"name": "balance",
"params": [
"playerOrGuild: any",
"amount?: number"
],
"return": "boolean|number",
"source": "src/lua/functions/core/game/bank_functions.cpp"
},
{
"name": "credit",
"params": [
"playerOrGuild: any",
"amount: number"
],
"return": "boolean",
"source": "src/lua/functions/core/game/bank_functions.cpp"
},
{
"name": "debit",
"params": [
"playerOrGuild: any",
"amount: number"
],
"return": "boolean",
"source": "src/lua/functions/core/game/bank_functions.cpp"
},
{
"name": "deposit",
"params": [
"player: Player",
"amount: number",
"destination?: any"
],
"return": "boolean",
"source": "src/lua/functions/core/game/bank_functions.cpp"
},
{
"name": "hasBalance",
"params": [
"playerOrGuild: any",
"amount: number"
],
"return": "boolean",
"source": "src/lua/functions/core/game/bank_functions.cpp"
},
{
"name": "transfer",
"params": [
"fromPlayerOrGuild: any",
"toPlayerOrGuild: any",
"amount: number"
],
"return": "boolean",
"source": "src/lua/functions/core/game/bank_functions.cpp"
},
{
"name": "transferToGuild",
"params": [
"fromPlayerOrGuild: any",
"toGuild: any",
"amount: number"
],
"return": "boolean",
"source": "src/lua/functions/core/game/bank_functions.cpp"
},
{
"name": "withdraw",
"params": [
"player: Player",
"amount: number",
"source?: any"
],
"return": "boolean",
"source": "src/lua/functions/core/game/bank_functions.cpp"
}
],
"BatchUpdate": [
{
"name": "add",
"params": [
"container: Container"
],
"return": "boolean",
"source": "src/lua/functions/core/game/batch_update_functions.cpp"
},
{
"name": "delete",
"params": [],
"return": "nil",
"source": "src/lua/functions/core/game/batch_update_functions.cpp"
}
],
"Charm": [
{
"name": "castSound",
"params": [
"arg2?: any"
],
"return": "boolean|number",
"source": "src/lua/functions/creatures/monster/charm_functions.cpp"
},
{
"name": "category",
"params": [
"arg2?: any"
],
"return": "boolean|number",
"source": "src/lua/functions/creatures/monster/charm_functions.cpp"
},
{
"name": "chance",
"params": [
"arg2?: table"
],
"return": "boolean|table",
"source": "src/lua/functions/creatures/monster/charm_functions.cpp"
},
{
"name": "damageType",
"params": [
"arg2?: any"
],
"return": "boolean|number",
"source": "src/lua/functions/creatures/monster/charm_functions.cpp"
},
{
"name": "description",
"params": [
"arg2?: string"
],
"return": "boolean|string",
"source": "src/lua/functions/creatures/monster/charm_functions.cpp"
},
{
"name": "effect",
"params": [
"arg2?: number"
],
"return": "boolean|number",
"source": "src/lua/functions/creatures/monster/charm_functions.cpp"
},
{
"name": "impactSound",
"params": [
"arg2?: any"
],
"return": "boolean|number",
"source": "src/lua/functions/creatures/monster/charm_functions.cpp"
},
{
"name": "messageCancel",
"params": [
"arg2?: string"
],
"return": "boolean|string",
"source": "src/lua/functions/creatures/monster/charm_functions.cpp"
},
{
"name": "messageServerLog",
"params": [
"arg2?: boolean"
],
"return": "boolean",
"source": "src/lua/functions/creatures/monster/charm_functions.cpp"
},
{
"name": "name",
"params": [
"arg2?: string"
],
"return": "boolean|string",
"source": "src/lua/functions/creatures/monster/charm_functions.cpp"
},
{
"name": "percentage",
"params": [
"arg2?: number"
],
"return": "boolean|number",
"source": "src/lua/functions/creatures/monster/charm_functions.cpp"
},
{
"name": "points",
"params": [
"arg2?: table"
],
"return": "boolean|table",
"source": "src/lua/functions/creatures/monster/charm_functions.cpp"
},
{
"name": "type",
"params": [
"arg2?: any"
],
"return": "boolean|number",
"source": "src/lua/functions/creatures/monster/charm_functions.cpp"
}
],
"Combat": [
{
"name": "addCondition",
"params": [
"condition: Condition"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/combat/combat_functions.cpp"
},
{
"name": "execute",
"params": [
"creature: Creature",
"variant: Variant"
],
"return": "boolean",
"source": "src/lua/functions/creatures/combat/combat_functions.cpp"
},
{
"name": "setArea",
"params": [
"area: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/combat/combat_functions.cpp"
},
{
"name": "setCallback",
"params": [
"key: any",
"callback: string"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/combat/combat_functions.cpp"
},
{
"name": "setFormula",
"params": [
"type: any",
"mina: number",
"minb: number",
"maxa: number",
"maxb: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/combat/combat_functions.cpp"
},
{
"name": "setOrigin",
"params": [
"origin: any"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/combat/combat_functions.cpp"
},
{
"name": "setParameter",
"params": [
"key: any",
"value: boolean|number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/combat/combat_functions.cpp"
}
],
"Condition": [
{
"name": "addDamage",
"params": [
"rounds: number",
"time: number",
"value: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/combat/condition_functions.cpp"
},
{
"name": "clone",
"params": [],
"return": "nil|Condition",
"source": "src/lua/functions/creatures/combat/condition_functions.cpp"
},
{
"name": "delete",
"params": [],
"return": "nil",
"source": "src/lua/functions/creatures/combat/condition_functions.cpp"
},
{
"name": "getEndTime",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/creatures/combat/condition_functions.cpp"
},
{
"name": "getIcons",
"params": [],
"return": "table|nil",
"source": "src/lua/functions/creatures/combat/condition_functions.cpp"
},
{
"name": "getId",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/creatures/combat/condition_functions.cpp"
},
{
"name": "getSubId",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/creatures/combat/condition_functions.cpp"
},
{
"name": "getTicks",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/creatures/combat/condition_functions.cpp"
},
{
"name": "getType",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/creatures/combat/condition_functions.cpp"
},
{
"name": "setFormula",
"params": [
"mina: number",
"minb: number",
"maxa: number",
"maxb: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/combat/condition_functions.cpp"
},
{
"name": "setOutfit",
"params": [
"outfit: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/combat/condition_functions.cpp"
},
{
"name": "setParameter",
"params": [
"key: any",
"value: boolean|number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/combat/condition_functions.cpp"
},
{
"name": "setTicks",
"params": [
"ticks: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/combat/condition_functions.cpp"
}
],
"Container": [
{
"name": "addItem",
"params": [
"itemId: number|string",
"countOrSubType?: number",
"index?: number",
"flags?: number"
],
"return": "boolean|nil|Item",
"source": "src/lua/functions/items/container_functions.cpp"
},
{
"name": "addItemEx",
"params": [
"item: Item",
"index?: number",
"flags?: number"
],
"return": "number|nil",
"source": "src/lua/functions/items/container_functions.cpp"
},
{
"name": "getCapacity",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/items/container_functions.cpp"
},
{
"name": "getContentDescription",
"params": [
"oldProtocol?: boolean"
],
"return": "string|nil",
"source": "src/lua/functions/items/container_functions.cpp"
},
{
"name": "getCorpseOwner",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/items/container_functions.cpp"
},
{
"name": "getEmptySlots",
"params": [
"recursive?: boolean"
],
"return": "number|nil",
"source": "src/lua/functions/items/container_functions.cpp"
},
{
"name": "getItem",
"params": [
"index: number"
],
"return": "nil|Item",
"source": "src/lua/functions/items/container_functions.cpp"
},
{
"name": "getItemCountById",
"params": [
"itemId: number|string",
"subType?: number"
],
"return": "number|nil",
"source": "src/lua/functions/items/container_functions.cpp"
},
{
"name": "getItemHoldingCount",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/items/container_functions.cpp"
},
{
"name": "getItems",
"params": [
"recursive?: boolean"
],
"return": "table|nil",
"source": "src/lua/functions/items/container_functions.cpp"
},
{
"name": "getMaxCapacity",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/items/container_functions.cpp"
},
{
"name": "getSize",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/items/container_functions.cpp"
},
{
"name": "hasItem",
"params": [
"item: Item"
],
"return": "boolean|nil",
"source": "src/lua/functions/items/container_functions.cpp"
},
{
"name": "registerReward",
"params": [],
"return": "boolean|nil",
"source": "src/lua/functions/items/container_functions.cpp"
},
{
"name": "removeAllItems",
"params": [
"actor: Player",
"recursive: boolean"
],
"return": "number|nil",
"source": "src/lua/functions/items/container_functions.cpp"
},
{
"name": "removeItemById",
"params": [
"itemId: number|string",
"count: number",
"subType?: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/items/container_functions.cpp"
}
],
"Creature": [
{
"name": "addCondition",
"params": [
"condition: Condition"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/creature_functions.cpp"
},
{
"name": "addHealth",
"params": [
"healthChange: number",
"combatType: any"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/creature_functions.cpp"
},
{
"name": "attachEffectById",
"params": [
"effectId: number",
"temporary?: boolean"
],
"return": "nil",
"source": "src/lua/functions/creatures/creature_functions.cpp"
},
{
"name": "canSee",
"params": [
"position: Position"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/creature_functions.cpp"
},
{
"name": "canSeeCreature",
"params": [
"creature: Creature"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/creature_functions.cpp"
},
{
"name": "changeSpeed",
"params": [
"delta: number"
],
"return": "boolean",
"source": "src/lua/functions/creatures/creature_functions.cpp"
},
{
"name": "clearIcons",
"params": [],
"return": "boolean",
"source": "src/lua/functions/creatures/creature_functions.cpp"
},
{
"name": "detachEffectById",
"params": [
"effectId: number"
],
"return": "nil",
"source": "src/lua/functions/creatures/creature_functions.cpp"
},
{
"name": "getAttachedEffects",
"params": [],
"return": "table",
"source": "src/lua/functions/creatures/creature_functions.cpp"
},
{
"name": "getBaseSpeed",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/creatures/creature_functions.cpp"
},
{
"name": "getCondition",
"params": [
"conditionType: any",
"conditionId?: any",
"subId?: number"
],
"return": "nil|Condition",
"source": "src/lua/functions/creatures/creature_functions.cpp"
},
{
"name": "getDamageMap",
"params": [],
"return": "table|nil",
"source": "src/lua/functions/creatures/creature_functions.cpp"
},
{
"name": "getDescription",
"params": [
"distance: number"
],
"return": "string|nil",
"source": "src/lua/functions/creatures/creature_functions.cpp"
},
{
"name": "getDirection",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/creatures/creature_functions.cpp"
},
{
"name": "getEvents",
"params": [
"type: any"
],
"return": "table|nil",
"source": "src/lua/functions/creatures/creature_functions.cpp"
},
{
"name": "getFollowCreature",
"params": [],
"return": "nil|Creature",
"source": "src/lua/functions/creatures/creature_functions.cpp"
},
{
"name": "getHealth",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/creatures/creature_functions.cpp"
},
{
"name": "getIcon",
"params": [
"key: string"
],
"return": "boolean|table|nil",
"source": "src/lua/functions/creatures/creature_functions.cpp"
},
{
"name": "getIcons",
"params": [],
"return": "boolean|table",
"source": "src/lua/functions/creatures/creature_functions.cpp"
},
{
"name": "getId",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/creatures/creature_functions.cpp"
},
{
"name": "getLight",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/creatures/creature_functions.cpp"
},
{
"name": "getMaster",
"params": [],
"return": "nil|Creature",
"source": "src/lua/functions/creatures/creature_functions.cpp"
},
{
"name": "getMaxHealth",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/creatures/creature_functions.cpp"
},
{
"name": "getName",
"params": [],
"return": "string|nil",
"source": "src/lua/functions/creatures/creature_functions.cpp"
},
{
"name": "getOutfit",
"params": [],
"return": "nil",
"source": "src/lua/functions/creatures/creature_functions.cpp"
},
{
"name": "getParent",
"params": [],
"return": "nil",
"source": "src/lua/functions/creatures/creature_functions.cpp"
},
{
"name": "getPathTo",
"params": [
"pos: Position",
"minTargetDist?: number",
"maxTargetDist?: number",
"fullPathSearch?: boolean",
"clearSight?: boolean",
"maxSearchDist?: number"
],
"return": "boolean|table|nil",
"source": "src/lua/functions/creatures/creature_functions.cpp"
},
{
"name": "getPosition",
"params": [],
"return": "nil|Position",
"source": "src/lua/functions/creatures/creature_functions.cpp"
},
{
"name": "getShader",
"params": [],
"return": "string",
"source": "src/lua/functions/creatures/creature_functions.cpp"
},
{
"name": "getSkull",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/creatures/creature_functions.cpp"
},
{
"name": "getSpeed",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/creatures/creature_functions.cpp"
},
{
"name": "getSummons",
"params": [],
"return": "table|nil",
"source": "src/lua/functions/creatures/creature_functions.cpp"
},
{
"name": "getTarget",
"params": [],
"return": "nil|Creature",
"source": "src/lua/functions/creatures/creature_functions.cpp"
},
{
"name": "getTile",
"params": [],
"return": "nil|Tile",
"source": "src/lua/functions/creatures/creature_functions.cpp"
},
{
"name": "getTypeName",
"params": [],
"return": "string|nil",
"source": "src/lua/functions/creatures/creature_functions.cpp"
},
{
"name": "getZoneType",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/creatures/creature_functions.cpp"
},
{
"name": "getZones",
"params": [],
"return": "table|nil",
"source": "src/lua/functions/creatures/creature_functions.cpp"
},
{
"name": "hasBeenSummoned",
"params": [],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/creature_functions.cpp"
},
{
"name": "hasCondition",
"params": [
"conditionType: any",
"subId?: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/creature_functions.cpp"
},
{
"name": "isCreature",
"params": [],
"return": "boolean",
"source": "src/lua/functions/creatures/creature_functions.cpp"
},
{
"name": "isDirectionLocked",
"params": [],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/creature_functions.cpp"
},
{
"name": "isHealthHidden",
"params": [],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/creature_functions.cpp"
},
{
"name": "isImmune",
"params": [
"conditionOrConditionType: Condition"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/creature_functions.cpp"
},
{
"name": "isInGhostMode",
"params": [],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/creature_functions.cpp"
},
{
"name": "isMoveLocked",
"params": [],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/creature_functions.cpp"
},
{
"name": "isRemoved",
"params": [],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/creature_functions.cpp"
},
{
"name": "move",
"params": [
"direction: Tile"
],
"return": "number|nil",
"source": "src/lua/functions/creatures/creature_functions.cpp"
},
{
"name": "registerEvent",
"params": [
"name: string"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/creature_functions.cpp"
},
{
"name": "reload",
"params": [],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/creature_functions.cpp"
},
{
"name": "remove",
"params": [
"forced?: boolean"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/creature_functions.cpp"
},
{
"name": "removeCondition",
"params": [
"conditionType: any",
"conditionId?: any",
"subId?: number",
"force?: boolean"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/creature_functions.cpp"
},
{
"name": "removeIcon",
"params": [
"key: string"
],
"return": "boolean",
"source": "src/lua/functions/creatures/creature_functions.cpp"
},
{
"name": "say",
"params": [
"text: string",
"type?: any",
"ghost?: boolean",
"target?: Creature",
"position?: Position"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/creature_functions.cpp"
},
{
"name": "setDirection",
"params": [
"direction: any"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/creature_functions.cpp"
},
{
"name": "setDirectionLocked",
"params": [
"directionLocked: boolean"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/creature_functions.cpp"
},
{
"name": "setDropLoot",
"params": [
"doDrop: boolean"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/creature_functions.cpp"
},
{
"name": "setFollowCreature",
"params": [
"followedCreature: Creature"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/creature_functions.cpp"
},
{
"name": "setHealth",
"params": [
"health: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/creature_functions.cpp"
},
{
"name": "setHiddenHealth",
"params": [
"hide: boolean"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/creature_functions.cpp"
},
{
"name": "setIcon",
"params": [
"key: string",
"category: any",
"icon: any",
"value?: number"
],
"return": "boolean",
"source": "src/lua/functions/creatures/creature_functions.cpp"
},
{
"name": "setLight",
"params": [
"color: number",
"level: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/creature_functions.cpp"
},
{
"name": "setMaster",
"params": [
"master: Creature"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/creature_functions.cpp"
},
{
"name": "setMaxHealth",
"params": [
"maxHealth: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/creature_functions.cpp"
},
{
"name": "setMoveLocked",
"params": [
"moveLocked: boolean"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/creature_functions.cpp"
},
{
"name": "setOutfit",
"params": [
"outfit: any"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/creature_functions.cpp"
},
{
"name": "setShader",
"params": [
"shaderName: string"
],
"return": "boolean",
"source": "src/lua/functions/creatures/creature_functions.cpp"
},
{
"name": "setSkillLoss",
"params": [
"skillLoss: boolean"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/creature_functions.cpp"
},
{
"name": "setSkull",
"params": [
"skull: any"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/creature_functions.cpp"
},
{
"name": "setSpeed",
"params": [
"speed: number"
],
"return": "boolean",
"source": "src/lua/functions/creatures/creature_functions.cpp"
},
{
"name": "setTarget",
"params": [
"target: Creature"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/creature_functions.cpp"
},
{
"name": "teleportTo",
"params": [
"position: Position",
"pushMovement?: boolean"
],
"return": "boolean",
"source": "src/lua/functions/creatures/creature_functions.cpp"
},
{
"name": "unregisterEvent",
"params": [
"name: string"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/creature_functions.cpp"
}
],
"CreatureEvent": [
{
"name": "onAdvance",
"params": [
"callback: fun(player: Player, skill: integer, oldLevel: integer, newLevel: integer): boolean"
],
"return": "boolean",
"source": "src/lua/functions/events/creature_event_functions.cpp"
},
{
"name": "onDeath",
"params": [
"callback: fun(creature: Creature, corpse: Item, lastHitKiller: Creature|nil, mostDamageKiller: Creature|nil, lastHitUnjustified: boolean, mostDamageUnjustified: boolean): boolean"
],
"return": "boolean",
"source": "src/lua/functions/events/creature_event_functions.cpp"
},
{
"name": "onExtendedOpcode",
"params": [
"callback: fun(player: Player, opcode: integer, buffer: string)"
],
"return": "boolean",
"source": "src/lua/functions/events/creature_event_functions.cpp"
},
{
"name": "onHealthChange",
"params": [
"callback: fun(creature: Creature, attacker: Creature|nil, primaryDamage: integer, primaryType: CombatType, secondaryDamage: integer, secondaryType: CombatType, origin: integer): integer, CombatType, integer, CombatType"
],
"return": "boolean",
"source": "src/lua/functions/events/creature_event_functions.cpp"
},
{
"name": "onKill",
"params": [
"callback: fun(creature: Creature, target: Creature, lastHit: boolean)"
],
"return": "boolean",
"source": "src/lua/functions/events/creature_event_functions.cpp"
},
{
"name": "onLogin",
"params": [
"callback: fun(player: Player): boolean"
],
"return": "boolean",
"source": "src/lua/functions/events/creature_event_functions.cpp"
},
{
"name": "onLogout",
"params": [
"callback: fun(player: Player): boolean"
],
"return": "boolean",
"source": "src/lua/functions/events/creature_event_functions.cpp"
},
{
"name": "onManaChange",
"params": [
"callback: fun(creature: Creature, attacker: Creature|nil, primaryDamage: integer, primaryType: CombatType, secondaryDamage: integer, secondaryType: CombatType, origin: integer): integer, CombatType, integer, CombatType"
],
"return": "boolean",
"source": "src/lua/functions/events/creature_event_functions.cpp"
},
{
"name": "onModalWindow",
"params": [
"callback: fun(player: Player, modalWindowId: integer, buttonId: integer, choiceId: integer)"
],
"return": "boolean",
"source": "src/lua/functions/events/creature_event_functions.cpp"
},
{
"name": "onPrepareDeath",
"params": [
"callback: fun(creature: Creature, killer: Creature|nil, realDamage: integer): boolean"
],
"return": "boolean",
"source": "src/lua/functions/events/creature_event_functions.cpp"
},
{
"name": "onTextEdit",
"params": [
"callback: fun(player: Player, item: Item, text: string): boolean"
],
"return": "boolean",
"source": "src/lua/functions/events/creature_event_functions.cpp"
},
{
"name": "onThink",
"params": [
"callback: fun(creature: Creature, interval: integer): boolean"
],
"return": "boolean",
"source": "src/lua/functions/events/creature_event_functions.cpp"
},
{
"name": "register",
"params": [],
"return": "boolean|nil",
"source": "src/lua/functions/events/creature_event_functions.cpp"
},
{
"name": "type",
"params": [
"callback: string"
],
"return": "boolean|nil",
"source": "src/lua/functions/events/creature_event_functions.cpp"
}
],
"EventCallback": [
{
"name": "register",
"params": [
"...: any"
],
"return": "boolean",
"source": "src/lua/functions/events/event_callback_functions.cpp"
},
{
"name": "type",
"params": [
"...: any"
],
"return": "boolean",
"source": "src/lua/functions/events/event_callback_functions.cpp"
}
],
"EventsScheduler": [
{
"name": "getEventSBossLoot",
"params": [
"...: any"
],
"return": "number",
"source": "src/lua/functions/events/events_scheduler_functions.cpp"
},
{
"name": "getEventSExp",
"params": [
"...: any"
],
"return": "number",
"source": "src/lua/functions/events/events_scheduler_functions.cpp"
},
{
"name": "getEventSLoot",
"params": [
"...: any"
],
"return": "number",
"source": "src/lua/functions/events/events_scheduler_functions.cpp"
},
{
"name": "getEventSSkill",
"params": [
"...: any"
],
"return": "number",
"source": "src/lua/functions/events/events_scheduler_functions.cpp"
},
{
"name": "getSpawnMonsterSchedule",
"params": [
"...: any"
],
"return": "number",
"source": "src/lua/functions/events/events_scheduler_functions.cpp"
}
],
"Game": [
{
"name": "addInfluencedMonster",
"params": [
"monster: Monster",
"stack?: number"
],
"return": "boolean",
"source": "src/lua/functions/core/game/game_functions.cpp"
},
{
"name": "createBestiaryCharm",
"params": [
"id: number"
],
"return": "nil|Charm",
"source": "src/lua/functions/core/game/game_functions.cpp"
},
{
"name": "createContainer",
"params": [
"itemIdOrName: number|string",
"size: number",
"position?: Position"
],
"return": "Container|nil",
"source": "src/lua/functions/core/game/game_functions.cpp"
},
{
"name": "createItem",
"params": [
"itemIdOrName: number|string",
"count?: number",
"position?: Position"
],
"return": "Item|Item[]|nil",
"source": "src/lua/functions/core/game/game_functions.cpp"
},
{
"name": "createItemClassification",
"params": [
"id: number"
],
"return": "nil|ItemClassification",
"source": "src/lua/functions/core/game/game_functions.cpp"
},
{
"name": "createMonster",
"params": [
"monsterName: string",
"position: Position",
"extended?: boolean",
"force?: boolean",
"master?: Creature"
],
"return": "nil|Monster",
"source": "src/lua/functions/core/game/game_functions.cpp"
},
{
"name": "createMonsterType",
"params": [
"name: string",
"variant?: string",
"alternateName?: string"
],
"return": "nil|MonsterType",
"source": "src/lua/functions/core/game/game_functions.cpp"
},
{
"name": "createNpc",
"params": [
"npcName: string",
"position: Position",
"extended?: boolean",
"force?: boolean"
],
"return": "nil|Npc",
"source": "src/lua/functions/core/game/game_functions.cpp"
},
{
"name": "createNpcType",
"params": [
"...: any"
],
"return": "nil",
"source": "src/lua/functions/core/game/game_functions.cpp"
},
{
"name": "createSoulPitMonster",
"params": [
"monsterName: string",
"position: Position",
"stack?: number",
"extended?: boolean",
"force?: boolean",
"master?: Creature"
],
"return": "nil|Monster",
"source": "src/lua/functions/core/game/game_functions.cpp"
},
{
"name": "createTile",
"overloads": [
"fun(position: Position, isDynamic?: boolean): Tile"
],
"params": [
"x: integer",
"y: integer",
"z: integer",
"isDynamic?: boolean"
],
"return": "Tile",
"source": "src/lua/functions/core/game/game_functions.cpp"
},
{
"name": "generateNpc",
"params": [
"npcName: string"
],
"return": "nil|Npc",
"source": "src/lua/functions/core/game/game_functions.cpp"
},
{
"name": "getAchievementInfoById",
"params": [
"id: number"
],
"return": "table",
"source": "src/lua/functions/core/game/game_functions.cpp"
},
{
"name": "getAchievementInfoByName",
"params": [
"name: string"
],
"return": "table",
"source": "src/lua/functions/core/game/game_functions.cpp"
},
{
"name": "getAchievements",
"params": [
"...: any"
],
"return": "table",
"source": "src/lua/functions/core/game/game_functions.cpp"
},
{
"name": "getBestiaryCharm",
"params": [
"...: any"
],
"return": "table",
"source": "src/lua/functions/core/game/game_functions.cpp"
},
{
"name": "getBestiaryList",
"params": [
"arg1?: any"
],
"return": "number|string|table",
"source": "src/lua/functions/core/game/game_functions.cpp"
},
{
"name": "getBoostedBoss",
"params": [
"...: any"
],
"return": "string",
"source": "src/lua/functions/core/game/game_functions.cpp"
},
{
"name": "getBoostedCreature",
"params": [
"...: any"
],
"return": "string",
"source": "src/lua/functions/core/game/game_functions.cpp"
},
{
"name": "getClientVersion",
"params": [
"...: any"
],
"return": "table",
"source": "src/lua/functions/core/game/game_functions.cpp"
},
{
"name": "getDummies",
"params": [
"...: any"
],
"return": "table",
"source": "src/lua/functions/core/game/game_functions.cpp"
},
{
"name": "getEventCallbacks",
"params": [
"...: any"
],
"return": "string|table",
"source": "src/lua/functions/core/game/game_functions.cpp"
},
{
"name": "getExperienceForLevel",
"params": [
"level: number"
],
"return": "number",
"source": "src/lua/functions/core/game/game_functions.cpp"
},
{
"name": "getFiendishMonsters",
"params": [
"...: any"
],
"return": "table",
"source": "src/lua/functions/core/game/game_functions.cpp"
},
{
"name": "getGameState",
"params": [
"...: any"
],
"return": "number",
"source": "src/lua/functions/core/game/game_functions.cpp"
},
{
"name": "getHouses",
"params": [
"...: any"
],
"return": "House[]",
"source": "src/lua/functions/core/game/game_functions.cpp"
},
{
"name": "getInfluencedMonsters",
"params": [
"...: any"
],
"return": "table",
"source": "src/lua/functions/core/game/game_functions.cpp"
},
{
"name": "getLadderIds",
"params": [
"...: any"
],
"return": "table",
"source": "src/lua/functions/core/game/game_functions.cpp"
},
{
"name": "getMonsterCount",
"params": [
"...: any"
],
"return": "number",
"source": "src/lua/functions/core/game/game_functions.cpp"
},
{
"name": "getMonsterTypeByName",
"params": [
"name: string"
],
"return": "boolean|MonsterType",
"source": "src/lua/functions/core/game/game_functions.cpp"
},
{
"name": "getMonsterTypes",
"params": [
"...: any"
],
"return": "table<string, MonsterType>",
"source": "src/lua/functions/core/game/game_functions.cpp"
},
{
"name": "getMonstersByBestiaryStars",
"params": [
"stars: number"
],
"return": "table",
"source": "src/lua/functions/core/game/game_functions.cpp"
},
{
"name": "getMonstersByRace",
"params": [
"race: any"
],
"return": "table",
"source": "src/lua/functions/core/game/game_functions.cpp"
},
{
"name": "getNormalizedGuildName",
"params": [
"name: string"
],
"return": "string|nil",
"source": "src/lua/functions/core/game/game_functions.cpp"
},
{
"name": "getNormalizedPlayerName",
"params": [
"name: string",
"isNewName?: boolean"
],
"return": "string|nil",
"source": "src/lua/functions/core/game/game_functions.cpp"
},
{
"name": "getNpcCount",
"params": [
"...: any"
],
"return": "number",
"source": "src/lua/functions/core/game/game_functions.cpp"
},
{
"name": "getOfflinePlayer",
"params": [
"nameOrId: number|string"
],
"return": "nil|Player",
"source": "src/lua/functions/core/game/game_functions.cpp"
},
{
"name": "getPlayerCount",
"params": [
"...: any"
],
"return": "number",
"source": "src/lua/functions/core/game/game_functions.cpp"
},
{
"name": "getPlayers",
"params": [
"...: any"
],
"return": "Player[]",
"source": "src/lua/functions/core/game/game_functions.cpp"
},
{
"name": "getPublicAchievements",
"params": [
"...: any"
],
"return": "table",
"source": "src/lua/functions/core/game/game_functions.cpp"
},
{
"name": "getReturnMessage",
"params": [
"value: any"
],
"return": "string",
"source": "src/lua/functions/core/game/game_functions.cpp"
},
{
"name": "getSecretAchievements",
"params": [
"...: any"
],
"return": "table",
"source": "src/lua/functions/core/game/game_functions.cpp"
},
{
"name": "getSoulCoreItems",
"params": [
"...: any"
],
"return": "table",
"source": "src/lua/functions/core/game/game_functions.cpp"
},
{
"name": "getSpectators",
"params": [
"position: Position",
"multifloor?: boolean",
"onlyPlayer?: boolean",
"minRangeX?: integer",
"maxRangeX?: integer",
"minRangeY?: integer",
"maxRangeY?: integer"
],
"return": "Creature[]",
"source": "src/lua/functions/core/game/game_functions.cpp"
},
{
"name": "getTalkActions",
"params": [
"...: any"
],
"return": "table",
"source": "src/lua/functions/core/game/game_functions.cpp"
},
{
"name": "getTowns",
"params": [
"...: any"
],
"return": "Town[]",
"source": "src/lua/functions/core/game/game_functions.cpp"
},
{
"name": "getWorldType",
"params": [
"...: any"
],
"return": "number",
"source": "src/lua/functions/core/game/game_functions.cpp"
},
{
"name": "hasDistanceEffect",
"params": [
"effectId: number"
],
"return": "boolean",
"source": "src/lua/functions/core/game/game_functions.cpp"
},
{
"name": "hasEffect",
"params": [
"effectId: number"
],
"return": "boolean",
"source": "src/lua/functions/core/game/game_functions.cpp"
},
{
"name": "loadMap",
"params": [
"path: string"
],
"return": "nil",
"source": "src/lua/functions/core/game/game_functions.cpp"
},
{
"name": "loadMapChunk",
"params": [
"path: string",
"position: Position",
"remove: any"
],
"return": "nil",
"source": "src/lua/functions/core/game/game_functions.cpp"
},
{
"name": "makeFiendishMonster",
"params": [
"monsterId: number"
],
"return": "number",
"source": "src/lua/functions/core/game/game_functions.cpp"
},
{
"name": "registerAchievement",
"params": [
"id: number",
"name: string",
"description: string",
"secret: boolean",
"grade: number",
"points: number"
],
"return": "boolean",
"source": "src/lua/functions/core/game/game_functions.cpp"
},
{
"name": "reload",
"params": [
"reloadType: any"
],
"return": "boolean",
"source": "src/lua/functions/core/game/game_functions.cpp"
},
{
"name": "removeFiendishMonster",
"params": [
"monsterId: number"
],
"return": "number",
"source": "src/lua/functions/core/game/game_functions.cpp"
},
{
"name": "removeInfluencedMonster",
"params": [
"monsterId: number"
],
"return": "number",
"source": "src/lua/functions/core/game/game_functions.cpp"
},
{
"name": "setGameState",
"params": [
"state: any"
],
"return": "boolean",
"source": "src/lua/functions/core/game/game_functions.cpp"
},
{
"name": "setWorldType",
"params": [
"type: any"
],
"return": "boolean",
"source": "src/lua/functions/core/game/game_functions.cpp"
},
{
"name": "startRaid",
"params": [
"raidName: string"
],
"return": "number",
"source": "src/lua/functions/core/game/game_functions.cpp"
}
],
"GlobalEvent": [
{
"name": "interval",
"params": [
"interval: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/events/global_event_functions.cpp"
},
{
"name": "onPeriodChange",
"params": [
"callback: fun(lightState: integer, lightLevel: integer): boolean"
],
"return": "boolean",
"source": "src/lua/functions/events/global_event_functions.cpp"
},
{
"name": "onRecord",
"params": [
"callback: fun(current: integer, old: integer): boolean"
],
"return": "boolean",
"source": "src/lua/functions/events/global_event_functions.cpp"
},
{
"name": "onSave",
"params": [
"callback: fun(): boolean"
],
"return": "boolean",
"source": "src/lua/functions/events/global_event_functions.cpp"
},
{
"name": "onShutdown",
"params": [
"callback: fun(): boolean"
],
"return": "boolean",
"source": "src/lua/functions/events/global_event_functions.cpp"
},
{
"name": "onStartup",
"params": [
"callback: fun(): boolean"
],
"return": "boolean",
"source": "src/lua/functions/events/global_event_functions.cpp"
},
{
"name": "onThink",
"params": [
"callback: fun(interval: integer): boolean"
],
"return": "boolean",
"source": "src/lua/functions/events/global_event_functions.cpp"
},
{
"name": "onTime",
"params": [
"callback: fun(interval: integer): boolean"
],
"return": "boolean",
"source": "src/lua/functions/events/global_event_functions.cpp"
},
{
"name": "register",
"params": [],
"return": "boolean|nil",
"source": "src/lua/functions/events/global_event_functions.cpp"
},
{
"name": "time",
"params": [
"time: string"
],
"return": "boolean|nil",
"source": "src/lua/functions/events/global_event_functions.cpp"
},
{
"name": "type",
"params": [
"callback: string"
],
"return": "boolean|nil",
"source": "src/lua/functions/events/global_event_functions.cpp"
}
],
"Group": [
{
"name": "getAccess",
"params": [],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/group_functions.cpp"
},
{
"name": "getFlags",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/creatures/player/group_functions.cpp"
},
{
"name": "getId",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/creatures/player/group_functions.cpp"
},
{
"name": "getMaxDepotItems",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/creatures/player/group_functions.cpp"
},
{
"name": "getMaxVipEntries",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/creatures/player/group_functions.cpp"
},
{
"name": "getName",
"params": [],
"return": "string|nil",
"source": "src/lua/functions/creatures/player/group_functions.cpp"
},
{
"name": "hasFlag",
"params": [
"flag: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/group_functions.cpp"
}
],
"Guild": [
{
"name": "addRank",
"params": [
"id: number",
"name: string",
"level: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/guild_functions.cpp"
},
{
"name": "getBankBalance",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/creatures/player/guild_functions.cpp"
},
{
"name": "getId",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/creatures/player/guild_functions.cpp"
},
{
"name": "getMembersOnline",
"params": [],
"return": "table|nil",
"source": "src/lua/functions/creatures/player/guild_functions.cpp"
},
{
"name": "getMotd",
"params": [],
"return": "string|nil",
"source": "src/lua/functions/creatures/player/guild_functions.cpp"
},
{
"name": "getName",
"params": [],
"return": "string|nil",
"source": "src/lua/functions/creatures/player/guild_functions.cpp"
},
{
"name": "getRankById",
"params": [
"id: number"
],
"return": "table|nil",
"source": "src/lua/functions/creatures/player/guild_functions.cpp"
},
{
"name": "getRankByLevel",
"params": [
"level: number"
],
"return": "table|nil",
"source": "src/lua/functions/creatures/player/guild_functions.cpp"
},
{
"name": "setBankBalance",
"params": [
"bankBalance: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/guild_functions.cpp"
},
{
"name": "setMotd",
"params": [
"motd: string"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/guild_functions.cpp"
}
],
"House": [
{
"name": "canEditAccessList",
"params": [
"listId: number",
"player: Player"
],
"return": "boolean|nil",
"source": "src/lua/functions/map/house_functions.cpp"
},
{
"name": "getAccessList",
"params": [
"listId: number"
],
"return": "boolean|string|nil",
"source": "src/lua/functions/map/house_functions.cpp"
},
{
"name": "getBedCount",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/map/house_functions.cpp"
},
{
"name": "getBeds",
"params": [],
"return": "table|nil",
"source": "src/lua/functions/map/house_functions.cpp"
},
{
"name": "getDoorCount",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/map/house_functions.cpp"
},
{
"name": "getDoorIdByPosition",
"params": [
"position: Position"
],
"return": "number|nil",
"source": "src/lua/functions/map/house_functions.cpp"
},
{
"name": "getDoors",
"params": [],
"return": "table|nil",
"source": "src/lua/functions/map/house_functions.cpp"
},
{
"name": "getExitPosition",
"params": [],
"return": "nil|Position",
"source": "src/lua/functions/map/house_functions.cpp"
},
{
"name": "getId",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/map/house_functions.cpp"
},
{
"name": "getItems",
"params": [],
"return": "table|nil",
"source": "src/lua/functions/map/house_functions.cpp"
},
{
"name": "getName",
"params": [],
"return": "string|nil",
"source": "src/lua/functions/map/house_functions.cpp"
},
{
"name": "getOwnerGuid",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/map/house_functions.cpp"
},
{
"name": "getPrice",
"params": [],
"return": "number",
"source": "src/lua/functions/map/house_functions.cpp"
},
{
"name": "getRent",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/map/house_functions.cpp"
},
{
"name": "getTileCount",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/map/house_functions.cpp"
},
{
"name": "getTiles",
"params": [],
"return": "table|nil",
"source": "src/lua/functions/map/house_functions.cpp"
},
{
"name": "getTown",
"params": [],
"return": "nil|Town",
"source": "src/lua/functions/map/house_functions.cpp"
},
{
"name": "hasItemOnTile",
"params": [],
"return": "boolean|nil",
"source": "src/lua/functions/map/house_functions.cpp"
},
{
"name": "hasNewOwnership",
"params": [
"guid: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/map/house_functions.cpp"
},
{
"name": "isInvited",
"params": [
"player: Player"
],
"return": "boolean|nil",
"source": "src/lua/functions/map/house_functions.cpp"
},
{
"name": "kickPlayer",
"params": [
"player: Player",
"targetPlayer: Player"
],
"return": "boolean|nil",
"source": "src/lua/functions/map/house_functions.cpp"
},
{
"name": "setAccessList",
"params": [
"listId: number",
"list: string"
],
"return": "boolean|nil",
"source": "src/lua/functions/map/house_functions.cpp"
},
{
"name": "setHouseOwner",
"params": [
"guid: number",
"updateDatabase?: boolean"
],
"return": "boolean|nil",
"source": "src/lua/functions/map/house_functions.cpp"
},
{
"name": "setNewOwnerGuid",
"params": [
"guid: number",
"updateDatabase?: boolean"
],
"return": "boolean|nil",
"source": "src/lua/functions/map/house_functions.cpp"
},
{
"name": "startTrade",
"params": [
"player: Player",
"tradePartner: Player"
],
"return": "number|nil",
"source": "src/lua/functions/map/house_functions.cpp"
}
],
"Imbuement": [
{
"name": "getBase",
"params": [],
"return": "table|nil",
"source": "src/lua/functions/items/imbuement_functions.cpp"
},
{
"name": "getCategory",
"params": [],
"return": "table|nil",
"source": "src/lua/functions/items/imbuement_functions.cpp"
},
{
"name": "getCombatType",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/items/imbuement_functions.cpp"
},
{
"name": "getElementDamage",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/items/imbuement_functions.cpp"
},
{
"name": "getId",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/items/imbuement_functions.cpp"
},
{
"name": "getItems",
"params": [],
"return": "table|nil",
"source": "src/lua/functions/items/imbuement_functions.cpp"
},
{
"name": "getName",
"params": [],
"return": "string|nil",
"source": "src/lua/functions/items/imbuement_functions.cpp"
},
{
"name": "isPremium",
"params": [],
"return": "boolean|nil",
"source": "src/lua/functions/items/imbuement_functions.cpp"
}
],
"Item": [
{
"name": "actor",
"params": [
"arg2?: boolean"
],
"return": "boolean",
"source": "src/lua/functions/items/item_functions.cpp"
},
{
"name": "canBeMoved",
"params": [],
"return": "boolean|nil",
"source": "src/lua/functions/items/item_functions.cpp"
},
{
"name": "canReceiveAutoCarpet",
"params": [],
"return": "boolean",
"source": "src/lua/functions/items/item_functions.cpp"
},
{
"name": "clone",
"params": [],
"return": "nil|Item",
"source": "src/lua/functions/items/item_functions.cpp"
},
{
"name": "decay",
"params": [
"decayId: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/items/item_functions.cpp"
},
{
"name": "getActionId",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/items/item_functions.cpp"
},
{
"name": "getArticle",
"params": [],
"return": "string|nil",
"source": "src/lua/functions/items/item_functions.cpp"
},
{
"name": "getAttribute",
"params": [
"key: string"
],
"return": "number|string|nil",
"source": "src/lua/functions/items/item_functions.cpp"
},
{
"name": "getCharges",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/items/item_functions.cpp"
},
{
"name": "getClassification",
"params": [],
"return": "boolean|number",
"source": "src/lua/functions/items/item_functions.cpp"
},
{
"name": "getContainer",
"params": [],
"return": "boolean|nil",
"source": "src/lua/functions/items/item_functions.cpp"
},
{
"name": "getCount",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/items/item_functions.cpp"
},
{
"name": "getCustomAttribute",
"params": [
"key: number|string"
],
"return": "nil",
"source": "src/lua/functions/items/item_functions.cpp"
},
{
"name": "getDescription",
"params": [
"distance: number"
],
"return": "string|nil",
"source": "src/lua/functions/items/item_functions.cpp"
},
{
"name": "getFluidType",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/items/item_functions.cpp"
},
{
"name": "getId",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/items/item_functions.cpp"
},
{
"name": "getImbuement",
"params": [],
"return": "boolean|table|Imbuement",
"source": "src/lua/functions/items/item_functions.cpp"
},
{
"name": "getImbuementSlot",
"params": [],
"return": "boolean|number",
"source": "src/lua/functions/items/item_functions.cpp"
},
{
"name": "getName",
"params": [],
"return": "string|nil",
"source": "src/lua/functions/items/item_functions.cpp"
},
{
"name": "getOwnerId",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/items/item_functions.cpp"
},
{
"name": "getOwnerName",
"params": [],
"return": "string|nil",
"source": "src/lua/functions/items/item_functions.cpp"
},
{
"name": "getParent",
"params": [],
"return": "nil",
"source": "src/lua/functions/items/item_functions.cpp"
},
{
"name": "getPluralName",
"params": [],
"return": "string|nil",
"source": "src/lua/functions/items/item_functions.cpp"
},
{
"name": "getPosition",
"params": [],
"return": "nil|Position",
"source": "src/lua/functions/items/item_functions.cpp"
},
{
"name": "getShader",
"params": [],
"return": "boolean|string",
"source": "src/lua/functions/items/item_functions.cpp"
},
{
"name": "getSubType",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/items/item_functions.cpp"
},
{
"name": "getTier",
"params": [],
"return": "boolean|number",
"source": "src/lua/functions/items/item_functions.cpp"
},
{
"name": "getTile",
"params": [],
"return": "nil|Tile",
"source": "src/lua/functions/items/item_functions.cpp"
},
{
"name": "getTopParent",
"params": [],
"return": "nil",
"source": "src/lua/functions/items/item_functions.cpp"
},
{
"name": "getUniqueId",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/items/item_functions.cpp"
},
{
"name": "getWeight",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/items/item_functions.cpp"
},
{
"name": "hasAttribute",
"params": [
"key: string"
],
"return": "boolean|nil",
"source": "src/lua/functions/items/item_functions.cpp"
},
{
"name": "hasOwner",
"params": [],
"return": "boolean",
"source": "src/lua/functions/items/item_functions.cpp"
},
{
"name": "hasProperty",
"params": [
"property: any"
],
"return": "boolean|nil",
"source": "src/lua/functions/items/item_functions.cpp"
},
{
"name": "hasShader",
"params": [],
"return": "boolean",
"source": "src/lua/functions/items/item_functions.cpp"
},
{
"name": "isContainer",
"params": [],
"return": "boolean",
"source": "src/lua/functions/items/item_functions.cpp"
},
{
"name": "isInsideDepot",
"params": [
"includeInbox?: boolean"
],
"return": "boolean",
"source": "src/lua/functions/items/item_functions.cpp"
},
{
"name": "isItem",
"params": [],
"return": "boolean",
"source": "src/lua/functions/items/item_functions.cpp"
},
{
"name": "isOwner",
"params": [
"creatureOrCreatureId: number|Creature"
],
"return": "boolean",
"source": "src/lua/functions/items/item_functions.cpp"
},
{
"name": "moveTo",
"params": [
"positionOrCylinder: Container|Player|Tile|Position",
"flags?: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/items/item_functions.cpp"
},
{
"name": "moveToSlot",
"params": [
"player: Player",
"slot: any"
],
"return": "boolean|nil",
"source": "src/lua/functions/items/item_functions.cpp"
},
{
"name": "remove",
"params": [
"count?: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/items/item_functions.cpp"
},
{
"name": "removeAttribute",
"params": [
"key: string"
],
"return": "boolean|nil",
"source": "src/lua/functions/items/item_functions.cpp"
},
{
"name": "removeCustomAttribute",
"params": [
"key: number|string"
],
"return": "boolean|nil",
"source": "src/lua/functions/items/item_functions.cpp"
},
{
"name": "serializeAttributes",
"params": [],
"return": "nil",
"source": "src/lua/functions/items/item_functions.cpp"
},
{
"name": "setActionId",
"params": [
"actionId: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/items/item_functions.cpp"
},
{
"name": "setAttribute",
"params": [
"key: string",
"value: string|number"
],
"return": "boolean|nil",
"source": "src/lua/functions/items/item_functions.cpp"
},
{
"name": "setCustomAttribute",
"params": [
"key: number|string",
"value: number|string|boolean"
],
"return": "boolean|nil",
"source": "src/lua/functions/items/item_functions.cpp"
},
{
"name": "setDuration",
"params": [
"minDuration?: number",
"maxDuration?: number",
"decayTo?: number",
"showDuration?: boolean"
],
"return": "boolean",
"source": "src/lua/functions/items/item_functions.cpp"
},
{
"name": "setExpertPvpFieldContext",
"params": [
"owner: Creature"
],
"return": "boolean",
"source": "src/lua/functions/items/item_functions.cpp"
},
{
"name": "setOwner",
"params": [
"creatureOrCreatureId: number|Creature"
],
"return": "boolean",
"source": "src/lua/functions/items/item_functions.cpp"
},
{
"name": "setShader",
"params": [
"shaderName: string"
],
"return": "boolean",
"source": "src/lua/functions/items/item_functions.cpp"
},
{
"name": "setTier",
"params": [
"tier: number"
],
"return": "boolean",
"source": "src/lua/functions/items/item_functions.cpp"
},
{
"name": "split",
"params": [
"count?: number"
],
"return": "nil|Item",
"source": "src/lua/functions/items/item_functions.cpp"
},
{
"name": "transform",
"params": [
"itemId: number|string",
"countOrSubType?: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/items/item_functions.cpp"
}
],
"ItemClassification": [
{
"name": "addTier",
"params": [
"id: number",
"core: number",
"regularPrice: number",
"convergenceFusionPrice: number",
"convergenceTransferPrice: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/items/item_classification_functions.cpp"
}
],
"ItemType": [
{
"name": "getAmmoType",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/items/item_type_functions.cpp"
},
{
"name": "getArmor",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/items/item_type_functions.cpp"
},
{
"name": "getArticle",
"params": [],
"return": "string|nil",
"source": "src/lua/functions/items/item_type_functions.cpp"
},
{
"name": "getAttack",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/items/item_type_functions.cpp"
},
{
"name": "getBaseSpeed",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/items/item_type_functions.cpp"
},
{
"name": "getCapacity",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/items/item_type_functions.cpp"
},
{
"name": "getCharges",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/items/item_type_functions.cpp"
},
{
"name": "getDecayId",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/items/item_type_functions.cpp"
},
{
"name": "getDecayTime",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/items/item_type_functions.cpp"
},
{
"name": "getDefense",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/items/item_type_functions.cpp"
},
{
"name": "getDescription",
"params": [
"count?: number"
],
"return": "string|nil",
"source": "src/lua/functions/items/item_type_functions.cpp"
},
{
"name": "getDestroyId",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/items/item_type_functions.cpp"
},
{
"name": "getElementDamage",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/items/item_type_functions.cpp"
},
{
"name": "getElementType",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/items/item_type_functions.cpp"
},
{
"name": "getElementalBond",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/items/item_type_functions.cpp"
},
{
"name": "getExtraDefense",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/items/item_type_functions.cpp"
},
{
"name": "getFluidSource",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/items/item_type_functions.cpp"
},
{
"name": "getHitChance",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/items/item_type_functions.cpp"
},
{
"name": "getId",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/items/item_type_functions.cpp"
},
{
"name": "getImbuementSlot",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/items/item_type_functions.cpp"
},
{
"name": "getName",
"params": [],
"return": "string|nil",
"source": "src/lua/functions/items/item_type_functions.cpp"
},
{
"name": "getPluralName",
"params": [],
"return": "string|nil",
"source": "src/lua/functions/items/item_type_functions.cpp"
},
{
"name": "getRequiredLevel",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/items/item_type_functions.cpp"
},
{
"name": "getShootRange",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/items/item_type_functions.cpp"
},
{
"name": "getShowDuration",
"params": [],
"return": "boolean|nil",
"source": "src/lua/functions/items/item_type_functions.cpp"
},
{
"name": "getSlotPosition",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/items/item_type_functions.cpp"
},
{
"name": "getSpeed",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/items/item_type_functions.cpp"
},
{
"name": "getStackSize",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/items/item_type_functions.cpp"
},
{
"name": "getTransformDeEquipId",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/items/item_type_functions.cpp"
},
{
"name": "getTransformEquipId",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/items/item_type_functions.cpp"
},
{
"name": "getType",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/items/item_type_functions.cpp"
},
{
"name": "getVocationString",
"params": [],
"return": "string|nil",
"source": "src/lua/functions/items/item_type_functions.cpp"
},
{
"name": "getWeaponType",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/items/item_type_functions.cpp"
},
{
"name": "getWeight",
"params": [
"count?: number"
],
"return": "number|nil",
"source": "src/lua/functions/items/item_type_functions.cpp"
},
{
"name": "getWrapableTo",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/items/item_type_functions.cpp"
},
{
"name": "hasSubType",
"params": [],
"return": "boolean|nil",
"source": "src/lua/functions/items/item_type_functions.cpp"
},
{
"name": "isBlocking",
"params": [],
"return": "boolean|nil",
"source": "src/lua/functions/items/item_type_functions.cpp"
},
{
"name": "isContainer",
"params": [],
"return": "boolean|nil",
"source": "src/lua/functions/items/item_type_functions.cpp"
},
{
"name": "isCorpse",
"params": [],
"return": "boolean|nil",
"source": "src/lua/functions/items/item_type_functions.cpp"
},
{
"name": "isDoor",
"params": [],
"return": "boolean|nil",
"source": "src/lua/functions/items/item_type_functions.cpp"
},
{
"name": "isFluidContainer",
"params": [],
"return": "boolean|nil",
"source": "src/lua/functions/items/item_type_functions.cpp"
},
{
"name": "isGroundTile",
"params": [],
"return": "boolean|nil",
"source": "src/lua/functions/items/item_type_functions.cpp"
},
{
"name": "isKey",
"params": [],
"return": "boolean|nil",
"source": "src/lua/functions/items/item_type_functions.cpp"
},
{
"name": "isMagicField",
"params": [],
"return": "boolean|nil",
"source": "src/lua/functions/items/item_type_functions.cpp"
},
{
"name": "isMovable",
"params": [],
"return": "boolean|nil",
"source": "src/lua/functions/items/item_type_functions.cpp"
},
{
"name": "isMultiUse",
"params": [],
"return": "boolean|nil",
"source": "src/lua/functions/items/item_type_functions.cpp"
},
{
"name": "isPickupable",
"params": [],
"return": "boolean|nil",
"source": "src/lua/functions/items/item_type_functions.cpp"
},
{
"name": "isPodium",
"params": [],
"return": "boolean|nil",
"source": "src/lua/functions/items/item_type_functions.cpp"
},
{
"name": "isQuiver",
"params": [],
"return": "boolean|nil",
"source": "src/lua/functions/items/item_type_functions.cpp"
},
{
"name": "isReadable",
"params": [],
"return": "boolean|nil",
"source": "src/lua/functions/items/item_type_functions.cpp"
},
{
"name": "isRune",
"params": [],
"return": "boolean|nil",
"source": "src/lua/functions/items/item_type_functions.cpp"
},
{
"name": "isStackable",
"params": [],
"return": "boolean|nil",
"source": "src/lua/functions/items/item_type_functions.cpp"
},
{
"name": "isStowable",
"params": [],
"return": "boolean|nil",
"source": "src/lua/functions/items/item_type_functions.cpp"
},
{
"name": "isWeapon",
"params": [],
"return": "boolean|nil",
"source": "src/lua/functions/items/item_type_functions.cpp"
},
{
"name": "isWritable",
"params": [],
"return": "boolean|nil",
"source": "src/lua/functions/items/item_type_functions.cpp"
}
],
"KV": [
{
"name": "get",
"params": [
"key: string|KV|boolean",
"forceLoad?: boolean"
],
"return": "nil",
"source": "src/lua/functions/core/libs/kv_functions.cpp"
},
{
"name": "keys",
"params": [
"prefix?: KV|string"
],
"return": "table",
"source": "src/lua/functions/core/libs/kv_functions.cpp"
},
{
"name": "remove",
"params": [
"key: string|KV"
],
"return": "nil",
"source": "src/lua/functions/core/libs/kv_functions.cpp"
},
{
"name": "scoped",
"params": [
"key: string|KV"
],
"return": "KV",
"source": "src/lua/functions/core/libs/kv_functions.cpp"
},
{
"name": "set",
"params": [
"key: string|KV",
"value: number"
],
"return": "boolean",
"source": "src/lua/functions/core/libs/kv_functions.cpp"
}
],
"Loot": [
{
"name": "addChildLoot",
"params": [
"loot: Loot"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/monster/loot_functions.cpp"
},
{
"name": "setActionId",
"params": [
"...: any"
],
"return": "nil",
"source": "src/lua/functions/creatures/monster/loot_functions.cpp"
},
{
"name": "setArmor",
"params": [
"...: any"
],
"return": "nil",
"source": "src/lua/functions/creatures/monster/loot_functions.cpp"
},
{
"name": "setArticle",
"params": [
"...: any"
],
"return": "nil",
"source": "src/lua/functions/creatures/monster/loot_functions.cpp"
},
{
"name": "setAttack",
"params": [
"...: any"
],
"return": "nil",
"source": "src/lua/functions/creatures/monster/loot_functions.cpp"
},
{
"name": "setChance",
"params": [
"...: any"
],
"return": "nil",
"source": "src/lua/functions/creatures/monster/loot_functions.cpp"
},
{
"name": "setDefense",
"params": [
"...: any"
],
"return": "nil",
"source": "src/lua/functions/creatures/monster/loot_functions.cpp"
},
{
"name": "setExtraDefense",
"params": [
"...: any"
],
"return": "nil",
"source": "src/lua/functions/creatures/monster/loot_functions.cpp"
},
{
"name": "setHitChance",
"params": [
"...: any"
],
"return": "nil",
"source": "src/lua/functions/creatures/monster/loot_functions.cpp"
},
{
"name": "setId",
"params": [
"...: any"
],
"return": "nil",
"source": "src/lua/functions/creatures/monster/loot_functions.cpp"
},
{
"name": "setIdFromName",
"params": [
"name: string"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/monster/loot_functions.cpp"
},
{
"name": "setMaxCount",
"params": [
"...: any"
],
"return": "nil",
"source": "src/lua/functions/creatures/monster/loot_functions.cpp"
},
{
"name": "setMinCount",
"params": [
"...: any"
],
"return": "nil",
"source": "src/lua/functions/creatures/monster/loot_functions.cpp"
},
{
"name": "setNameItem",
"params": [
"...: any"
],
"return": "nil",
"source": "src/lua/functions/creatures/monster/loot_functions.cpp"
},
{
"name": "setShootRange",
"params": [
"...: any"
],
"return": "nil",
"source": "src/lua/functions/creatures/monster/loot_functions.cpp"
},
{
"name": "setSubType",
"params": [
"...: any"
],
"return": "nil",
"source": "src/lua/functions/creatures/monster/loot_functions.cpp"
},
{
"name": "setText",
"params": [
"...: any"
],
"return": "nil",
"source": "src/lua/functions/creatures/monster/loot_functions.cpp"
},
{
"name": "setUnique",
"params": [
"value?: boolean"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/monster/loot_functions.cpp"
}
],
"ModalWindow": [
{
"name": "addButton",
"params": [
"id: number",
"text: string"
],
"return": "boolean|nil",
"source": "src/lua/functions/core/game/modal_window_functions.cpp"
},
{
"name": "addChoice",
"params": [
"id: number",
"text: string"
],
"return": "boolean|nil",
"source": "src/lua/functions/core/game/modal_window_functions.cpp"
},
{
"name": "getButtonCount",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/core/game/modal_window_functions.cpp"
},
{
"name": "getChoiceCount",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/core/game/modal_window_functions.cpp"
},
{
"name": "getDefaultEnterButton",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/core/game/modal_window_functions.cpp"
},
{
"name": "getDefaultEscapeButton",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/core/game/modal_window_functions.cpp"
},
{
"name": "getId",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/core/game/modal_window_functions.cpp"
},
{
"name": "getMessage",
"params": [],
"return": "string|nil",
"source": "src/lua/functions/core/game/modal_window_functions.cpp"
},
{
"name": "getTitle",
"params": [],
"return": "string|nil",
"source": "src/lua/functions/core/game/modal_window_functions.cpp"
},
{
"name": "hasPriority",
"params": [],
"return": "boolean|nil",
"source": "src/lua/functions/core/game/modal_window_functions.cpp"
},
{
"name": "sendToPlayer",
"params": [
"player: Player"
],
"return": "boolean|nil",
"source": "src/lua/functions/core/game/modal_window_functions.cpp"
},
{
"name": "setDefaultEnterButton",
"params": [
"buttonId: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/core/game/modal_window_functions.cpp"
},
{
"name": "setDefaultEscapeButton",
"params": [
"buttonId: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/core/game/modal_window_functions.cpp"
},
{
"name": "setMessage",
"params": [
"text: string"
],
"return": "boolean|nil",
"source": "src/lua/functions/core/game/modal_window_functions.cpp"
},
{
"name": "setPriority",
"params": [
"priority: boolean"
],
"return": "boolean|nil",
"source": "src/lua/functions/core/game/modal_window_functions.cpp"
},
{
"name": "setTitle",
"params": [
"text: string"
],
"return": "boolean|nil",
"source": "src/lua/functions/core/game/modal_window_functions.cpp"
}
],
"Monster": [
{
"name": "addAttackSpell",
"params": [
"monsterspell: MonsterSpell"
],
"return": "nil",
"source": "src/lua/functions/creatures/monster/monster_functions.cpp"
},
{
"name": "addDefense",
"params": [
"defense: number"
],
"return": "boolean",
"source": "src/lua/functions/creatures/monster/monster_functions.cpp"
},
{
"name": "addDefenseSpell",
"params": [
"monsterspell: MonsterSpell"
],
"return": "nil",
"source": "src/lua/functions/creatures/monster/monster_functions.cpp"
},
{
"name": "addFriend",
"params": [
"creature: Creature"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/monster/monster_functions.cpp"
},
{
"name": "addReflectElement",
"params": [
"type: any",
"percent: number"
],
"return": "boolean",
"source": "src/lua/functions/creatures/monster/monster_functions.cpp"
},
{
"name": "addTarget",
"params": [
"creature: Creature",
"pushFront?: boolean"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/monster/monster_functions.cpp"
},
{
"name": "changeTargetDistance",
"params": [
"distance: number",
"duration?: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/monster/monster_functions.cpp"
},
{
"name": "clearFiendishStatus",
"params": [],
"return": "boolean",
"source": "src/lua/functions/creatures/monster/monster_functions.cpp"
},
{
"name": "configureForgeSystem",
"params": [
"stack?: number"
],
"return": "boolean",
"source": "src/lua/functions/creatures/monster/monster_functions.cpp"
},
{
"name": "criticalChance",
"params": [
"critical?: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/monster/monster_functions.cpp"
},
{
"name": "criticalDamage",
"params": [
"damage?: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/monster/monster_functions.cpp"
},
{
"name": "getDefense",
"params": [
"defense: any"
],
"return": "boolean|number",
"source": "src/lua/functions/creatures/monster/monster_functions.cpp"
},
{
"name": "getForgeStack",
"params": [],
"return": "boolean|number",
"source": "src/lua/functions/creatures/monster/monster_functions.cpp"
},
{
"name": "getFriendCount",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/creatures/monster/monster_functions.cpp"
},
{
"name": "getFriendList",
"params": [],
"return": "table|nil",
"source": "src/lua/functions/creatures/monster/monster_functions.cpp"
},
{
"name": "getMonsterForgeClassification",
"params": [],
"return": "boolean|number",
"source": "src/lua/functions/creatures/monster/monster_functions.cpp"
},
{
"name": "getName",
"params": [],
"return": "boolean|string",
"source": "src/lua/functions/creatures/monster/monster_functions.cpp"
},
{
"name": "getRespawnType",
"params": [],
"return": "boolean|number|nil",
"source": "src/lua/functions/creatures/monster/monster_functions.cpp"
},
{
"name": "getSpawnPosition",
"params": [],
"return": "nil|Position",
"source": "src/lua/functions/creatures/monster/monster_functions.cpp"
},
{
"name": "getTargetCount",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/creatures/monster/monster_functions.cpp"
},
{
"name": "getTargetList",
"params": [],
"return": "table|nil",
"source": "src/lua/functions/creatures/monster/monster_functions.cpp"
},
{
"name": "getTimeToChangeFiendish",
"params": [],
"return": "boolean|number",
"source": "src/lua/functions/creatures/monster/monster_functions.cpp"
},
{
"name": "getType",
"params": [],
"return": "nil|MonsterType",
"source": "src/lua/functions/creatures/monster/monster_functions.cpp"
},
{
"name": "hazard",
"params": [
"hazard?: boolean"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/monster/monster_functions.cpp"
},
{
"name": "hazardCrit",
"params": [
"hazardCrit?: boolean"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/monster/monster_functions.cpp"
},
{
"name": "hazardDamageBoost",
"params": [
"hazardDamageBoost?: boolean"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/monster/monster_functions.cpp"
},
{
"name": "hazardDefenseBoost",
"params": [
"hazardDefenseBoost?: boolean"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/monster/monster_functions.cpp"
},
{
"name": "hazardDodge",
"params": [
"hazardDodge?: boolean"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/monster/monster_functions.cpp"
},
{
"name": "immune",
"params": [
"arg2?: boolean"
],
"return": "boolean",
"source": "src/lua/functions/creatures/monster/monster_functions.cpp"
},
{
"name": "isChallenged",
"params": [],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/monster/monster_functions.cpp"
},
{
"name": "isDead",
"params": [],
"return": "boolean",
"source": "src/lua/functions/creatures/monster/monster_functions.cpp"
},
{
"name": "isForgeable",
"params": [],
"return": "boolean",
"source": "src/lua/functions/creatures/monster/monster_functions.cpp"
},
{
"name": "isFriend",
"params": [
"creature: Creature"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/monster/monster_functions.cpp"
},
{
"name": "isIdle",
"params": [],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/monster/monster_functions.cpp"
},
{
"name": "isInSpawnRange",
"params": [
"position?: Position"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/monster/monster_functions.cpp"
},
{
"name": "isMonster",
"params": [],
"return": "boolean",
"source": "src/lua/functions/creatures/monster/monster_functions.cpp"
},
{
"name": "isOpponent",
"params": [
"creature: Creature"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/monster/monster_functions.cpp"
},
{
"name": "isTarget",
"params": [
"creature: Creature"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/monster/monster_functions.cpp"
},
{
"name": "removeFriend",
"params": [
"creature: Creature"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/monster/monster_functions.cpp"
},
{
"name": "removeTarget",
"params": [
"creature: Creature"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/monster/monster_functions.cpp"
},
{
"name": "searchTarget",
"params": [
"searchType?: any"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/monster/monster_functions.cpp"
},
{
"name": "selectTarget",
"params": [
"creature: Creature"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/monster/monster_functions.cpp"
},
{
"name": "setForgeStack",
"params": [
"stack: number"
],
"return": "boolean",
"source": "src/lua/functions/creatures/monster/monster_functions.cpp"
},
{
"name": "setIdle",
"params": [
"idle: boolean"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/monster/monster_functions.cpp"
},
{
"name": "setMonsterForgeClassification",
"params": [
"classication: any"
],
"return": "boolean",
"source": "src/lua/functions/creatures/monster/monster_functions.cpp"
},
{
"name": "setName",
"params": [
"name: string",
"nameDescription?: string"
],
"return": "boolean",
"source": "src/lua/functions/creatures/monster/monster_functions.cpp"
},
{
"name": "setSpawnPosition",
"params": [
"interval: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/monster/monster_functions.cpp"
},
{
"name": "setTimeToChangeFiendish",
"params": [
"endTime: number"
],
"return": "boolean",
"source": "src/lua/functions/creatures/monster/monster_functions.cpp"
},
{
"name": "setType",
"params": [
"nameOrRaceId: number|string",
"restoreHealth: boolean"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/monster/monster_functions.cpp"
},
{
"name": "soulPit",
"params": [
"soulPit?: boolean"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/monster/monster_functions.cpp"
}
],
"MonsterSpell": [
{
"name": "castSound",
"params": [
"arg2?: any"
],
"return": "boolean|number",
"source": "src/lua/functions/creatures/monster/monster_spell_functions.cpp"
},
{
"name": "impactSound",
"params": [
"arg2?: any"
],
"return": "boolean|number",
"source": "src/lua/functions/creatures/monster/monster_spell_functions.cpp"
},
{
"name": "setAttackValue",
"params": [
"attack: number",
"skill: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/monster/monster_spell_functions.cpp"
},
{
"name": "setChance",
"params": [
"chance: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/monster/monster_spell_functions.cpp"
},
{
"name": "setCombatEffect",
"params": [
"effect: any"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/monster/monster_spell_functions.cpp"
},
{
"name": "setCombatLength",
"params": [
"length: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/monster/monster_spell_functions.cpp"
},
{
"name": "setCombatRadius",
"params": [
"radius: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/monster/monster_spell_functions.cpp"
},
{
"name": "setCombatShootEffect",
"params": [
"effect: any"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/monster/monster_spell_functions.cpp"
},
{
"name": "setCombatSpread",
"params": [
"spread: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/monster/monster_spell_functions.cpp"
},
{
"name": "setCombatType",
"params": [
"arg1: any"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/monster/monster_spell_functions.cpp"
},
{
"name": "setCombatValue",
"params": [
"min: number",
"max: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/monster/monster_spell_functions.cpp"
},
{
"name": "setConditionDamage",
"params": [
"min: number",
"max: number",
"start: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/monster/monster_spell_functions.cpp"
},
{
"name": "setConditionDuration",
"params": [
"duration: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/monster/monster_spell_functions.cpp"
},
{
"name": "setConditionSpeedChange",
"params": [
"speed: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/monster/monster_spell_functions.cpp"
},
{
"name": "setConditionTickInterval",
"params": [
"interval: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/monster/monster_spell_functions.cpp"
},
{
"name": "setConditionType",
"params": [
"type: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/monster/monster_spell_functions.cpp"
},
{
"name": "setInterval",
"params": [
"interval: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/monster/monster_spell_functions.cpp"
},
{
"name": "setNeedTarget",
"params": [
"value: boolean"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/monster/monster_spell_functions.cpp"
},
{
"name": "setOutfitItem",
"params": [
"effect: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/monster/monster_spell_functions.cpp"
},
{
"name": "setOutfitMonster",
"params": [
"effect: string"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/monster/monster_spell_functions.cpp"
},
{
"name": "setRange",
"params": [
"range: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/monster/monster_spell_functions.cpp"
},
{
"name": "setScriptName",
"params": [
"name: string"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/monster/monster_spell_functions.cpp"
},
{
"name": "setType",
"params": [
"type: string"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/monster/monster_spell_functions.cpp"
}
],
"MonsterType": [
{
"name": "BestiaryCharmsPoints",
"params": [
"arg2?: number"
],
"return": "boolean|number|nil",
"source": "src/lua/functions/creatures/monster/monster_type_functions.cpp"
},
{
"name": "BestiaryFirstUnlock",
"params": [
"arg2?: number"
],
"return": "boolean|number|nil",
"source": "src/lua/functions/creatures/monster/monster_type_functions.cpp"
},
{
"name": "BestiaryLocations",
"params": [
"arg2?: string"
],
"return": "boolean|string|nil",
"source": "src/lua/functions/creatures/monster/monster_type_functions.cpp"
},
{
"name": "BestiaryOccurrence",
"params": [
"arg2?: number"
],
"return": "boolean|number|nil",
"source": "src/lua/functions/creatures/monster/monster_type_functions.cpp"
},
{
"name": "BestiarySecondUnlock",
"params": [
"arg2?: number"
],
"return": "boolean|number|nil",
"source": "src/lua/functions/creatures/monster/monster_type_functions.cpp"
},
{
"name": "BestiaryStars",
"params": [
"arg2?: number"
],
"return": "boolean|number|nil",
"source": "src/lua/functions/creatures/monster/monster_type_functions.cpp"
},
{
"name": "Bestiaryclass",
"params": [
"arg2?: string"
],
"return": "boolean|string|nil",
"source": "src/lua/functions/creatures/monster/monster_type_functions.cpp"
},
{
"name": "Bestiaryrace",
"params": [
"race?: any"
],
"return": "boolean|number|nil",
"source": "src/lua/functions/creatures/monster/monster_type_functions.cpp"
},
{
"name": "BestiarytoKill",
"params": [
"arg2?: number"
],
"return": "boolean|number|nil",
"source": "src/lua/functions/creatures/monster/monster_type_functions.cpp"
},
{
"name": "addAttack",
"params": [
"monsterspell: MonsterSpell"
],
"return": "nil",
"source": "src/lua/functions/creatures/monster/monster_type_functions.cpp"
},
{
"name": "addDefense",
"params": [
"monsterspell: MonsterSpell"
],
"return": "nil",
"source": "src/lua/functions/creatures/monster/monster_type_functions.cpp"
},
{
"name": "addElement",
"params": [
"type: any",
"percent: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/monster/monster_type_functions.cpp"
},
{
"name": "addHealing",
"params": [
"type: any",
"percent: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/monster/monster_type_functions.cpp"
},
{
"name": "addLoot",
"params": [
"loot: Loot"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/monster/monster_type_functions.cpp"
},
{
"name": "addReflect",
"params": [
"type: any",
"percent: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/monster/monster_type_functions.cpp"
},
{
"name": "addSound",
"params": [
"soundId: SoundEffect"
],
"return": "boolean",
"source": "src/lua/functions/creatures/monster/monster_type_functions.cpp"
},
{
"name": "addSummon",
"params": [
"name: string",
"interval: number",
"chance: number",
"count?: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/monster/monster_type_functions.cpp"
},
{
"name": "addVoice",
"params": [
"sentence: string",
"interval: number",
"chance: number",
"yell: boolean"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/monster/monster_type_functions.cpp"
},
{
"name": "armor",
"params": [
"arg2?: number"
],
"return": "boolean|number|nil",
"source": "src/lua/functions/creatures/monster/monster_type_functions.cpp"
},
{
"name": "baseSpeed",
"params": [
"arg2?: number"
],
"return": "boolean|number|nil",
"source": "src/lua/functions/creatures/monster/monster_type_functions.cpp"
},
{
"name": "bossRace",
"params": [
"raceId?: number",
"class?: string"
],
"return": "boolean|string|nil",
"source": "src/lua/functions/creatures/monster/monster_type_functions.cpp"
},
{
"name": "bossRaceId",
"params": [
"raceId?: number"
],
"return": "boolean|number",
"source": "src/lua/functions/creatures/monster/monster_type_functions.cpp"
},
{
"name": "canPushCreatures",
"params": [
"arg2?: boolean"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/monster/monster_type_functions.cpp"
},
{
"name": "canPushItems",
"params": [
"arg2?: boolean"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/monster/monster_type_functions.cpp"
},
{
"name": "canSpawn",
"params": [
"pos: Position"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/monster/monster_type_functions.cpp"
},
{
"name": "canWalkOnEnergy",
"params": [
"arg2?: boolean"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/monster/monster_type_functions.cpp"
},
{
"name": "canWalkOnFire",
"params": [
"arg2?: boolean"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/monster/monster_type_functions.cpp"
},
{
"name": "canWalkOnPoison",
"params": [
"arg2?: boolean"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/monster/monster_type_functions.cpp"
},
{
"name": "changeTargetChance",
"params": [
"arg2?: number"
],
"return": "boolean|number|nil",
"source": "src/lua/functions/creatures/monster/monster_type_functions.cpp"
},
{
"name": "changeTargetSpeed",
"params": [
"arg2?: number"
],
"return": "boolean|number|nil",
"source": "src/lua/functions/creatures/monster/monster_type_functions.cpp"
},
{
"name": "combatImmunities",
"params": [
"immunity?: string"
],
"return": "boolean|table|nil",
"source": "src/lua/functions/creatures/monster/monster_type_functions.cpp"
},
{
"name": "conditionImmunities",
"params": [
"immunity?: string"
],
"return": "boolean|table|nil",
"source": "src/lua/functions/creatures/monster/monster_type_functions.cpp"
},
{
"name": "corpseId",
"params": [
"arg2?: number"
],
"return": "boolean|number|nil",
"source": "src/lua/functions/creatures/monster/monster_type_functions.cpp"
},
{
"name": "critChance",
"params": [
"arg2: number"
],
"return": "number|nil",
"source": "src/lua/functions/creatures/monster/monster_type_functions.cpp"
},
{
"name": "deathSound",
"params": [
"arg2?: any"
],
"return": "boolean|number",
"source": "src/lua/functions/creatures/monster/monster_type_functions.cpp"
},
{
"name": "defense",
"params": [
"arg2?: number"
],
"return": "boolean|number|nil",
"source": "src/lua/functions/creatures/monster/monster_type_functions.cpp"
},
{
"name": "enemyFactions",
"params": [
"faction?: any"
],
"return": "boolean|table|nil",
"source": "src/lua/functions/creatures/monster/monster_type_functions.cpp"
},
{
"name": "eventType",
"params": [
"event: any"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/monster/monster_type_functions.cpp"
},
{
"name": "experience",
"params": [
"arg2?: number"
],
"return": "boolean|number|nil",
"source": "src/lua/functions/creatures/monster/monster_type_functions.cpp"
},
{
"name": "faction",
"params": [
"arg2?: any"
],
"return": "boolean|number|nil",
"source": "src/lua/functions/creatures/monster/monster_type_functions.cpp"
},
{
"name": "familiar",
"params": [
"arg2?: boolean"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/monster/monster_type_functions.cpp"
},
{
"name": "getAttackList",
"params": [],
"return": "table|nil",
"source": "src/lua/functions/creatures/monster/monster_type_functions.cpp"
},
{
"name": "getCorpseId",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/creatures/monster/monster_type_functions.cpp"
},
{
"name": "getCreatureEvents",
"params": [],
"return": "table|nil",
"source": "src/lua/functions/creatures/monster/monster_type_functions.cpp"
},
{
"name": "getDefenseList",
"params": [],
"return": "table|nil",
"source": "src/lua/functions/creatures/monster/monster_type_functions.cpp"
},
{
"name": "getElementList",
"params": [],
"return": "table|nil",
"source": "src/lua/functions/creatures/monster/monster_type_functions.cpp"
},
{
"name": "getLoot",
"params": [],
"return": "nil",
"source": "src/lua/functions/creatures/monster/monster_type_functions.cpp"
},
{
"name": "getMonstersByBestiaryStars",
"params": [
"stars: any"
],
"return": "table",
"source": "src/lua/functions/creatures/monster/monster_type_functions.cpp"
},
{
"name": "getMonstersByRace",
"params": [
"race: any"
],
"return": "table",
"source": "src/lua/functions/creatures/monster/monster_type_functions.cpp"
},
{
"name": "getSounds",
"params": [],
"return": "table|nil",
"source": "src/lua/functions/creatures/monster/monster_type_functions.cpp"
},
{
"name": "getSummonList",
"params": [],
"return": "table|nil",
"source": "src/lua/functions/creatures/monster/monster_type_functions.cpp"
},
{
"name": "getTypeName",
"params": [],
"return": "string",
"source": "src/lua/functions/creatures/monster/monster_type_functions.cpp"
},
{
"name": "getVoices",
"params": [],
"return": "table|nil",
"source": "src/lua/functions/creatures/monster/monster_type_functions.cpp"
},
{
"name": "health",
"params": [
"arg2?: number"
],
"return": "boolean|number|nil",
"source": "src/lua/functions/creatures/monster/monster_type_functions.cpp"
},
{
"name": "isAttackable",
"params": [
"arg2?: boolean"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/monster/monster_type_functions.cpp"
},
{
"name": "isBlockable",
"params": [
"arg2?: boolean"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/monster/monster_type_functions.cpp"
},
{
"name": "isConvinceable",
"params": [
"arg2?: boolean"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/monster/monster_type_functions.cpp"
},
{
"name": "isForgeCreature",
"params": [
"arg2?: boolean"
],
"return": "boolean",
"source": "src/lua/functions/creatures/monster/monster_type_functions.cpp"
},
{
"name": "isHealthHidden",
"params": [
"arg2?: boolean"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/monster/monster_type_functions.cpp"
},
{
"name": "isHostile",
"params": [
"arg2?: boolean"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/monster/monster_type_functions.cpp"
},
{
"name": "isIllusionable",
"params": [
"arg2?: boolean"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/monster/monster_type_functions.cpp"
},
{
"name": "isPreyExclusive",
"params": [
"arg2?: boolean"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/monster/monster_type_functions.cpp"
},
{
"name": "isPreyable",
"params": [
"arg2?: boolean"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/monster/monster_type_functions.cpp"
},
{
"name": "isPushable",
"params": [
"arg2?: boolean"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/monster/monster_type_functions.cpp"
},
{
"name": "isRewardBoss",
"params": [
"arg2?: boolean"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/monster/monster_type_functions.cpp"
},
{
"name": "isSummonable",
"params": [
"arg2?: boolean"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/monster/monster_type_functions.cpp"
},
{
"name": "light",
"params": [
"arg2?: number",
"arg3?: number"
],
"return": "boolean|number|nil",
"source": "src/lua/functions/creatures/monster/monster_type_functions.cpp"
},
{
"name": "manaCost",
"params": [
"arg2?: number"
],
"return": "boolean|number|nil",
"source": "src/lua/functions/creatures/monster/monster_type_functions.cpp"
},
{
"name": "maxHealth",
"params": [
"arg2?: number"
],
"return": "boolean|number|nil",
"source": "src/lua/functions/creatures/monster/monster_type_functions.cpp"
},
{
"name": "maxSummons",
"params": [
"arg2?: number"
],
"return": "boolean|number|nil",
"source": "src/lua/functions/creatures/monster/monster_type_functions.cpp"
},
{
"name": "mitigation",
"params": [
"arg2?: number"
],
"return": "boolean|number",
"source": "src/lua/functions/creatures/monster/monster_type_functions.cpp"
},
{
"name": "name",
"params": [
"arg2?: string"
],
"return": "boolean|string|nil",
"source": "src/lua/functions/creatures/monster/monster_type_functions.cpp"
},
{
"name": "nameDescription",
"params": [
"arg2?: string"
],
"return": "boolean|string|nil",
"source": "src/lua/functions/creatures/monster/monster_type_functions.cpp"
},
{
"name": "onAppear",
"params": [
"callback: fun(monster: Monster, creature: Creature): boolean"
],
"return": "boolean",
"source": "src/lua/functions/creatures/monster/monster_type_functions.cpp"
},
{
"name": "onDisappear",
"params": [
"callback: fun(monster: Monster, creature: Creature): boolean"
],
"return": "boolean",
"source": "src/lua/functions/creatures/monster/monster_type_functions.cpp"
},
{
"name": "onMove",
"params": [
"callback: fun(monster: Monster, creature: Creature, oldPosition: Position, newPosition: Position): boolean"
],
"return": "boolean",
"source": "src/lua/functions/creatures/monster/monster_type_functions.cpp"
},
{
"name": "onPlayerAttack",
"params": [
"callback: fun(monster: Monster, attacker: Player): boolean"
],
"return": "boolean",
"source": "src/lua/functions/creatures/monster/monster_type_functions.cpp"
},
{
"name": "onSay",
"params": [
"callback: fun(monster: Monster, creature: Creature, type: integer, message: string): boolean"
],
"return": "boolean",
"source": "src/lua/functions/creatures/monster/monster_type_functions.cpp"
},
{
"name": "onSpawn",
"params": [
"callback: fun(monster: Monster, position: Position): boolean"
],
"return": "boolean",
"source": "src/lua/functions/creatures/monster/monster_type_functions.cpp"
},
{
"name": "onThink",
"params": [
"callback: fun(monster: Monster, interval: integer): boolean"
],
"return": "boolean",
"source": "src/lua/functions/creatures/monster/monster_type_functions.cpp"
},
{
"name": "outfit",
"params": [
"outfit?: any"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/monster/monster_type_functions.cpp"
},
{
"name": "race",
"params": [
"race?: string"
],
"return": "boolean|number|nil",
"source": "src/lua/functions/creatures/monster/monster_type_functions.cpp"
},
{
"name": "raceId",
"params": [
"arg2?: number"
],
"return": "boolean|number|nil",
"source": "src/lua/functions/creatures/monster/monster_type_functions.cpp"
},
{
"name": "registerEvent",
"params": [
"name: string"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/monster/monster_type_functions.cpp"
},
{
"name": "respawnTypeIsUnderground",
"params": [
"arg2?: any"
],
"return": "boolean|number|nil",
"source": "src/lua/functions/creatures/monster/monster_type_functions.cpp"
},
{
"name": "runHealth",
"params": [
"arg2?: number"
],
"return": "boolean|number|nil",
"source": "src/lua/functions/creatures/monster/monster_type_functions.cpp"
},
{
"name": "soundChance",
"params": [
"arg2?: number"
],
"return": "boolean|number",
"source": "src/lua/functions/creatures/monster/monster_type_functions.cpp"
},
{
"name": "soundSpeedTicks",
"params": [
"arg2?: number"
],
"return": "boolean|number",
"source": "src/lua/functions/creatures/monster/monster_type_functions.cpp"
},
{
"name": "staticAttackChance",
"params": [
"arg2?: number"
],
"return": "boolean|number|nil",
"source": "src/lua/functions/creatures/monster/monster_type_functions.cpp"
},
{
"name": "strategiesTargetDamage",
"params": [
"arg2?: number"
],
"return": "boolean|number|nil",
"source": "src/lua/functions/creatures/monster/monster_type_functions.cpp"
},
{
"name": "strategiesTargetHealth",
"params": [
"arg2?: number"
],
"return": "boolean|number|nil",
"source": "src/lua/functions/creatures/monster/monster_type_functions.cpp"
},
{
"name": "strategiesTargetNearest",
"params": [
"arg2?: number"
],
"return": "boolean|number|nil",
"source": "src/lua/functions/creatures/monster/monster_type_functions.cpp"
},
{
"name": "strategiesTargetRandom",
"params": [
"arg2?: number"
],
"return": "boolean|number|nil",
"source": "src/lua/functions/creatures/monster/monster_type_functions.cpp"
},
{
"name": "targetDistance",
"params": [
"arg2?: number"
],
"return": "boolean|number|nil",
"source": "src/lua/functions/creatures/monster/monster_type_functions.cpp"
},
{
"name": "targetPreferMaster",
"params": [
"arg2?: boolean"
],
"return": "boolean|number|nil",
"source": "src/lua/functions/creatures/monster/monster_type_functions.cpp"
},
{
"name": "targetPreferPlayer",
"params": [
"arg2?: boolean"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/monster/monster_type_functions.cpp"
},
{
"name": "variant",
"params": [
"arg2?: string"
],
"return": "boolean|string",
"source": "src/lua/functions/creatures/monster/monster_type_functions.cpp"
},
{
"name": "yellChance",
"params": [
"arg2?: number"
],
"return": "boolean|number|nil",
"source": "src/lua/functions/creatures/monster/monster_type_functions.cpp"
},
{
"name": "yellSpeedTicks",
"params": [
"arg2?: number"
],
"return": "boolean|number|nil",
"source": "src/lua/functions/creatures/monster/monster_type_functions.cpp"
}
],
"Mount": [
{
"name": "getClientId",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/creatures/player/mount_functions.cpp"
},
{
"name": "getId",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/creatures/player/mount_functions.cpp"
},
{
"name": "getName",
"params": [],
"return": "string|nil",
"source": "src/lua/functions/creatures/player/mount_functions.cpp"
},
{
"name": "getSpeed",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/creatures/player/mount_functions.cpp"
}
],
"MoveEvent": [
{
"name": "aid",
"params": [
"ids: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/events/move_event_functions.cpp"
},
{
"name": "id",
"params": [
"ids: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/events/move_event_functions.cpp"
},
{
"name": "level",
"params": [
"lvl: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/events/move_event_functions.cpp"
},
{
"name": "magicLevel",
"params": [
"lvl: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/events/move_event_functions.cpp"
},
{
"name": "onAddItem",
"params": [
"callback: fun(moveItem: Item, tileItemOrPosition: Item|Position, position?: Position): boolean"
],
"return": "boolean",
"source": "src/lua/functions/events/move_event_functions.cpp"
},
{
"name": "onDeEquip",
"params": [
"callback: fun(player: Player, item: Item, slot: integer, isCheck: boolean): boolean"
],
"return": "boolean",
"source": "src/lua/functions/events/move_event_functions.cpp"
},
{
"name": "onEquip",
"params": [
"callback: fun(player: Player, item: Item, slot: integer, isCheck: boolean): boolean"
],
"return": "boolean",
"source": "src/lua/functions/events/move_event_functions.cpp"
},
{
"name": "onRemoveItem",
"params": [
"callback: fun(moveItem: Item, tileItemOrPosition: Item|Position, position?: Position): boolean"
],
"return": "boolean",
"source": "src/lua/functions/events/move_event_functions.cpp"
},
{
"name": "onStepIn",
"params": [
"callback: fun(creature: Creature, item: Item|nil, position: Position, fromPosition: Position): boolean"
],
"return": "boolean",
"source": "src/lua/functions/events/move_event_functions.cpp"
},
{
"name": "onStepOut",
"params": [
"callback: fun(creature: Creature, item: Item|nil, position: Position, fromPosition: Position): boolean"
],
"return": "boolean",
"source": "src/lua/functions/events/move_event_functions.cpp"
},
{
"name": "position",
"params": [
"positions: Position"
],
"return": "boolean|nil",
"source": "src/lua/functions/events/move_event_functions.cpp"
},
{
"name": "premium",
"params": [
"value: boolean"
],
"return": "boolean|nil",
"source": "src/lua/functions/events/move_event_functions.cpp"
},
{
"name": "register",
"params": [],
"return": "boolean|nil",
"source": "src/lua/functions/events/move_event_functions.cpp"
},
{
"name": "slot",
"params": [
"slot: string"
],
"return": "boolean|nil",
"source": "src/lua/functions/events/move_event_functions.cpp"
},
{
"name": "type",
"params": [
"callback: string"
],
"return": "boolean|nil",
"source": "src/lua/functions/events/move_event_functions.cpp"
},
{
"name": "uid",
"params": [
"ids: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/events/move_event_functions.cpp"
},
{
"name": "vocation",
"params": [
"vocName: string",
"showInDescription?: boolean",
"lastVoc?: boolean"
],
"return": "boolean|nil",
"source": "src/lua/functions/events/move_event_functions.cpp"
}
],
"NetworkMessage": [
{
"name": "add16",
"params": [
"value: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/core/network/network_message_functions.cpp"
},
{
"name": "add32",
"params": [
"value: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/core/network/network_message_functions.cpp"
},
{
"name": "add64",
"params": [
"value: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/core/network/network_message_functions.cpp"
},
{
"name": "add8",
"params": [
"value: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/core/network/network_message_functions.cpp"
},
{
"name": "addByte",
"params": [
"value: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/core/network/network_message_functions.cpp"
},
{
"name": "addDouble",
"params": [
"value: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/core/network/network_message_functions.cpp"
},
{
"name": "addItem",
"params": [
"item: Item",
"player: Player"
],
"return": "boolean|nil",
"source": "src/lua/functions/core/network/network_message_functions.cpp"
},
{
"name": "addPosition",
"params": [
"position: Position"
],
"return": "boolean|nil",
"source": "src/lua/functions/core/network/network_message_functions.cpp"
},
{
"name": "addString",
"params": [
"value: string",
"callback: string"
],
"return": "boolean|nil",
"source": "src/lua/functions/core/network/network_message_functions.cpp"
},
{
"name": "addU16",
"params": [
"value: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/core/network/network_message_functions.cpp"
},
{
"name": "addU32",
"params": [
"value: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/core/network/network_message_functions.cpp"
},
{
"name": "addU64",
"params": [
"value: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/core/network/network_message_functions.cpp"
},
{
"name": "delete",
"params": [],
"return": "nil",
"source": "src/lua/functions/core/network/network_message_functions.cpp"
},
{
"name": "getByte",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/core/network/network_message_functions.cpp"
},
{
"name": "getPosition",
"params": [],
"return": "nil|Position",
"source": "src/lua/functions/core/network/network_message_functions.cpp"
},
{
"name": "getString",
"params": [],
"return": "string|nil",
"source": "src/lua/functions/core/network/network_message_functions.cpp"
},
{
"name": "getU16",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/core/network/network_message_functions.cpp"
},
{
"name": "getU32",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/core/network/network_message_functions.cpp"
},
{
"name": "getU64",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/core/network/network_message_functions.cpp"
},
{
"name": "getUnreadBytes",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/core/network/network_message_functions.cpp"
},
{
"name": "reset",
"params": [],
"return": "boolean|nil",
"source": "src/lua/functions/core/network/network_message_functions.cpp"
},
{
"name": "sendToPlayer",
"params": [
"player: Player"
],
"return": "boolean|nil",
"source": "src/lua/functions/core/network/network_message_functions.cpp"
},
{
"name": "skipBytes",
"params": [
"value: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/core/network/network_message_functions.cpp"
}
],
"Npc": [
{
"name": "closeShopWindow",
"params": [
"player: Player"
],
"return": "boolean",
"source": "src/lua/functions/creatures/npc/npc_functions.cpp"
},
{
"name": "follow",
"params": [
"player: Player"
],
"return": "boolean",
"source": "src/lua/functions/creatures/npc/npc_functions.cpp"
},
{
"name": "getCurrency",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/creatures/npc/npc_functions.cpp"
},
{
"name": "getDistanceTo",
"params": [
"uid: number"
],
"return": "boolean|number|nil",
"source": "src/lua/functions/creatures/npc/npc_functions.cpp"
},
{
"name": "getId",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/creatures/npc/npc_functions.cpp"
},
{
"name": "getName",
"params": [],
"return": "string|nil",
"source": "src/lua/functions/creatures/npc/npc_functions.cpp"
},
{
"name": "getShopItem",
"params": [
"itemId: number"
],
"return": "boolean",
"source": "src/lua/functions/creatures/npc/npc_functions.cpp"
},
{
"name": "getSpeechBubble",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/creatures/npc/npc_functions.cpp"
},
{
"name": "isInTalkRange",
"params": [
"position: Position",
"range?: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/npc/npc_functions.cpp"
},
{
"name": "isInteractingWithPlayer",
"params": [
"creature: Creature"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/npc/npc_functions.cpp"
},
{
"name": "isMerchant",
"params": [
"playerGUID: number"
],
"return": "boolean",
"source": "src/lua/functions/creatures/npc/npc_functions.cpp"
},
{
"name": "isNpc",
"params": [],
"return": "boolean",
"source": "src/lua/functions/creatures/npc/npc_functions.cpp"
},
{
"name": "isPlayerInteractingOnTopic",
"params": [
"creature: Creature",
"topicId: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/npc/npc_functions.cpp"
},
{
"name": "move",
"params": [
"direction: any"
],
"return": "nil",
"source": "src/lua/functions/creatures/npc/npc_functions.cpp"
},
{
"name": "openShopWindow",
"params": [
"player: Player"
],
"return": "boolean",
"source": "src/lua/functions/creatures/npc/npc_functions.cpp"
},
{
"name": "openShopWindowTable",
"params": [
"player: Player",
"items: table"
],
"return": "boolean",
"source": "src/lua/functions/creatures/npc/npc_functions.cpp"
},
{
"name": "place",
"params": [
"position: Position",
"extended?: boolean",
"force?: boolean"
],
"return": "nil|Npc",
"source": "src/lua/functions/creatures/npc/npc_functions.cpp"
},
{
"name": "removePlayerInteraction",
"params": [
"creature: Creature"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/npc/npc_functions.cpp"
},
{
"name": "say",
"params": [
"text: string",
"type?: any",
"ghost?: boolean",
"target?: Creature",
"position?: Position"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/npc/npc_functions.cpp"
},
{
"name": "sellItem",
"params": [
"player: Player",
"itemId: number",
"amount: number",
"subtype?: number",
"actionId?: number",
"ignoreCap?: boolean",
"inBackpacks?: boolean"
],
"return": "boolean",
"source": "src/lua/functions/creatures/npc/npc_functions.cpp"
},
{
"name": "setCurrency",
"params": [
"arg2: number"
],
"return": "boolean",
"source": "src/lua/functions/creatures/npc/npc_functions.cpp"
},
{
"name": "setMasterPos",
"params": [
"pos: Position"
],
"return": "boolean",
"source": "src/lua/functions/creatures/npc/npc_functions.cpp"
},
{
"name": "setName",
"params": [
"name: string"
],
"return": "nil",
"source": "src/lua/functions/creatures/npc/npc_functions.cpp"
},
{
"name": "setPlayerInteraction",
"params": [
"creature: Creature",
"topic: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/npc/npc_functions.cpp"
},
{
"name": "setSpeechBubble",
"params": [
"speechBubble: number"
],
"return": "nil",
"source": "src/lua/functions/creatures/npc/npc_functions.cpp"
},
{
"name": "turn",
"params": [
"direction: any"
],
"return": "nil",
"source": "src/lua/functions/creatures/npc/npc_functions.cpp"
},
{
"name": "turnToCreature",
"params": [
"creature: Creature",
"arg2: boolean"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/npc/npc_functions.cpp"
}
],
"NpcType": [
{
"name": "addShopItem",
"params": [
"shop: Shop"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/npc/npc_type_functions.cpp"
},
{
"name": "addSound",
"params": [
"soundId: SoundEffect"
],
"return": "boolean",
"source": "src/lua/functions/creatures/npc/npc_type_functions.cpp"
},
{
"name": "addVoice",
"params": [
"sentence: string",
"interval: number",
"chance: number",
"yell: boolean"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/npc/npc_type_functions.cpp"
},
{
"name": "baseSpeed",
"params": [
"arg2?: number"
],
"return": "boolean|number|nil",
"source": "src/lua/functions/creatures/npc/npc_type_functions.cpp"
},
{
"name": "canPushCreatures",
"params": [
"arg2?: boolean"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/npc/npc_type_functions.cpp"
},
{
"name": "canPushItems",
"params": [
"arg2?: boolean"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/npc/npc_type_functions.cpp"
},
{
"name": "canSpawn",
"params": [
"pos: Position"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/npc/npc_type_functions.cpp"
},
{
"name": "currency",
"params": [
"arg2?: number"
],
"return": "boolean|number",
"source": "src/lua/functions/creatures/npc/npc_type_functions.cpp"
},
{
"name": "eventType",
"params": [
"event: any"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/npc/npc_type_functions.cpp"
},
{
"name": "floorChange",
"params": [
"arg2?: boolean"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/npc/npc_type_functions.cpp"
},
{
"name": "getCreatureEvents",
"params": [],
"return": "table|nil",
"source": "src/lua/functions/creatures/npc/npc_type_functions.cpp"
},
{
"name": "getSounds",
"params": [],
"return": "table|nil",
"source": "src/lua/functions/creatures/npc/npc_type_functions.cpp"
},
{
"name": "getVoices",
"params": [],
"return": "table|nil",
"source": "src/lua/functions/creatures/npc/npc_type_functions.cpp"
},
{
"name": "health",
"params": [
"arg2?: number"
],
"return": "boolean|number|nil",
"source": "src/lua/functions/creatures/npc/npc_type_functions.cpp"
},
{
"name": "isPushable",
"params": [
"arg2?: boolean"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/npc/npc_type_functions.cpp"
},
{
"name": "light",
"params": [
"arg2?: number",
"arg3?: number"
],
"return": "boolean|number|nil",
"source": "src/lua/functions/creatures/npc/npc_type_functions.cpp"
},
{
"name": "maxHealth",
"params": [
"arg2?: number"
],
"return": "boolean|number|nil",
"source": "src/lua/functions/creatures/npc/npc_type_functions.cpp"
},
{
"name": "name",
"params": [
"arg2?: string"
],
"return": "boolean|string|nil",
"source": "src/lua/functions/creatures/npc/npc_type_functions.cpp"
},
{
"name": "nameDescription",
"params": [
"arg2?: string"
],
"return": "boolean|string|nil",
"source": "src/lua/functions/creatures/npc/npc_type_functions.cpp"
},
{
"name": "onAppear",
"params": [
"callback: fun(npc: Npc, creature: Creature): boolean"
],
"return": "boolean",
"source": "src/lua/functions/creatures/npc/npc_type_functions.cpp"
},
{
"name": "onBuyItem",
"params": [
"callback: fun(npc: Npc, player: Player, itemId: integer, subType: integer, amount: integer, ignore: boolean, inBackpacks: boolean, totalCost: integer): boolean"
],
"return": "boolean",
"source": "src/lua/functions/creatures/npc/npc_type_functions.cpp"
},
{
"name": "onCheckItem",
"params": [
"callback: fun(npc: Npc, player: Player, itemId: integer, subType: integer): boolean"
],
"return": "boolean",
"source": "src/lua/functions/creatures/npc/npc_type_functions.cpp"
},
{
"name": "onCloseChannel",
"params": [
"callback: fun(npc: Npc, player: Player): boolean"
],
"return": "boolean",
"source": "src/lua/functions/creatures/npc/npc_type_functions.cpp"
},
{
"name": "onDisappear",
"params": [
"callback: fun(npc: Npc, creature: Creature): boolean"
],
"return": "boolean",
"source": "src/lua/functions/creatures/npc/npc_type_functions.cpp"
},
{
"name": "onMove",
"params": [
"callback: fun(npc: Npc, creature: Creature, oldPosition: Position, newPosition: Position): boolean"
],
"return": "boolean",
"source": "src/lua/functions/creatures/npc/npc_type_functions.cpp"
},
{
"name": "onSay",
"params": [
"callback: fun(npc: Npc, creature: Creature, type: integer, message: string): boolean"
],
"return": "boolean",
"source": "src/lua/functions/creatures/npc/npc_type_functions.cpp"
},
{
"name": "onSellItem",
"params": [
"callback: fun(npc: Npc, player: Player, itemId: integer, subType: integer, amount: integer, ignore: boolean, itemName: string, totalCost: integer): boolean"
],
"return": "boolean",
"source": "src/lua/functions/creatures/npc/npc_type_functions.cpp"
},
{
"name": "onThink",
"params": [
"callback: fun(npc: Npc, interval: integer): boolean"
],
"return": "boolean",
"source": "src/lua/functions/creatures/npc/npc_type_functions.cpp"
},
{
"name": "outfit",
"params": [
"outfit?: any"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/npc/npc_type_functions.cpp"
},
{
"name": "registerEvent",
"params": [
"name: string"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/npc/npc_type_functions.cpp"
},
{
"name": "respawnTypeIsUnderground",
"params": [
"arg2?: any"
],
"return": "boolean|number|nil",
"source": "src/lua/functions/creatures/npc/npc_type_functions.cpp"
},
{
"name": "respawnTypePeriod",
"overloads": [
"fun(name: string): NpcType"
],
"params": [
"arg2?: any"
],
"return": "boolean|number|nil",
"source": "src/lua/functions/creatures/npc/npc_type_functions.cpp"
},
{
"name": "soundChance",
"params": [
"arg2?: number"
],
"return": "boolean|number",
"source": "src/lua/functions/creatures/npc/npc_type_functions.cpp"
},
{
"name": "soundSpeedTicks",
"params": [
"arg2?: number"
],
"return": "boolean|number",
"source": "src/lua/functions/creatures/npc/npc_type_functions.cpp"
},
{
"name": "speechBubble",
"params": [
"arg2?: number"
],
"return": "boolean|number",
"source": "src/lua/functions/creatures/npc/npc_type_functions.cpp"
},
{
"name": "walkInterval",
"params": [
"arg2?: number"
],
"return": "boolean|number|nil",
"source": "src/lua/functions/creatures/npc/npc_type_functions.cpp"
},
{
"name": "walkRadius",
"params": [
"arg2?: number"
],
"return": "boolean|number|nil",
"source": "src/lua/functions/creatures/npc/npc_type_functions.cpp"
},
{
"name": "yellChance",
"params": [
"arg2?: number"
],
"return": "boolean|number|nil",
"source": "src/lua/functions/creatures/npc/npc_type_functions.cpp"
},
{
"name": "yellSpeedTicks",
"params": [
"arg2?: number"
],
"return": "boolean|number|nil",
"source": "src/lua/functions/creatures/npc/npc_type_functions.cpp"
}
],
"Party": [
{
"name": "addInvite",
"params": [
"player: Player"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/party_functions.cpp"
},
{
"name": "addMember",
"params": [
"player: Player"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/party_functions.cpp"
},
{
"name": "disband",
"params": [],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/party_functions.cpp"
},
{
"name": "getInviteeCount",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/creatures/player/party_functions.cpp"
},
{
"name": "getInvitees",
"params": [],
"return": "Player[]|nil",
"source": "src/lua/functions/creatures/player/party_functions.cpp"
},
{
"name": "getLeader",
"params": [],
"return": "nil|Player",
"source": "src/lua/functions/creatures/player/party_functions.cpp"
},
{
"name": "getMemberCount",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/creatures/player/party_functions.cpp"
},
{
"name": "getMembers",
"params": [],
"return": "Player[]|nil",
"source": "src/lua/functions/creatures/player/party_functions.cpp"
},
{
"name": "getUniqueVocationsCount",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/creatures/player/party_functions.cpp"
},
{
"name": "isSharedExperienceActive",
"params": [],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/party_functions.cpp"
},
{
"name": "isSharedExperienceEnabled",
"params": [],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/party_functions.cpp"
},
{
"name": "removeInvite",
"params": [
"player: Player"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/party_functions.cpp"
},
{
"name": "removeMember",
"params": [
"player: Player"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/party_functions.cpp"
},
{
"name": "setLeader",
"params": [
"player: Player"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/party_functions.cpp"
},
{
"name": "setSharedExperience",
"params": [
"active: boolean"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/party_functions.cpp"
},
{
"name": "shareExperience",
"params": [
"experience: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/party_functions.cpp"
}
],
"Player": [
{
"name": "addAchievement",
"params": [
"idOrName: number|string",
"sendMessage?: boolean"
],
"return": "boolean",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "addAchievementPoints",
"params": [
"amount: number"
],
"return": "boolean",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "addAnimusMastery",
"params": [
"monsterType: string"
],
"return": "nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "addBadge",
"params": [
"id: number"
],
"return": "boolean",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "addBestiaryKill",
"params": [
"name: string",
"amount?: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "addBlessing",
"params": [
"blessing: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "addBosstiaryKill",
"params": [
"name: string",
"amount?: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "addCharmPoints",
"params": [
"charms: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "addCustomOutfit",
"params": [
"type: string",
"idOrName: number|string"
],
"return": "boolean",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "addExperience",
"params": [
"experience: number",
"sendText?: boolean"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "addFamiliar",
"params": [
"lookType: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "addForgeDustLevel",
"params": [
"amount: number"
],
"return": "boolean",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "addForgeDusts",
"params": [
"amount: number"
],
"return": "boolean",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "addItem",
"params": [
"itemId: number|string",
"count?: number",
"canDropOnMap?: boolean",
"subType?: number",
"slot?: number",
"tier?: number"
],
"return": "Item|Item[]|nil|false",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "addItemBatchToPaginedContainer",
"params": [
"container: Container",
"itemId: number",
"count: number",
"tier: number",
"flags: number"
],
"return": "number|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "addItemEx",
"overloads": [
"fun(item: Item, canDropOnMap?: false, index?: integer, flags?: integer): integer|false|nil",
"fun(item: Item, canDropOnMap: true, slot?: integer): integer|false|nil"
],
"params": [
"item: Item",
"canDropOnMap?: boolean",
"indexOrSlot?: integer",
"flags?: integer"
],
"return": "integer|false|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "addItemStash",
"params": [
"itemId: number",
"count: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "addMana",
"params": [
"manaChange: number",
"animationOnLoss?: boolean"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "addManaSpent",
"params": [
"amount: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "addMapMark",
"params": [
"position: Position",
"type: number",
"description: string"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "addMinorCharmEchoes",
"params": [
"charms: number"
],
"return": "boolean",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "addMoney",
"params": [
"money: number",
"flags?: number"
],
"return": "boolean|number|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "addMount",
"params": [
"mountIdOrMountName: number|string"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "addOfflineTrainingTime",
"params": [
"time: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "addOfflineTrainingTries",
"params": [
"skillType: any",
"tries: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "addOutfit",
"params": [
"lookTypeOrName: number|string",
"addon: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "addOutfitAddon",
"params": [
"lookType: number",
"addon: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "addPremiumDays",
"params": [
"days: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "addPreyCards",
"params": [
"amount: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "addSkillTries",
"params": [
"skillType: any",
"tries: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "addSoul",
"params": [
"soulChange: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "addTaskHuntingPoints",
"params": [
"amount: number"
],
"return": "number|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "addTibiaCoins",
"params": [
"coins: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "addTitle",
"params": [
"id: number"
],
"return": "boolean",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "addTransferableCoins",
"params": [
"coins: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "addWeaponExperience",
"params": [
"experience: number",
"itemId: number"
],
"return": "boolean",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "applyImbuementScroll",
"params": [
"item: Item",
"scrollItem: Item"
],
"return": "boolean",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "avatarTimer",
"params": [
"value?: number"
],
"return": "boolean|number|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "calculateFlatDamageHealing",
"params": [],
"return": "number",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "canCast",
"params": [
"spell: any"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "canLearnSpell",
"params": [
"spellName: string"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "canReceiveLoot",
"params": [],
"return": "boolean",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "changeName",
"params": [
"newName: string"
],
"return": "boolean",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "channelSay",
"params": [
"speaker: Creature",
"type: any",
"text: string",
"channelId: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "charmExpansion",
"params": [
"arg2?: boolean"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "clearAllImbuements",
"params": [
"item: Item"
],
"return": "boolean",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "clearSpellCooldowns",
"params": [
"spenders: boolean",
"builder: boolean"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "closeForge",
"params": [],
"return": "boolean",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "closeImbuementWindow",
"params": [],
"return": "boolean",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "createTransactionSummary",
"params": [
"type: number",
"amount: number",
"id?: string"
],
"return": "boolean",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "fillHarmony",
"params": [],
"return": "boolean",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "forgetSpell",
"params": [
"spellName: string"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getAccountId",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getAccountType",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getAchievementPoints",
"params": [],
"return": "number",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getBackpack",
"params": [],
"return": "nil|Container",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getBankBalance",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getBaseMagicLevel",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getBaseMaxHealth",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getBaseMaxMana",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getBaseXpGain",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getBlessingCount",
"params": [
"index: number",
"storeCount?: boolean"
],
"return": "number|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getBossBonus",
"params": [
"slotId: number"
],
"return": "boolean|number",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getBosstiaryKills",
"params": [
"name: string"
],
"return": "number|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getBosstiaryLevel",
"params": [
"name: string"
],
"return": "number|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getCapacity",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getCharmChance",
"params": [
"charmId: any"
],
"return": "number",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getCharmMonsterType",
"params": [
"arg1: any"
],
"return": "nil|MonsterType",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getCharmTier",
"params": [
"charmId: any"
],
"return": "number",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getClient",
"params": [],
"return": "table|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getContainerById",
"params": [
"id: number"
],
"return": "nil|Container",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getContainerId",
"params": [
"container: Container"
],
"return": "number|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getContainerIndex",
"params": [
"id: number"
],
"return": "number|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getDeathPenalty",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getDepotChest",
"params": [
"depotId: number",
"autoCreate?: boolean"
],
"return": "boolean|nil|Item",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getDepotLocker",
"params": [
"depotId: number"
],
"return": "boolean|nil|Item",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getEffectiveSkillLevel",
"params": [
"skillType: any"
],
"return": "number|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getExperience",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getFaction",
"params": [],
"return": "boolean|number",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getFamiliarLooktype",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getFightMode",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getForgeCores",
"params": [],
"return": "boolean|number",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getForgeDustLevel",
"params": [],
"return": "boolean|number",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getForgeDusts",
"params": [],
"return": "boolean|number",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getForgeSlivers",
"params": [],
"return": "boolean|number",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getFreeBackpackSlots",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getFreeCapacity",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getGrindingXpBoost",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getGroup",
"params": [],
"return": "nil|Group",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getGuid",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getGuild",
"params": [],
"return": "nil|Guild",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getGuildLevel",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getGuildNick",
"params": [],
"return": "string|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getHarmony",
"params": [],
"return": "number",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getHarmonyDamage",
"params": [
"baseMin: integer",
"baseMax: integer"
],
"return": "integer min, integer max",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getHazardSystemPoints",
"params": [],
"return": "boolean|number",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getHouse",
"params": [],
"return": "nil|House",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getIdleTime",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getInbox",
"params": [],
"return": "boolean|nil|Item",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getInstantSpells",
"params": [],
"return": "table|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getIp",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getItemById",
"params": [
"itemId: number|string",
"deepSearch: boolean",
"subType?: number"
],
"return": "nil|Item",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getItemCount",
"params": [
"itemId: number|string",
"subType?: number"
],
"return": "number|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getKills",
"params": [],
"return": "table|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getLastLoginSaved",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getLastLogout",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getLevel",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getLivestreamViewers",
"params": [],
"return": "string|table|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getLivestreamViewersCount",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getLootPouch",
"params": [],
"return": "nil|Container",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getLoyaltyBonus",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getLoyaltyPoints",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getLoyaltyTitle",
"params": [],
"return": "string|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getMagicLevel",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getMagicShieldCapacityFlat",
"params": [
"useCharges: boolean"
],
"return": "number|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getMagicShieldCapacityPercent",
"params": [
"useCharges: boolean"
],
"return": "number|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getMana",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getManaSpent",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getMapShader",
"params": [],
"return": "boolean|string",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getMaxMana",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getMaxSoul",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getMoney",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getName",
"params": [],
"return": "boolean|string",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getOfflineTrainingSkill",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getOfflineTrainingTime",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getParty",
"params": [],
"return": "nil|Party",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getPremiumDays",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getPreyCards",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getPreyExperiencePercentage",
"params": [
"raceId: number"
],
"return": "number|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getPreyLootPercentage",
"params": [
"raceId: number"
],
"return": "number|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getPronoun",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getPvpMode",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getReward",
"params": [
"rewardId: number",
"autoCreate?: boolean"
],
"return": "boolean|nil|Item",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getRewardList",
"params": [],
"return": "table|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getSex",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getSkillLevel",
"params": [
"skillType: any"
],
"return": "number|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getSkillPercent",
"params": [
"skillType: any"
],
"return": "number|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getSkillTries",
"params": [
"skillType: any"
],
"return": "number|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getSkullTime",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getSlotBossId",
"params": [
"slotId: number"
],
"return": "boolean|number",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getSlotItem",
"params": [
"slot: number"
],
"return": "nil|Item",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getSoul",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getStamina",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getStaminaXpBoost",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getStashCount",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getStashItemCount",
"params": [
"itemId: number|string"
],
"return": "number|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getStorageValue",
"params": [
"key: number"
],
"return": "number|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getStoreInbox",
"params": [],
"return": "boolean|nil|Item",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getTaskHuntingPoints",
"params": [],
"return": "boolean|number",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getTibiaCoins",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getTitles",
"params": [],
"return": "table",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getTown",
"params": [],
"return": "nil|Town",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getTransferableCoins",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getVipDays",
"params": [],
"return": "boolean|number",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getVipTime",
"params": [],
"return": "boolean|number",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getVirtue",
"params": [],
"return": "number",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getVocation",
"params": [],
"return": "nil|Vocation",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getVoucherXpBoost",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getWheelSpellAdditionalArea",
"params": [
"spellname: string"
],
"return": "boolean",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getWheelSpellAdditionalDuration",
"params": [
"spellname: string"
],
"return": "boolean|number",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getWheelSpellAdditionalTarget",
"params": [
"spellname: string"
],
"return": "boolean|number",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getXpBoostPercent",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "getXpBoostTime",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "hasAchievement",
"params": [
"idOrName: number|string"
],
"return": "boolean",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "hasAnimusMastery",
"params": [
"monsterType: string"
],
"return": "boolean",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "hasAttacked",
"params": [
"targetPlayer: Player"
],
"return": "boolean",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "hasBlessing",
"params": [
"blessing: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "hasChaseMode",
"params": [],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "hasFamiliar",
"params": [
"lookType: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "hasGroupFlag",
"params": [
"flag: any"
],
"return": "boolean",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "hasLearnedSpell",
"params": [
"spellName: string"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "hasMount",
"params": [
"mountIdOrMountName: number|string"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "hasOutfit",
"params": [
"lookType: number",
"addon?: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "hasSecureMode",
"params": [],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "instantSkillWOD",
"params": [
"name: string",
"value?: boolean"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "isLivestreamViewer",
"params": [],
"return": "boolean",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "isMonsterBestiaryUnlocked",
"params": [
"raceId: number"
],
"return": "boolean",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "isMonsterPrey",
"params": [
"raceId: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "isOffline",
"params": [],
"return": "boolean",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "isPlayer",
"params": [],
"return": "boolean",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "isPromoted",
"params": [],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "isPzLocked",
"params": [],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "isTraining",
"params": [],
"return": "boolean|number",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "isUIExhausted",
"params": [
"time: number"
],
"return": "boolean",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "isVip",
"params": [],
"return": "boolean",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "kv",
"params": [],
"return": "boolean|KV",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "learnSpell",
"params": [
"spellName: string"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "onThinkWheelOfDestiny",
"params": [
"force?: boolean"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "openChannel",
"params": [
"channelId: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "openForge",
"params": [],
"return": "boolean",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "openImbuementWindow",
"params": [
"action?: any",
"item?: Item"
],
"return": "boolean",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "openMarket",
"params": [],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "openStash",
"params": [
"isNpc: boolean"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "popupFYI",
"params": [
"message: string"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "preyThirdSlot",
"params": [
"arg2?: boolean"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "reloadData",
"params": [],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "removeAchievement",
"params": [
"idOrName: number|string"
],
"return": "boolean",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "removeAchievementPoints",
"params": [
"amount: number"
],
"return": "boolean",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "removeAnimusMastery",
"params": [
"monsterType: string"
],
"return": "nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "removeBlessing",
"params": [
"blessing: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "removeCustomOutfit",
"params": [
"type: string",
"idOrName: number|string"
],
"return": "boolean",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "removeExperience",
"params": [
"experience: number",
"sendText?: boolean"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "removeFamiliar",
"params": [
"lookType: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "removeForgeDustLevel",
"params": [
"amount: number"
],
"return": "boolean",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "removeForgeDusts",
"params": [
"amount: number"
],
"return": "boolean",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "removeGroupFlag",
"params": [
"flag: any"
],
"return": "boolean",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "removeIconBakragore",
"params": [
"iconType?: any"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "removeItem",
"params": [
"itemId: number|string",
"count: number",
"subType?: number",
"ignoreEquipped?: boolean"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "removeMoney",
"params": [
"money: number",
"flags?: number",
"useBank?: boolean"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "removeMount",
"params": [
"mountIdOrMountName: number|string"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "removeOfflineTrainingTime",
"params": [
"time: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "removeOutfit",
"params": [
"lookType: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "removeOutfitAddon",
"params": [
"lookType: number",
"addon: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "removePremiumDays",
"params": [
"days: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "removePreyStamina",
"params": [
"amount: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "removeReward",
"params": [
"rewardId: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "removeStashItem",
"params": [
"itemId: number|string",
"count: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "removeTaskHuntingPoints",
"params": [
"amount: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "removeTibiaCoins",
"params": [
"coins: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "removeTransferableAndTibiaCoins",
"params": [
"coins: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "removeTransferableCoins",
"params": [
"coins: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "resetCharmsBestiary",
"params": [],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "resetOldCharms",
"params": [],
"return": "boolean",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "revelationStageWOD",
"params": [
"name?: string",
"set?: boolean|number"
],
"return": "boolean|number|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "save",
"params": [],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "sendAmbientSoundEffect",
"params": [
"id: any"
],
"return": "boolean",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "sendBlessStatus",
"params": [],
"return": "boolean",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "sendBosstiaryCooldownTimer",
"params": [],
"return": "boolean",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "sendChannelMessage",
"params": [
"author: string",
"text: string",
"type: any",
"channelId: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "sendContainer",
"params": [
"container: Container"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "sendCreatureAppear",
"params": [
"isLogin: boolean"
],
"return": "boolean",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "sendDoubleSoundEffect",
"params": [
"mainSoundId: SoundEffect",
"secondarySoundId: SoundEffect",
"actor?: boolean"
],
"return": "boolean",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "sendHouseWindow",
"params": [
"house: House",
"listId: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "sendIconBakragore",
"params": [
"iconType: any"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "sendInventory",
"params": [],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "sendLootStats",
"params": [
"item: Item",
"count: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "sendMusicSoundEffect",
"params": [
"id: any"
],
"return": "boolean",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "sendOutfitWindow",
"params": [],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "sendPrivateMessage",
"params": [
"speaker: Player",
"text: string",
"type?: any"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "sendSingleSoundEffect",
"params": [
"soundId: SoundEffect",
"actor?: boolean"
],
"return": "boolean",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "sendSpellCooldown",
"params": [
"spellId: number",
"time: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "sendSpellGroupCooldown",
"params": [
"groupId: any",
"time: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "sendTextMessage",
"params": [
"type: any",
"text: string",
"position?: number|Position",
"primaryValue?: number",
"primaryColor?: any",
"secondaryValue?: number",
"secondaryColor?: any"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "sendTutorial",
"params": [
"tutorialId: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "sendUpdateContainer",
"params": [
"container: Container"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "setAccountType",
"params": [
"accountType: any"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "setBankBalance",
"params": [
"bankBalance: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "setBaseXpGain",
"params": [
"value: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "setBossPoints",
"params": [
"arg2: number"
],
"return": "boolean",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "setCapacity",
"params": [
"capacity: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "setCurrentTitle",
"params": [
"id: number"
],
"return": "boolean",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "setDailyReward",
"params": [
"value: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "setEditHouse",
"params": [
"house: House",
"listId: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "setFaction",
"params": [
"factionId: any"
],
"return": "boolean",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "setFamiliarLooktype",
"params": [
"lookType: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "setForgeDusts",
"params": [
"arg2: number"
],
"return": "boolean",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "setGhostMode",
"params": [
"enabled: boolean"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "setGrindingXpBoost",
"params": [
"value: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "setGroup",
"params": [
"group: Group"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "setGroupFlag",
"params": [
"flag: any"
],
"return": "boolean",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "setGuild",
"params": [
"guild: Guild"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "setGuildLevel",
"params": [
"level: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "setGuildNick",
"params": [
"nick: string"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "setHazardSystemPoints",
"params": [
"amount: number"
],
"return": "boolean",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "setKills",
"params": [
"kills: any"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "setLevel",
"params": [
"level: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "setLivestreamViewers",
"params": [
"data: table"
],
"return": "boolean",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "setLoyaltyBonus",
"params": [
"amount: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "setLoyaltyTitle",
"params": [
"name: string"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "setMagicLevel",
"params": [
"level: number",
"manaSpent?: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "setMapShader",
"params": [
"shaderName: string",
"temporary?: any"
],
"return": "boolean",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "setMaxMana",
"params": [
"maxMana: number"
],
"return": "boolean",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "setOfflineTrainingSkill",
"params": [
"skillId: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "setPronoun",
"params": [
"newPronoun: any"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "setRemoveBossTime",
"params": [
"arg2: number"
],
"return": "boolean",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "setSerene",
"params": [
"value: boolean",
"ticks: number"
],
"return": "boolean",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "setSex",
"params": [
"newSex: any"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "setSkillLevel",
"params": [
"skillType: any",
"level: number",
"tries?: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "setSkullTime",
"params": [
"skullTime: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "setSpecialContainersAvailable",
"params": [
"stashMenu: boolean",
"marketMenu: boolean",
"depotSearchMenu: boolean"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "setSpeed",
"params": [
"speed: number"
],
"return": "boolean",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "setStamina",
"params": [
"stamina: number"
],
"return": "nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "setStaminaXpBoost",
"params": [
"value: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "setStorageValue",
"params": [
"key: number",
"value: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "setTown",
"params": [
"town: Town"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "setTraining",
"params": [
"value: boolean"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "setVirtue",
"params": [
"virtue: any"
],
"return": "boolean",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "setVocation",
"params": [
"idOrNameOrUserdata: number|string|Vocation"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "setVoucherXpBoost",
"params": [
"value: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "setXpBoostPercent",
"params": [
"value: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "setXpBoostTime",
"params": [
"timeLeft: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "showTextDialog",
"params": [
"idOrNameOrUserdata: number|string|Item",
"text?: string",
"canWrite?: boolean",
"length?: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "takeScreenshot",
"params": [
"screenshotType: any",
"skillId?: number",
"skillLevel?: number",
"achievementName?: string",
"raceId?: number",
"bestiaryStep?: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "taskHuntingThirdSlot",
"params": [
"arg2?: boolean"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "unlockAllCharmRunes",
"params": [],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "updateConcoction",
"params": [
"itemId: number",
"timeLeft: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "updateFood",
"params": [
"itemId: number",
"timeLeft: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "updateKillTracker",
"params": [
"creature: Creature",
"corpse: Container"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "updateSupplyTracker",
"params": [
"item: Item"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "updateUIExhausted",
"params": [
"exhaustionTime: number"
],
"return": "boolean",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "upgradeSpellsWOD",
"params": [
"name?: string",
"add?: boolean"
],
"return": "boolean|number|nil",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
},
{
"name": "wheelUnlockScroll",
"params": [
"scrollName: string"
],
"return": "boolean",
"source": "src/lua/functions/creatures/player/player_functions.cpp"
}
],
"Position": [
{
"name": "getDistance",
"params": [
"positionEx: Position"
],
"return": "number",
"source": "src/lua/functions/map/position_functions.cpp"
},
{
"name": "getPathTo",
"params": [
"pos: Position",
"minTargetDist?: number",
"maxTargetDist?: number",
"fullPathSearch?: boolean",
"clearSight?: boolean",
"maxSearchDist?: number"
],
"return": "boolean|table",
"source": "src/lua/functions/map/position_functions.cpp"
},
{
"name": "getTile",
"params": [],
"return": "nil|Tile",
"source": "src/lua/functions/map/position_functions.cpp"
},
{
"name": "getZones",
"params": [],
"return": "table|nil",
"source": "src/lua/functions/map/position_functions.cpp"
},
{
"name": "isSightClear",
"params": [
"positionEx: Position",
"sameFloor?: boolean"
],
"return": "boolean",
"source": "src/lua/functions/map/position_functions.cpp"
},
{
"name": "removeMagicEffect",
"params": [
"magicEffect: MagicEffect",
"player?: Player"
],
"return": "boolean",
"source": "src/lua/functions/map/position_functions.cpp"
},
{
"name": "sendDistanceEffect",
"params": [
"positionEx: Position",
"distanceEffect: DistanceEffect",
"player?: Player"
],
"return": "boolean",
"source": "src/lua/functions/map/position_functions.cpp"
},
{
"name": "sendDoubleSoundEffect",
"params": [
"mainSoundId: SoundEffect",
"secondarySoundId: SoundEffect",
"actor?: Creature"
],
"return": "boolean",
"source": "src/lua/functions/map/position_functions.cpp"
},
{
"name": "sendMagicEffect",
"params": [
"magicEffect: MagicEffect",
"player?: Player"
],
"return": "boolean",
"source": "src/lua/functions/map/position_functions.cpp"
},
{
"name": "sendSingleSoundEffect",
"params": [
"soundId: SoundEffect",
"actor?: Creature"
],
"return": "boolean",
"source": "src/lua/functions/map/position_functions.cpp"
},
{
"name": "toString",
"params": [],
"return": "string",
"source": "src/lua/functions/map/position_functions.cpp"
}
],
"Result": [
{
"name": "free",
"params": [
"resultId: number"
],
"return": "boolean",
"source": "src/lua/functions/core/libs/result_functions.cpp"
},
{
"name": "getNumber",
"params": [
"resultId: number",
"column: string"
],
"return": "number|false",
"source": "src/lua/functions/core/libs/result_functions.cpp"
},
{
"name": "getStream",
"params": [
"resultId: number",
"column: string"
],
"return": "string|false stream, number? length",
"source": "src/lua/functions/core/libs/result_functions.cpp"
},
{
"name": "getString",
"params": [
"resultId: number",
"column: string"
],
"return": "string|false",
"source": "src/lua/functions/core/libs/result_functions.cpp"
},
{
"name": "next",
"params": [
"resultId: number"
],
"return": "boolean",
"source": "src/lua/functions/core/libs/result_functions.cpp"
}
],
"Shop": [
{
"name": "addChildShop",
"params": [
"shop: Shop"
],
"return": "nil",
"source": "src/lua/functions/creatures/npc/shop_functions.cpp"
},
{
"name": "setBuyPrice",
"params": [
"price: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/npc/shop_functions.cpp"
},
{
"name": "setCount",
"params": [
"count: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/npc/shop_functions.cpp"
},
{
"name": "setId",
"params": [
"id: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/npc/shop_functions.cpp"
},
{
"name": "setIdFromName",
"params": [
"name: string"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/npc/shop_functions.cpp"
},
{
"name": "setNameItem",
"params": [
"name: string"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/npc/shop_functions.cpp"
},
{
"name": "setSellPrice",
"params": [
"chance: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/npc/shop_functions.cpp"
},
{
"name": "setStorageKey",
"params": [
"storage: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/npc/shop_functions.cpp"
},
{
"name": "setStorageValue",
"params": [
"value: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/npc/shop_functions.cpp"
}
],
"Spdlog": [
{
"name": "debug",
"params": [
"text: string"
],
"return": "nil",
"source": "src/lua/functions/core/libs/logger_functions.cpp"
},
{
"name": "error",
"params": [
"text: string"
],
"return": "nil",
"source": "src/lua/functions/core/libs/logger_functions.cpp"
},
{
"name": "info",
"params": [
"text: string"
],
"return": "nil",
"source": "src/lua/functions/core/libs/logger_functions.cpp"
},
{
"name": "warn",
"params": [
"text: string"
],
"return": "nil",
"source": "src/lua/functions/core/libs/logger_functions.cpp"
}
],
"Spell": [
{
"name": "allowFarUse",
"params": [
"value?: boolean"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/combat/spell_functions.cpp"
},
{
"name": "allowOnSelf",
"params": [
"value?: boolean"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/combat/spell_functions.cpp"
},
{
"name": "blockWalls",
"params": [
"value?: boolean"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/combat/spell_functions.cpp"
},
{
"name": "castSound",
"params": [
"arg2?: number"
],
"return": "boolean|number|nil",
"source": "src/lua/functions/creatures/combat/spell_functions.cpp"
},
{
"name": "charges",
"params": [
"charges?: number"
],
"return": "boolean|number|nil",
"source": "src/lua/functions/creatures/combat/spell_functions.cpp"
},
{
"name": "checkFloor",
"params": [
"value?: boolean"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/combat/spell_functions.cpp"
},
{
"name": "cooldown",
"params": [
"cooldown?: number"
],
"return": "boolean|number|nil",
"source": "src/lua/functions/creatures/combat/spell_functions.cpp"
},
{
"name": "group",
"params": [
"primaryGroup?: string",
"secondaryGroup?: string"
],
"return": "boolean|number|nil",
"source": "src/lua/functions/creatures/combat/spell_functions.cpp"
},
{
"name": "groupCooldown",
"params": [
"primaryGroupCd?: number",
"secondaryGroupCd?: number"
],
"return": "boolean|number|nil",
"source": "src/lua/functions/creatures/combat/spell_functions.cpp"
},
{
"name": "hasParams",
"params": [
"value?: boolean"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/combat/spell_functions.cpp"
},
{
"name": "hasPlayerNameParam",
"params": [
"value?: boolean"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/combat/spell_functions.cpp"
},
{
"name": "id",
"params": [
"id?: number"
],
"return": "boolean|number|nil",
"source": "src/lua/functions/creatures/combat/spell_functions.cpp"
},
{
"name": "impactSound",
"params": [
"arg2?: number"
],
"return": "boolean|number|nil",
"source": "src/lua/functions/creatures/combat/spell_functions.cpp"
},
{
"name": "isAggressive",
"params": [
"value?: boolean"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/combat/spell_functions.cpp"
},
{
"name": "isBlocking",
"params": [
"blockingSolid?: boolean",
"blockingCreature?: boolean"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/combat/spell_functions.cpp"
},
{
"name": "isBlockingWalls",
"params": [
"value?: boolean"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/combat/spell_functions.cpp"
},
{
"name": "isEnabled",
"params": [
"value?: boolean"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/combat/spell_functions.cpp"
},
{
"name": "isPremium",
"params": [
"value?: boolean"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/combat/spell_functions.cpp"
},
{
"name": "isSelfTarget",
"params": [
"value?: boolean"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/combat/spell_functions.cpp"
},
{
"name": "level",
"params": [
"lvl?: number"
],
"return": "boolean|number|nil",
"source": "src/lua/functions/creatures/combat/spell_functions.cpp"
},
{
"name": "magicLevel",
"params": [
"lvl?: number"
],
"return": "boolean|number|nil",
"source": "src/lua/functions/creatures/combat/spell_functions.cpp"
},
{
"name": "mana",
"params": [
"mana?: number"
],
"return": "boolean|number|nil",
"source": "src/lua/functions/creatures/combat/spell_functions.cpp"
},
{
"name": "manaPercent",
"params": [
"percent?: number"
],
"return": "boolean|number|nil",
"source": "src/lua/functions/creatures/combat/spell_functions.cpp"
},
{
"name": "monkSpellType",
"params": [
"type?: number"
],
"return": "boolean|number|nil",
"source": "src/lua/functions/creatures/combat/spell_functions.cpp"
},
{
"name": "name",
"params": [
"name?: string"
],
"return": "boolean|string|nil",
"source": "src/lua/functions/creatures/combat/spell_functions.cpp"
},
{
"name": "needCasterTargetOrDirection",
"params": [
"value?: boolean"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/combat/spell_functions.cpp"
},
{
"name": "needDirection",
"params": [
"value?: boolean"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/combat/spell_functions.cpp"
},
{
"name": "needLearn",
"params": [
"value?: boolean"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/combat/spell_functions.cpp"
},
{
"name": "needTarget",
"params": [
"value?: boolean"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/combat/spell_functions.cpp"
},
{
"name": "needWeapon",
"params": [
"value?: boolean"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/combat/spell_functions.cpp"
},
{
"name": "onCastSpell",
"params": [
"callback: fun(creature: Creature, variant: Variant, isHotkey?: boolean): boolean"
],
"return": "boolean",
"source": "src/lua/functions/creatures/combat/spell_functions.cpp"
},
{
"name": "range",
"params": [
"range?: number"
],
"return": "boolean|number|nil",
"source": "src/lua/functions/creatures/combat/spell_functions.cpp"
},
{
"name": "register",
"params": [],
"return": "boolean",
"source": "src/lua/functions/creatures/combat/spell_functions.cpp"
},
{
"name": "runeId",
"params": [
"id?: number"
],
"return": "boolean|number|nil",
"source": "src/lua/functions/creatures/combat/spell_functions.cpp"
},
{
"name": "setPzLocked",
"params": [
"value?: boolean"
],
"return": "boolean|nil",
"source": "src/lua/functions/creatures/combat/spell_functions.cpp"
},
{
"name": "soul",
"params": [
"soul?: number"
],
"return": "boolean|number|nil",
"source": "src/lua/functions/creatures/combat/spell_functions.cpp"
},
{
"name": "vocation",
"params": [
"vocation: any"
],
"return": "boolean|table|nil|Spell",
"source": "src/lua/functions/creatures/combat/spell_functions.cpp"
},
{
"name": "words",
"params": [
"words?: string",
"separator?: string"
],
"return": "boolean|string|nil",
"source": "src/lua/functions/creatures/combat/spell_functions.cpp"
}
],
"TalkAction": [
{
"name": "getDescription",
"params": [],
"return": "boolean|string",
"source": "src/lua/functions/events/talk_action_functions.cpp"
},
{
"name": "getGroupType",
"params": [],
"return": "boolean|number",
"source": "src/lua/functions/events/talk_action_functions.cpp"
},
{
"name": "getName",
"params": [],
"return": "boolean|string",
"source": "src/lua/functions/events/talk_action_functions.cpp"
},
{
"name": "groupType",
"params": [
"groupType: string|number"
],
"return": "boolean",
"source": "src/lua/functions/events/talk_action_functions.cpp"
},
{
"name": "onSay",
"params": [
"callback: fun(player: Player, words: string, param: string, type: integer): boolean"
],
"return": "boolean",
"source": "src/lua/functions/events/talk_action_functions.cpp"
},
{
"name": "register",
"params": [],
"return": "boolean",
"source": "src/lua/functions/events/talk_action_functions.cpp"
},
{
"name": "separator",
"params": [
"sep: string"
],
"return": "boolean",
"source": "src/lua/functions/events/talk_action_functions.cpp"
},
{
"name": "setDescription",
"params": [
"arg2: string"
],
"return": "boolean",
"source": "src/lua/functions/events/talk_action_functions.cpp"
}
],
"Teleport": [
{
"name": "getDestination",
"params": [],
"return": "nil|Position",
"source": "src/lua/functions/map/teleport_functions.cpp"
},
{
"name": "setDestination",
"params": [
"position: Position"
],
"return": "boolean|nil",
"source": "src/lua/functions/map/teleport_functions.cpp"
}
],
"Tile": [
{
"name": "addItem",
"params": [
"itemId: number|string",
"countOrSubType?: number",
"flags?: number"
],
"return": "nil|Item",
"source": "src/lua/functions/map/tile_functions.cpp"
},
{
"name": "addItemEx",
"params": [
"item: Item",
"flags?: number"
],
"return": "number|nil",
"source": "src/lua/functions/map/tile_functions.cpp"
},
{
"name": "getBottomCreature",
"params": [],
"return": "nil|Creature",
"source": "src/lua/functions/map/tile_functions.cpp"
},
{
"name": "getBottomVisibleCreature",
"params": [
"creature: Creature"
],
"return": "nil|Creature",
"source": "src/lua/functions/map/tile_functions.cpp"
},
{
"name": "getCreatureCount",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/map/tile_functions.cpp"
},
{
"name": "getCreatures",
"params": [],
"return": "table|nil",
"source": "src/lua/functions/map/tile_functions.cpp"
},
{
"name": "getDownItemCount",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/map/tile_functions.cpp"
},
{
"name": "getFieldItem",
"params": [],
"return": "nil|Item",
"source": "src/lua/functions/map/tile_functions.cpp"
},
{
"name": "getGround",
"params": [],
"return": "nil|Item",
"source": "src/lua/functions/map/tile_functions.cpp"
},
{
"name": "getHouse",
"params": [],
"return": "nil|House",
"source": "src/lua/functions/map/tile_functions.cpp"
},
{
"name": "getItemById",
"params": [
"itemId: number|string",
"subType?: number"
],
"return": "nil|Item",
"source": "src/lua/functions/map/tile_functions.cpp"
},
{
"name": "getItemByTopOrder",
"params": [
"topOrder: number"
],
"return": "nil|Item",
"source": "src/lua/functions/map/tile_functions.cpp"
},
{
"name": "getItemByType",
"params": [
"itemType: any"
],
"return": "nil|Item",
"source": "src/lua/functions/map/tile_functions.cpp"
},
{
"name": "getItemCount",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/map/tile_functions.cpp"
},
{
"name": "getItemCountById",
"params": [
"itemId: number|string",
"subType?: number"
],
"return": "number|nil",
"source": "src/lua/functions/map/tile_functions.cpp"
},
{
"name": "getItems",
"params": [],
"return": "table|nil",
"source": "src/lua/functions/map/tile_functions.cpp"
},
{
"name": "getPosition",
"params": [],
"return": "nil|Position",
"source": "src/lua/functions/map/tile_functions.cpp"
},
{
"name": "getThing",
"params": [
"index: number"
],
"return": "nil|Creature|Item",
"source": "src/lua/functions/map/tile_functions.cpp"
},
{
"name": "getThingCount",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/map/tile_functions.cpp"
},
{
"name": "getThingIndex",
"params": [
"thing: any"
],
"return": "number|nil",
"source": "src/lua/functions/map/tile_functions.cpp"
},
{
"name": "getTopCreature",
"params": [],
"return": "nil|Creature",
"source": "src/lua/functions/map/tile_functions.cpp"
},
{
"name": "getTopDownItem",
"params": [],
"return": "nil|Item",
"source": "src/lua/functions/map/tile_functions.cpp"
},
{
"name": "getTopItemCount",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/map/tile_functions.cpp"
},
{
"name": "getTopTopItem",
"params": [],
"return": "nil|Item",
"source": "src/lua/functions/map/tile_functions.cpp"
},
{
"name": "getTopVisibleCreature",
"params": [
"creature: Creature"
],
"return": "nil|Creature",
"source": "src/lua/functions/map/tile_functions.cpp"
},
{
"name": "getTopVisibleThing",
"params": [
"creature: Creature"
],
"return": "nil|Creature|Item",
"source": "src/lua/functions/map/tile_functions.cpp"
},
{
"name": "hasFlag",
"params": [
"flag: any"
],
"return": "boolean|nil",
"source": "src/lua/functions/map/tile_functions.cpp"
},
{
"name": "hasProperty",
"params": [
"property: any",
"item?: Item"
],
"return": "boolean|nil",
"source": "src/lua/functions/map/tile_functions.cpp"
},
{
"name": "queryAdd",
"params": [
"thing: any",
"flags?: number"
],
"return": "number|nil",
"source": "src/lua/functions/map/tile_functions.cpp"
},
{
"name": "sweep",
"params": [
"actor: Player"
],
"return": "boolean|nil",
"source": "src/lua/functions/map/tile_functions.cpp"
}
],
"Town": [
{
"name": "getId",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/map/town_functions.cpp"
},
{
"name": "getName",
"params": [],
"return": "string|nil",
"source": "src/lua/functions/map/town_functions.cpp"
},
{
"name": "getTemplePosition",
"params": [],
"return": "nil|Position",
"source": "src/lua/functions/map/town_functions.cpp"
}
],
"Variant": [
{
"name": "getNumber",
"params": [],
"return": "number",
"source": "src/lua/functions/creatures/combat/variant_functions.cpp"
},
{
"name": "getPosition",
"params": [],
"return": "Position",
"source": "src/lua/functions/creatures/combat/variant_functions.cpp"
},
{
"name": "getString",
"params": [],
"return": "string",
"source": "src/lua/functions/creatures/combat/variant_functions.cpp"
}
],
"Vocation": [
{
"name": "getAttackSpeed",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/creatures/player/vocation_functions.cpp"
},
{
"name": "getBaseAttackSpeed",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/creatures/player/vocation_functions.cpp"
},
{
"name": "getBaseId",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/creatures/player/vocation_functions.cpp"
},
{
"name": "getBaseSpeed",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/creatures/player/vocation_functions.cpp"
},
{
"name": "getCapacityGain",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/creatures/player/vocation_functions.cpp"
},
{
"name": "getClientId",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/creatures/player/vocation_functions.cpp"
},
{
"name": "getDemotion",
"params": [],
"return": "nil|Vocation",
"source": "src/lua/functions/creatures/player/vocation_functions.cpp"
},
{
"name": "getDescription",
"params": [],
"return": "string|nil",
"source": "src/lua/functions/creatures/player/vocation_functions.cpp"
},
{
"name": "getHealthGain",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/creatures/player/vocation_functions.cpp"
},
{
"name": "getHealthGainAmount",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/creatures/player/vocation_functions.cpp"
},
{
"name": "getHealthGainTicks",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/creatures/player/vocation_functions.cpp"
},
{
"name": "getId",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/creatures/player/vocation_functions.cpp"
},
{
"name": "getManaGain",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/creatures/player/vocation_functions.cpp"
},
{
"name": "getManaGainAmount",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/creatures/player/vocation_functions.cpp"
},
{
"name": "getManaGainTicks",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/creatures/player/vocation_functions.cpp"
},
{
"name": "getMaxSoul",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/creatures/player/vocation_functions.cpp"
},
{
"name": "getName",
"params": [],
"return": "string|nil",
"source": "src/lua/functions/creatures/player/vocation_functions.cpp"
},
{
"name": "getPromotion",
"params": [],
"return": "nil|Vocation",
"source": "src/lua/functions/creatures/player/vocation_functions.cpp"
},
{
"name": "getRequiredManaSpent",
"params": [
"magicLevel: number"
],
"return": "number|nil",
"source": "src/lua/functions/creatures/player/vocation_functions.cpp"
},
{
"name": "getRequiredSkillTries",
"params": [
"skillType: any",
"skillLevel: number"
],
"return": "number|nil",
"source": "src/lua/functions/creatures/player/vocation_functions.cpp"
},
{
"name": "getSoulGainTicks",
"params": [],
"return": "number|nil",
"source": "src/lua/functions/creatures/player/vocation_functions.cpp"
}
],
"Weapon": [
{
"name": "action",
"params": [
"callback: string"
],
"return": "boolean|nil",
"source": "src/lua/functions/items/weapon_functions.cpp"
},
{
"name": "ammoType",
"params": [
"type: string"
],
"return": "boolean|nil",
"source": "src/lua/functions/items/weapon_functions.cpp"
},
{
"name": "attack",
"params": [
"atk: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/items/weapon_functions.cpp"
},
{
"name": "breakChance",
"params": [
"percent: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/items/weapon_functions.cpp"
},
{
"name": "charges",
"params": [
"charges?: number",
"showCharges?: boolean"
],
"return": "boolean|nil",
"source": "src/lua/functions/items/weapon_functions.cpp"
},
{
"name": "damage",
"params": [
"damage?: number",
"max?: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/items/weapon_functions.cpp"
},
{
"name": "decayTo",
"params": [
"arg2?: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/items/weapon_functions.cpp"
},
{
"name": "defense",
"params": [
"defense?: number",
"extraDefense?: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/items/weapon_functions.cpp"
},
{
"name": "duration",
"params": [
"duration?: number",
"showDuration?: boolean"
],
"return": "boolean|nil",
"source": "src/lua/functions/items/weapon_functions.cpp"
},
{
"name": "element",
"params": [
"combatType: string"
],
"return": "boolean|nil",
"source": "src/lua/functions/items/weapon_functions.cpp"
},
{
"name": "extraElement",
"params": [
"atk: number",
"combatType: string"
],
"return": "boolean|nil",
"source": "src/lua/functions/items/weapon_functions.cpp"
},
{
"name": "health",
"params": [
"health: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/items/weapon_functions.cpp"
},
{
"name": "healthPercent",
"params": [
"percent: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/items/weapon_functions.cpp"
},
{
"name": "hitChance",
"params": [
"chance: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/items/weapon_functions.cpp"
},
{
"name": "id",
"params": [
"id: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/items/weapon_functions.cpp"
},
{
"name": "level",
"params": [
"lvl: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/items/weapon_functions.cpp"
},
{
"name": "magicLevel",
"params": [
"lvl: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/items/weapon_functions.cpp"
},
{
"name": "mana",
"params": [
"mana: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/items/weapon_functions.cpp"
},
{
"name": "manaPercent",
"params": [
"percent: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/items/weapon_functions.cpp"
},
{
"name": "maxHitChance",
"params": [
"max: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/items/weapon_functions.cpp"
},
{
"name": "onUseWeapon",
"params": [
"callback: fun(player: Player, variant: Variant): boolean"
],
"return": "boolean",
"source": "src/lua/functions/items/weapon_functions.cpp"
},
{
"name": "premium",
"params": [
"value: boolean"
],
"return": "boolean|nil",
"source": "src/lua/functions/items/weapon_functions.cpp"
},
{
"name": "range",
"params": [
"range: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/items/weapon_functions.cpp"
},
{
"name": "register",
"params": [],
"return": "boolean|nil",
"source": "src/lua/functions/items/weapon_functions.cpp"
},
{
"name": "shootType",
"params": [
"type: any"
],
"return": "boolean|nil",
"source": "src/lua/functions/items/weapon_functions.cpp"
},
{
"name": "slotType",
"params": [
"slot: string"
],
"return": "boolean|nil",
"source": "src/lua/functions/items/weapon_functions.cpp"
},
{
"name": "soul",
"params": [
"soul: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/items/weapon_functions.cpp"
},
{
"name": "transformDeEquipTo",
"params": [
"itemId: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/items/weapon_functions.cpp"
},
{
"name": "transformEquipTo",
"params": [
"itemId: number"
],
"return": "boolean|nil",
"source": "src/lua/functions/items/weapon_functions.cpp"
},
{
"name": "vocation",
"params": [
"vocName: string",
"showInDescription?: boolean",
"lastVoc?: boolean"
],
"return": "boolean|nil",
"source": "src/lua/functions/items/weapon_functions.cpp"
},
{
"name": "wieldUnproperly",
"params": [
"value: boolean"
],
"return": "boolean|nil",
"source": "src/lua/functions/items/weapon_functions.cpp"
}
],
"Webhook": [
{
"name": "sendMessage",
"params": [
"title: string",
"message: string",
"color: number",
"url: any"
],
"return": "nil",
"source": "src/lua/functions/core/network/webhook_functions.cpp"
}
],
"Zone": [
{
"name": "addArea",
"params": [
"fromPos: Position",
"toPos: Position"
],
"return": "boolean",
"source": "src/lua/functions/core/game/zone_functions.cpp"
},
{
"name": "getAll",
"params": [
"...: any"
],
"return": "table",
"source": "src/lua/functions/core/game/zone_functions.cpp"
},
{
"name": "getByName",
"params": [
"name: string"
],
"return": "nil|Zone",
"source": "src/lua/functions/core/game/zone_functions.cpp"
},
{
"name": "getByPosition",
"params": [
"pos: Position"
],
"return": "table|nil",
"source": "src/lua/functions/core/game/zone_functions.cpp"
},
{
"name": "getCreatures",
"params": [],
"return": "boolean|table",
"source": "src/lua/functions/core/game/zone_functions.cpp"
},
{
"name": "getItems",
"params": [],
"return": "boolean|table",
"source": "src/lua/functions/core/game/zone_functions.cpp"
},
{
"name": "getMonsters",
"params": [],
"return": "boolean|table",
"source": "src/lua/functions/core/game/zone_functions.cpp"
},
{
"name": "getName",
"params": [],
"return": "boolean|string",
"source": "src/lua/functions/core/game/zone_functions.cpp"
},
{
"name": "getNpcs",
"params": [],
"return": "boolean|table",
"source": "src/lua/functions/core/game/zone_functions.cpp"
},
{
"name": "getPlayers",
"params": [],
"return": "boolean|table",
"source": "src/lua/functions/core/game/zone_functions.cpp"
},
{
"name": "getPositions",
"params": [],
"return": "boolean|table",
"source": "src/lua/functions/core/game/zone_functions.cpp"
},
{
"name": "getRemoveDestination",
"params": [],
"return": "Position",
"source": "src/lua/functions/core/game/zone_functions.cpp"
},
{
"name": "refresh",
"params": [],
"return": "nil",
"source": "src/lua/functions/core/game/zone_functions.cpp"
},
{
"name": "removeMonsters",
"params": [],
"return": "boolean",
"source": "src/lua/functions/core/game/zone_functions.cpp"
},
{
"name": "removeNpcs",
"params": [],
"return": "boolean",
"source": "src/lua/functions/core/game/zone_functions.cpp"
},
{
"name": "removePlayers",
"params": [],
"return": "boolean",
"source": "src/lua/functions/core/game/zone_functions.cpp"
},
{
"name": "setMonsterVariant",
"params": [
"variant: string"
],
"return": "boolean",
"source": "src/lua/functions/core/game/zone_functions.cpp"
},
{
"name": "setRemoveDestination",
"params": [
"pos: Position"
],
"return": "nil",
"source": "src/lua/functions/core/game/zone_functions.cpp"
},
{
"name": "subtractArea",
"params": [
"fromPos: Position",
"toPos: Position"
],
"return": "boolean",
"source": "src/lua/functions/core/game/zone_functions.cpp"
}
],
"configManager": [
{
"name": "getBoolean",
"params": [
"key: any"
],
"return": "boolean",
"source": "src/lua/functions/core/game/config_functions.cpp"
},
{
"name": "getFloat",
"params": [
"key: any",
"shouldRound: boolean"
],
"return": "number",
"source": "src/lua/functions/core/game/config_functions.cpp"
},
{
"name": "getNumber",
"params": [
"key: any"
],
"return": "number",
"source": "src/lua/functions/core/game/config_functions.cpp"
},
{
"name": "getString",
"params": [
"key: any"
],
"return": "string",
"source": "src/lua/functions/core/game/config_functions.cpp"
}
],
"db": [
{
"name": "asyncQuery",
"params": [
"query: string",
"callback?: fun(success: boolean)"
],
"return": "nil",
"source": "src/lua/functions/core/libs/db_functions.cpp"
},
{
"name": "asyncStoreQuery",
"params": [
"query: string",
"callback?: fun(resultId: number|false)"
],
"return": "nil",
"source": "src/lua/functions/core/libs/db_functions.cpp"
},
{
"name": "escapeBlob",
"params": [
"value: string",
"length: number"
],
"return": "string",
"source": "src/lua/functions/core/libs/db_functions.cpp"
},
{
"name": "escapeString",
"params": [
"value: string"
],
"return": "string",
"source": "src/lua/functions/core/libs/db_functions.cpp"
},
{
"name": "lastInsertId",
"params": [
"...: any"
],
"return": "number",
"source": "src/lua/functions/core/libs/db_functions.cpp"
},
{
"name": "query",
"params": [
"query: string"
],
"return": "boolean",
"source": "src/lua/functions/core/libs/db_functions.cpp"
},
{
"name": "storeQuery",
"params": [
"query: string"
],
"return": "boolean|number",
"source": "src/lua/functions/core/libs/db_functions.cpp"
},
{
"name": "tableExists",
"params": [
"tableName: string"
],
"return": "boolean",
"source": "src/lua/functions/core/libs/db_functions.cpp"
}
],
"kv": [
{
"name": "get",
"params": [
"key: string|KV|boolean",
"forceLoad?: boolean"
],
"return": "nil",
"source": "src/lua/functions/core/libs/kv_functions.cpp"
},
{
"name": "keys",
"params": [
"prefix?: KV|string"
],
"return": "table",
"source": "src/lua/functions/core/libs/kv_functions.cpp"
},
{
"name": "remove",
"params": [
"key: string|KV"
],
"return": "nil",
"source": "src/lua/functions/core/libs/kv_functions.cpp"
},
{
"name": "scoped",
"params": [
"key: string|KV"
],
"return": "KV",
"source": "src/lua/functions/core/libs/kv_functions.cpp"
},
{
"name": "set",
"params": [
"key: string|KV",
"value: number"
],
"return": "boolean",
"source": "src/lua/functions/core/libs/kv_functions.cpp"
}
],
"logger": [
{
"name": "debug",
"params": [
"text: string"
],
"return": "nil",
"source": "src/lua/functions/core/libs/logger_functions.cpp"
},
{
"name": "error",
"params": [
"text: string"
],
"return": "nil",
"source": "src/lua/functions/core/libs/logger_functions.cpp"
},
{
"name": "info",
"params": [
"text: string"
],
"return": "nil",
"source": "src/lua/functions/core/libs/logger_functions.cpp"
},
{
"name": "trace",
"params": [
"text: string"
],
"return": "nil",
"source": "src/lua/functions/core/libs/logger_functions.cpp"
},
{
"name": "warn",
"params": [
"text: string"
],
"return": "nil",
"source": "src/lua/functions/core/libs/logger_functions.cpp"
}
],
"metrics": [
{
"name": "addCounter",
"params": [
"name: string",
"value: number",
"attributes: any"
],
"return": "nil",
"source": "src/lua/functions/core/libs/metrics_functions.cpp"
}
]
},
"classParents": {
"Container": "Item",
"Monster": "Creature",
"Npc": "Creature",
"Player": "Creature",
"Teleport": "Item"
},
"classFields": {
"Position": [
"x integer",
"y integer",
"z integer",
"stackpos integer"
]
},
"classOverloads": {
"MoveEvent": [
"fun(): MoveEvent"
],
"NpcType": [
"fun(name: string): NpcType"
],
"Player": [
"fun(idOrGuid: integer): Player?",
"fun(name: string): Player?, integer?",
"fun(player: Player): Player?"
],
"Position": [
"fun(): Position",
"fun(x?: integer, y?: integer, z?: integer, stackpos?: integer): Position",
"fun(position: Position): Position"
]
},
"globals": []
}