Lua API reference

Note

This page is auto-generated from data/raw/generate_docs.lua and should not be edited directly.

Warning

In Lua, functions can be called with a : and pass the object itself as the first argument, eg:

Members where this behaviour is intended to be used are marked as 🇲 Methods
Their signature documentation hides the first argument to reflect that

Call 🇫 Function members with a .
Call 🇲 Method members with a :

Alternatively, you can still call 🇲 Methods with a ., from the class type or the variable itself but a value of the given type must be passed as the first parameter (that is hidden)

All of these do the same thing:

print(Angle.from_radians(3):to_degrees())

print(Angle.to_degrees(Angle.from_radians(3)))

local a = Angle.from_radians(3)
print(a:to_degrees())

local a = Angle.from_radians(3)
print(a.to_degrees(a))

local a = Angle.from_radians(3)
print(Angle.to_degrees(a))

ActivityTypeId

Constructors

ActivityTypeId.new( )
ActivityTypeId.new( ActivityTypeId )
ActivityTypeId.new( string )

Members

AmmunitionEffectId

Constructors

AmmunitionEffectId.new( )
AmmunitionEffectId.new( AmmunitionEffectId )
AmmunitionEffectId.new( AmmunitionEffectIntId )
AmmunitionEffectId.new( string )

Members

NULL_ID

🇫 Function --> ( ) -> AmmunitionEffectId

int_id

🇲 Method --> ( ) -> AmmunitionEffectIntId

obj

🇲 Method --> ( ) -> AmmunitionEffectRaw

AmmunitionEffectIntId

Constructors

AmmunitionEffectIntId.new( )
AmmunitionEffectIntId.new( AmmunitionEffectIntId )
AmmunitionEffectIntId.new( AmmunitionEffectId )

Members

obj

🇲 Method --> ( ) -> AmmunitionEffectRaw

str_id

🇲 Method --> ( ) -> AmmunitionEffectId

AmmunitionTypeId

Constructors

AmmunitionTypeId.new( )
AmmunitionTypeId.new( AmmunitionTypeId )
AmmunitionTypeId.new( string )

Members

NULL_ID

🇫 Function --> ( ) -> AmmunitionTypeId

Angle

Members

ArmorPortionData

Members

get_covered_parts

🇲 Method --> ( ) -> BodyPartTypeIntId[]

Avatar

Members

Bionic

Members

activate

🇲 Method --> ( Character, boolean? ) -> boolean

Activates this bionic on the given character. Optional block_message (default true) suppresses messages.

deactivate

🇲 Method --> ( Character, boolean? ) -> boolean

Deactivates this bionic on the given character. Optional block_message (default true) suppresses messages.

info

🇲 Method --> ( ) -> BionicDataRaw

Returns the BionicData definition for this bionic.

BionicDataId

Constructors

BionicDataId.new( )
BionicDataId.new( BionicDataId )
BionicDataId.new( string )

Members

BionicDataRaw

Members

available_upgrades

🇲 Method --> ( ) -> string[]

Available upgrade paths for this bionic.

bash_protec

🇲 Method --> ( ) -> table<string, integer>

Bash protection by body part.

bullet_protec

🇲 Method --> ( ) -> table<string, integer>

Bullet protection by body part.

canceled_mutations

🇲 Method --> ( ) -> string[]

Mutations/traits removed when this bionic is installed.

coverage_power_gen_penalty

🇲 Method --> ( ) -> number?

Returns the coverage power gen penalty, or nil if not set.

cut_protec

🇲 Method --> ( ) -> table<string, integer>

Cut protection by body part.

description

🇲 Method --> ( ) -> string

Returns the translated description of this bionic.

enchantments

🇲 Method --> ( ) -> string[]

Returns enchantment IDs as string values.

encumbrance

🇲 Method --> ( ) -> table<string, integer>

Encumbrance caused by this bionic on each body part.

env_protec

🇲 Method --> ( ) -> table<string, integer>

Environmental protection by body part.

flags

🇲 Method --> ( ) -> string[]

Returns the set of flag IDs on this bionic definition.

fuel_opts

🇲 Method --> ( ) -> string[]

Returns fuel type IDs that can power this bionic.

get_all

🇫 Function --> ( ) -> BionicDataRaw[]

Returns a list of every bionic definition in the game.

has_flag

🇲 Method --> ( string ) -> boolean

Checks whether this bionic has a specific flag.

included_bionics

🇲 Method --> ( ) -> string[]

Bionics automatically installed alongside this one.

learned_spells

🇲 Method --> ( ) -> table<string, integer>

Spells learned when this bionic is installed, mapped to level.

name

🇲 Method --> ( ) -> string

Returns the translated name of this bionic.

occupied_bodyparts

🇲 Method --> ( ) -> table<string, integer>

Body parts occupied by this bionic and slot space required.

required_bionics

🇲 Method --> ( ) -> string[]

Other bionics required for this one to be installed.

stat_bonus

🇲 Method --> ( ) -> table<string, integer>

Returns stat bonuses as a table mapping stat name to bonus value.

BodyPartTypeId

Constructors

BodyPartTypeId.new( )
BodyPartTypeId.new( BodyPartTypeId )
BodyPartTypeId.new( BodyPartTypeIntId )
BodyPartTypeId.new( string )

Members

BodyPartTypeIntId

Constructors

BodyPartTypeIntId.new( )
BodyPartTypeIntId.new( BodyPartTypeIntId )
BodyPartTypeIntId.new( BodyPartTypeId )

Members

BookRecipe

Members

Character

Members

mutation_category_level

🇻 Variable --> table<MutationCategoryTraitId, integer>

activate_bionic

🇲 Method --> ( BionicDataId, boolean? ) -> boolean

add_addiction

🇲 Method --> ( AddictionType, integer )

add_item

🇲 Method --> ( Detached<Item> )

Adds a detached item to the player inventory

add_known_trap

🇲 Method --> ( TripointBubMs, TrapRaw )

Character learns that the given trap is on the given tripoint. If the trap is null, the character learns that there is no trap there.

add_known_trap

🇲 Method --> ( TripointBubMs, TrapIntId )

add_morale

🇲 Method --> ( MoraleTypeDataId, integer, integer, TimeDuration, TimeDuration, boolean, ItypeRaw )

addiction_level

🇲 Method --> ( AddictionType ) -> integer

all_items

🇲 Method --> ( boolean ) -> Item[]

Gets all items

all_items_with_flag

🇲 Method --> ( JsonFlagId, boolean ) -> Item[]

Gets all items with the given flag

assign_activity

🇲 Method --> ( ActivityTypeId, integer, integer, integer, string )

assign_lua_activity

🇲 Method --> ( table )

Assigns a Lua-backed activity with opts.type, opts.duration, optional opts.on_finish, optional opts.on_turn, optional opts.data, optional opts.pos, optional opts.name, and optional opts.interruptable.

bionic_armor_bonus

🇲 Method --> ( BodyPartTypeIntId, DamageType ) -> number

blood_loss

🇲 Method --> ( BodyPartTypeIntId ) -> integer

bodypart_exposure

🇲 Method --> ( ) -> table<BodyPartTypeIntId, number>

can_hear

🇲 Method --> ( TripointBubMs, integer ) -> boolean

can_pick_weight

🇲 Method --> ( Mass, boolean ) -> boolean

can_takeoff

🇲 Method --> ( Item ) -> boolean

Checks if a given <code>[Item](#sol::Item)</code> can be taken off.

can_wear

🇲 Method --> ( Item, boolean ) -> boolean

Checks if creature can wear a given item. If boolean parameter is true, ignores already worn items

check_mount_will_move

🇲 Method --> ( TripointBubMs ) -> boolean

consume_items

🇲 Method --> ( CppVal<item_comp>[] )

Consumes items from inventory based on item component list

consume_tools

🇲 Method --> ( CppVal<tool_comp>[] )

Consumes tool charges from inventory based on tool component list

crafting_inventory

🇲 Method --> ( ) -> Inventory

Returns the crafting inventory for this character (includes nearby items)

create_item

🇲 Method --> ( ItypeId, integer ) -> Item

Creates and an item with the given id and amount to the player inventory

deactivate_bionic

🇲 Method --> ( BionicDataId, boolean? ) -> boolean

drench

🇲 Method --> ( integer, BodyPartTypeIntId[], boolean )

drop_all_items

🇲 Method --> ( )

Drops all items (inventory, worn, wielded) at the character's current position.

enough_power_for

🇲 Method --> ( BionicDataId ) -> boolean

fall_asleep

🇲 Method --> ( )
🇲 Method --> ( TimeDuration )

get_armor_acid

🇲 Method --> ( BodyPartTypeIntId ) -> integer

get_auto_start_thresh

🇲 Method --> ( BionicDataId ) -> number

get_base_traits

🇲 Method --> ( ) -> MutationBranchId[]

get_bionic

🇲 Method --> ( BionicDataId ) -> Bionic

get_free_bionics_slots

🇲 Method --> ( BodyPartTypeIntId ) -> integer

get_highest_category

🇲 Method --> ( ) -> MutationCategoryTraitId

get_hostile_creatures

🇲 Method --> ( integer ) -> Creature[]

get_item_with_id

🇲 Method --> ( ItypeId, boolean ) -> Item

Gets the first occurrence of an item with the given id

get_magic

🇲 Method --> ( ) -> KnownMagic

Access the character's spellbook and mana pool.

get_morale

🇲 Method --> ( MoraleTypeDataId ) -> integer

get_mutations

🇲 Method --> ( boolean ) -> MutationBranchId[]

get_part_encumbrance

🇲 Method --> ( BodyPartTypeId ) -> integer

get_part_temp_btu

🇲 Method --> ( BodyPartTypeIntId ) -> integer

Gets the current temperature of a specific body part (in Body Temperature Units).

get_skill_level_object

🇲 Method --> ( SkillId ) -> SkillLevel

get_temp_btu

🇲 Method --> ( ) -> table<BodyPartTypeIntId, integer>

Gets all bodyparts and their associated temperatures (in Body Temperature Units).

get_total_bionics_slots

🇲 Method --> ( BodyPartTypeIntId ) -> integer

get_used_bionics_slots

🇲 Method --> ( BodyPartTypeIntId ) -> integer

get_visible_creatures

🇲 Method --> ( integer ) -> Creature[]

has_active_bionic

🇲 Method --> ( BionicDataId ) -> boolean

has_active_mutation

🇲 Method --> ( MutationBranchId ) -> boolean

has_activity

🇲 Method --> ( ActivityTypeId ) -> boolean

has_addiction

🇲 Method --> ( AddictionType ) -> boolean

has_base_trait

🇲 Method --> ( MutationBranchId ) -> boolean

has_bionic

🇲 Method --> ( BionicDataId ) -> boolean

has_child_flag

🇲 Method --> ( MutationBranchId ) -> boolean

has_item_with_flag

🇲 Method --> ( JsonFlagId, boolean ) -> boolean

Checks for an item with the given flag

has_item_with_id

🇲 Method --> ( ItypeId, boolean ) -> boolean

Checks for an item with the given id

has_mabuff

🇲 Method --> ( MartialArtsBuffId ) -> boolean

has_morale

🇲 Method --> ( MoraleTypeDataId ) -> boolean

has_opposite_trait

🇲 Method --> ( MutationBranchId ) -> boolean

has_trait_flag

🇲 Method --> ( JsonTraitFlagId ) -> boolean

heal

🇲 Method --> ( BodyPartTypeIntId, integer )

healing_rate_medicine

🇲 Method --> ( number, BodyPartTypeIntId ) -> number

hitall

🇲 Method --> ( integer, integer, Creature ) -> integer

hurtall

🇲 Method --> ( integer, Creature, boolean )

invalidate_crafting_inventory

🇲 Method --> ( )

Invalidates the cached crafting inventory

irradiate

🇲 Method --> ( number, boolean ) -> boolean

is_auto_start_keep_full

🇲 Method --> ( BionicDataId ) -> boolean

is_auto_start_on

🇲 Method --> ( BionicDataId ) -> boolean

is_limb_broken

🇲 Method --> ( BodyPartTypeIntId ) -> boolean

is_limb_disabled

🇲 Method --> ( BodyPartTypeIntId ) -> boolean

is_wearing_on_bp

🇲 Method --> ( ItypeId, BodyPartTypeIntId ) -> boolean

item_worn_with_flag

🇲 Method --> ( JsonFlagId, BodyPartTypeIntId ) -> Item

item_worn_with_id

🇲 Method --> ( ItypeId, BodyPartTypeIntId ) -> Item

items_with

🇲 Method --> ( bool ) -> Item[]

Filters items

knows_trap

🇲 Method --> ( TripointBubMs ) -> boolean

Whether the character knows about the trap at the given tripoint.

mabuff_armor_bonus

🇲 Method --> ( DamageType ) -> integer

mabuff_arpen_bonus

🇲 Method --> ( DamageType ) -> integer

mabuff_damage_bonus

🇲 Method --> ( DamageType ) -> integer

mutate_category

🇲 Method --> ( MutationCategoryTraitId )

mutate_towards

🇲 Method --> ( MutationBranchId ) -> boolean

mutate_towards

🇲 Method --> ( MutationBranchId[], integer ) -> boolean

mutate_towards

🇲 Method --> ( MutationBranchId[], integer ) -> boolean
🇲 Method --> ( MutationBranchId ) -> boolean

mutation_armor

🇲 Method --> ( BodyPartTypeIntId, DamageType ) -> number

mutation_ok

🇲 Method --> ( MutationBranchId, boolean, boolean ) -> boolean

practice

🇲 Method --> ( SkillId, integer, integer, boolean )

remove_item

🇲 Method --> ( Item ) -> Detached<Item>

Removes given <code>[Item](#sol::Item)</code> from character's inventory. The <code>[Item](#sol::Item)</code> must be in the inventory, neither wielded nor worn.

remove_mutation

🇲 Method --> ( MutationBranchId, boolean )

remove_worn

🇲 Method --> ( Item ) -> Detached<Item>?

Attempts to remove the worn <code>[Item](#sol::Item)</code> from character.

set_part_temp_btu

🇲 Method --> ( BodyPartTypeIntId, integer )

Sets a specific body part to a given temperature (in Body Temperature Units).

set_temp_btu

🇲 Method --> ( integer )

Sets ALL body parts on a creature to the given temperature (in Body Temperature Units).

takeoff

🇲 Method --> ( Item ) -> boolean

Attempts to take off the worn <code>[Item](#sol::Item)</code> from character.

use_charges

🇲 Method --> ( ItypeId, integer, bool ) -> Detached<Item>[]

use_charges_if_avail

🇲 Method --> ( ItypeId, integer ) -> boolean

wear

🇲 Method --> ( Item, boolean ) -> boolean

Attempts to wear an item in the creature inventory. If boolean parameter is false, item is worn instantly

wear_detached

🇲 Method --> ( Detached<Item>, boolean ) -> boolean

Attempts to wear an item not in the creature inventory. If boolean parameter is false, item is worn instantly

wearing_something_on

🇲 Method --> ( BodyPartTypeIntId ) -> boolean

worn_with_flag

🇲 Method --> ( JsonFlagId, BodyPartTypeIntId ) -> boolean

worn_with_id

🇲 Method --> ( ItypeId, BodyPartTypeIntId ) -> boolean

CharacterId

Constructors

CharacterId.new( )
CharacterId.new( int )

Members

Creature

Members

add_effect

🇲 Method --> ( EffectTypeId, TimeDuration, BodyPartTypeId?, integer? )

Effect type, duration, bodypart and intensity

apply_damage

🇲 Method --> ( Creature, BodyPartTypeIntId, integer, boolean )

deal_damage

🇲 Method --> ( Creature, BodyPartTypeIntId, DamageInstance ) -> DealtDamageInstance

disp_name

🇲 Method --> ( possessive: boolean, capitalize_first: boolean ) -> string

erase

🇲 Method --> ( )

Removes this creature from the game without death notifications or a corpse.

get_all_body_parts

🇲 Method --> ( boolean ) -> BodyPartTypeIntId[]

get_armor_bash

🇲 Method --> ( BodyPartTypeIntId ) -> integer

get_armor_bash_base

🇲 Method --> ( BodyPartTypeIntId ) -> integer

get_armor_bullet

🇲 Method --> ( BodyPartTypeIntId ) -> integer

get_armor_bullet_base

🇲 Method --> ( BodyPartTypeIntId ) -> integer

get_armor_cut

🇲 Method --> ( BodyPartTypeIntId ) -> integer

get_armor_cut_base

🇲 Method --> ( BodyPartTypeIntId ) -> integer

get_armor_type

🇲 Method --> ( DamageType, BodyPartTypeIntId ) -> integer

get_effect

🇲 Method --> ( EffectTypeId, BodyPartTypeId? ) -> Effect

get_effect_dur

🇲 Method --> ( EffectTypeId, BodyPartTypeId? ) -> TimeDuration

get_effect_int

🇲 Method --> ( EffectTypeId, BodyPartTypeId? ) -> integer

get_env_resist

🇲 Method --> ( BodyPartTypeIntId ) -> integer

get_hp

🇲 Method --> ( BodyPartTypeIntId? ) -> integer

get_hp_max

🇲 Method --> ( BodyPartTypeIntId? ) -> integer

get_part_healed_total

🇲 Method --> ( BodyPartTypeIntId ) -> integer

get_part_hp_cur

🇲 Method --> ( BodyPartTypeIntId ) -> integer

get_part_hp_max

🇲 Method --> ( BodyPartTypeIntId ) -> integer

get_random_body_part

🇲 Method --> ( boolean ) -> BodyPartTypeIntId

get_value

🇲 Method --> ( string ) -> string

Retrieves an arbitrary entry using the same key format as set_value.

has_effect

🇲 Method --> ( EffectTypeId, BodyPartTypeId? ) -> boolean

has_effect_with_flag

🇲 Method --> ( JsonFlagId, BodyPartTypeId? ) -> boolean

has_flag

🇲 Method --> ( MonsterFlag ) -> boolean

has_trait

🇲 Method --> ( MutationBranchId ) -> boolean

in_species

🇲 Method --> ( SpeciesTypeId ) -> boolean

is_immune_damage

🇲 Method --> ( DamageType ) -> boolean

is_immune_effect

🇲 Method --> ( EffectTypeId ) -> boolean

mod_part_hp_cur

🇲 Method --> ( BodyPartTypeIntId, integer )

mod_part_hp_max

🇲 Method --> ( BodyPartTypeIntId, integer )

remove_effect

🇲 Method --> ( EffectTypeId, BodyPartTypeId? ) -> boolean

remove_value

🇲 Method --> ( string )

Removes an arbitrary entry using the same key format as set_value.

sees

🇲 Method --> ( TripointBubMs ) -> boolean

set_part_hp_cur

🇲 Method --> ( BodyPartTypeIntId, integer )

set_part_hp_max

🇲 Method --> ( BodyPartTypeIntId, integer )

set_value

🇲 Method --> ( string, string )

Sets an arbitrary key : value pair for the creature.NPC dialogue system uses this, with the format("npctalk_var" + "" + type_var + "" + var_context + "_" + var_base_name) used for the key, skipping type or context if empty.

values_table

🇲 Method --> ( ) -> table

Returns all stored creature vars as a Lua table

DamageInstance

Represents a bunch of damage amounts
Constructors are:
new(damageType, amount, armorPen, remainingArmorMultiplier, damageMultiplier)

Constructors

DamageInstance.new( )
DamageInstance.new( DamageType, double, double, double, double )

Members

add_damage

🇲 Method --> ( DamageType, number, number, number, number )

DamageUnit

Represents a damage amount
Constructors are:
new()
new(damageType, amount, armorPen, remainingArmorMultiplier, damageMultiplier)

Constructors

DamageUnit.new( DamageType, double, double, double, double )

Members

DealtDamageInstance

Represents the final dealt damage

Members

type_damage

🇲 Method --> ( DamageType ) -> integer

DiseaseTypeId

Constructors

DiseaseTypeId.new( )
DiseaseTypeId.new( DiseaseTypeId )
DiseaseTypeId.new( string )

Members

DistributionGrid

A grid that organizes producers, storage and consumers of a resource like electricity

Members

empty

🇲 Method --> ( ) -> boolean

Check if grid is empty

get_contents

🇲 Method --> ( ) -> TripointAbsMs[]

Get current resource amount. Boolean argument (optional) controls recursive behavior (default true) Get vector of absolute map square coordinates of grid contents

get_power_stat

🇲 Method --> ( ) -> PowerStat

Get power generation and consumption statistics for the grid

get_resource

🇲 Method --> ( boolean? ) -> integer

Modify resource amount. First argument is amount, second (optional) controls recursive behavior (default true)

is_valid

🇲 Method --> ( ) -> boolean

Check if grid is valid

mod_resource

🇲 Method --> ( integer, boolean? ) -> integer

update

🇲 Method --> ( TimePoint )

Update the grid to the given time point

DistributionGridTracker

Manages all active distribution grids

Members

debug_grid_id

🇲 Method --> ( TripointAbsOmt ) -> integer

Get unique identifier for grid at given overmap tile (for debug purposes, returns 0 if no grid)

grid_at

🇲 Method --> ( TripointAbsMs ) -> DistributionGrid
🇲 Method --> ( TripointAbsMs ) -> DistributionGrid

Get grid at absolute map square position

on_changed

🇲 Method --> ( TripointAbsMs )

Notify tracker that a tile at the given position has changed

on_options_changed

🇲 Method --> ( )

Notify tracker that game options have changed

update

🇲 Method --> ( TimePoint )

Update all grids to the given time point

Effect

Members

activated

🇲 Method --> ( TimePoint, string, integer, boolean, number ) -> boolean

decay

🇲 Method --> ( TimePoint, boolean ) -> boolean

get_addict_mod

🇲 Method --> ( string, integer ) -> number

get_amount

🇲 Method --> ( string, boolean ) -> integer

get_avg_mod

🇲 Method --> ( string, boolean ) -> integer

get_max_val

🇲 Method --> ( string, boolean ) -> integer

get_min_val

🇲 Method --> ( string, boolean ) -> integer

get_mod

🇲 Method --> ( string, boolean ) -> integer

get_percentage

🇲 Method --> ( string, integer, boolean ) -> number

get_resist_traits

🇲 Method --> ( ) -> MutationBranchId[]

has_flag

🇲 Method --> ( JsonFlagId ) -> boolean

mod_duration

🇲 Method --> ( TimeDuration, boolean )

mod_intensity

🇲 Method --> ( integer, boolean ) -> integer

set_duration

🇲 Method --> ( TimeDuration, boolean )

set_intensity

🇲 Method --> ( integer, boolean ) -> integer

EffectTypeId

Constructors

EffectTypeId.new( )
EffectTypeId.new( EffectTypeId )
EffectTypeId.new( string )

Members

Energy

Members

ExplosionData

Members

damage

🇻 Variable --> integer

Damage dealt by the explosion

fire

🇻 Variable --> boolean

Whether the explosion creates fire

radius

🇻 Variable --> number

Radius of the explosion

safe_range

🇲 Method --> ( ) -> integer

Returns the safe range of the explosion

FactionId

Constructors

FactionId.new( )
FactionId.new( FactionId )
FactionId.new( string )

Members

FactionRaw

FaultId

Constructors

FaultId.new( )
FaultId.new( FaultId )
FaultId.new( string )

Members

FieldEmitId

Constructors

FieldEmitId.new( )
FieldEmitId.new( FieldEmitId )
FieldEmitId.new( string )

Members

FieldTypeId

Constructors

FieldTypeId.new( )
FieldTypeId.new( FieldTypeId )
FieldTypeId.new( FieldTypeIntId )
FieldTypeId.new( string )

Members

FieldTypeIntId

Constructors

FieldTypeIntId.new( )
FieldTypeIntId.new( FieldTypeIntId )
FieldTypeIntId.new( FieldTypeId )

Members

FurnId

Constructors

FurnId.new( )
FurnId.new( FurnId )
FurnId.new( FurnIntId )
FurnId.new( string )

Members

FurnIntId

Constructors

FurnIntId.new( )
FurnIntId.new( FurnIntId )
FurnIntId.new( FurnId )

Members

FurnRaw

Members

Inventory

Look up requirement_data by ID string. Returns nil if not found.
Represents a character's inventory

Members

clear

🇲 Method --> ( )

Clear all items from the inventory

count_item

🇲 Method --> ( ItypeId ) -> integer

Count items of a specific type

find_item

🇲 Method --> ( integer ) -> Item

Find item at position

has_charges

🇲 Method --> ( ItypeId, integer ) -> boolean

Check if inventory has the specified charges

has_components

🇲 Method --> ( ItypeId, integer ) -> boolean

Check if inventory has the specified components

has_tools

🇲 Method --> ( ItypeId, integer ) -> boolean

Check if inventory has the specified tool

position_by_type

🇲 Method --> ( ItypeId ) -> integer

Get item position by type

size

🇲 Method --> ( ) -> integer

Get the number of item stacks in the inventory

volume

🇲 Method --> ( ) -> Volume

Get the total volume of the inventory

weight

🇲 Method --> ( ) -> Mass

Get the total weight of the inventory

IslotAmmo

Members

ammo_id

🇻 Variable --> AmmunitionTypeId

Ammo type, basically the "form" of the ammo that fits into the gun/tool

casing_id

🇻 Variable --> ItypeId?

Type id of casings, if any

cookoff

🇻 Variable --> boolean

Should this ammo explode in fire?

dont_recover_one_in

🇻 Variable --> integer

Chance to fail to recover the ammo used.

loudness

🇻 Variable --> integer

Base loudness of ammo (possibly modified by gun/gunmods)

recoil

🇻 Variable --> integer

Recoil (per shot), roughly equivalent to kinetic energy (in Joules)

special_cookoff

🇻 Variable --> boolean

Should this ammo apply a special explosion effect when in fire?

IslotArmor

Members

env_resist

🇻 Variable --> integer

Resistance to environmental effects

env_resist_w_filter

🇻 Variable --> integer

Environmental protection of a gas mask with installed filter

layer_data

🇻 Variable --> ArmorPortionData[]

Layer, encumbrance and coverage information

resistance

🇻 Variable --> Resistances

Damage negated by this armor. Usually calculated from materials+thickness

sided

🇻 Variable --> boolean

Whether this item can be worn on either side of the body

storage

🇻 Variable --> Volume

How much storage this items provides when worn

thickness

🇻 Variable --> integer

Multiplier on resistances provided by armor's materials. Damaged armors have lower effective thickness, low capped at 1. Note: 1 thickness means item retains full resistance when damaged.

valid_mods

🇻 Variable --> string[]

Whitelisted clothing mods. Restricted clothing mods must be listed here by id to be compatible.

warmth

🇻 Variable --> integer

How much warmth this item provides

weight_capacity_bonus

🇻 Variable --> Mass

Bonus to weight capacity

weight_capacity_modifier

🇻 Variable --> number

Factor modifying weight capacity

IslotArtifact

Members

effects_activated

🇻 Variable --> ArtifactEffectPassive[]

effects_activated_descriptions

🇲 Method --> ( ) -> string[]

IslotBattery

Members

max_capacity

🇻 Variable --> Energy

Maximum energy the battery can store

IslotBionic

Members

bionic_id

🇻 Variable --> BionicDataId

Id of the bionic

difficulty

🇻 Variable --> integer

Arbitrary difficulty scale

installation_data

🇻 Variable --> ItypeId

Item with installation data that can be used to provide almost guaranteed successful install of corresponding bionic

is_upgrade

🇻 Variable --> boolean

Whether this CBM is an upgrade of another

IslotBook

Members

chapters

🇻 Variable --> integer

Fun books have chapters; after all are read, the book is less fun.

fun

🇻 Variable --> integer

How fun reading this is, can be negative

intelligence

🇻 Variable --> integer

Intelligence required to read it

martial_art

🇻 Variable --> MartialArtsId

Which martial art it teaches. Can be MartialArtsId.NULL_ID

recipes

🇻 Variable --> BookRecipe[]

Recipes contained in this book

skill

🇻 Variable --> SkillId

Which skill it upgrades, if any. Can be SkillId.NULL_ID

skill_max

🇻 Variable --> integer

The skill level the book provides

skill_min

🇻 Variable --> integer

The skill level required to understand it

time

🇻 Variable --> integer

How long in minutes it takes to read. "To read" means getting 1 skill point, not all of them.

IslotBrewable

Members

results

🇻 Variable --> ItypeId[]

What are the results of fermenting this item

time

🇻 Variable --> TimeDuration

How long for this brew to ferment

IslotComestible

Members

addict_type

🇻 Variable --> AddictionType

effects of addiction

addict_value

🇻 Variable --> integer

addiction potential

comest_type

🇻 Variable --> string

comestible subtype - eg. FOOD, DRINK, MED

contamination

🇻 Variable --> table<DiseaseTypeId, integer>

List of diseases carried by this comestible and their associated probability

cooks_like

🇻 Variable --> ItypeId

Reference to other item that replaces this one as a component in recipe results

def_charges

🇻 Variable --> integer

Defaults # of charges (drugs, loaf of bread? etc)

fatigue_mod

🇻 Variable --> integer

fatigue altering effect

freeze_point

🇻 Variable --> integer

freezing point in degrees Fahrenheit, below this temperature item can freeze

monotony_penalty

🇻 Variable --> integer

A penalty applied to fun for every time this food has been eaten in the last 48 hours

parasites

🇻 Variable --> integer

chance (odds) of becoming parasitised when eating (zero if never occurs)

petfood

🇻 Variable --> string[]

pet food category

quench

🇻 Variable --> integer

effect on character thirst (may be negative)

radiation

🇻 Variable --> integer

Amount of radiation you get from this comestible

rot_spawn

🇻 Variable --> MonsterGroupId

The monster group that is drawn from when the item rots away

rot_spawn_chance

🇻 Variable --> integer

Chance the above monster group spawns

smoking_result

🇻 Variable --> ItypeId

Reference to item that will be received after smoking current item

specific_heat_liquid

🇻 Variable --> number

specific heats in J/(g K) and latent heat in J/g

spoils

🇻 Variable --> TimeDuration

Time until becomes rotten at standard temperature, or zero if never spoils

stimulant_type

🇻 Variable --> integer

stimulant effect

tool

🇻 Variable --> ItypeId

tool needed to consume (e.g. lighter for cigarettes)

get_default_nutrition

🇲 Method --> ( ) -> table<VitaminId, integer>

Nutrition values to use for this type when they aren't calculated from components

IslotContainer

Members

contains

🇻 Variable --> Volume

Inner volume of the container

preserves

🇻 Variable --> boolean

Contents do not spoil

unseals_into

🇻 Variable --> ItypeId

If this is set to anything but "null", changing this container's contents in any way will turn this item into that type

watertight

🇻 Variable --> boolean

Can hold liquids

IslotEngine

Members

displacement

🇻 Variable --> integer

For combustion engines, the displacement

IslotFuel

Members

energy

🇻 Variable --> number

Energy of the fuel (kilojoules per charge)

IslotGun

Members

ammo

🇻 Variable --> AmmunitionTypeId[]

What type of ammo this gun uses

ammo_effects

🇻 Variable --> AmmunitionEffectId[]

Effects that are applied to the ammo when fired

ammo_to_fire

🇻 Variable --> integer

How much ammo is consumed per shot

barrel_volume

🇻 Variable --> Volume

Volume of material removed by sawing down the barrel, if left unspecified barrel can't be sawed down

blackpowder_tolerance

🇻 Variable --> integer

One in X chance for gun to require major cleanup after firing blackpowder shot

built_in_mods

🇻 Variable --> ItypeId[]

Built in mods. string is id of mod. These mods will get the IRREMOVABLE flag set

burst

🇻 Variable --> integer

Burst size for AUTO mode (legacy field for items not migrated to specify modes )

clip

🇻 Variable --> integer

For guns with an integral magazine what is the capacity?

default_mods

🇻 Variable --> ItypeId[]

Default mods, string is id of mod. These mods are removable but are default on the weapon

durability

🇻 Variable --> integer

Gun durability, affects gun being damaged during shooting

handling

🇻 Variable --> integer

How easy is control of recoil? If unset value automatically derived from weapon type

loudness

🇻 Variable --> integer

Modifies base loudness as provided by the currently loaded ammo

min_cycle_recoil

🇻 Variable --> integer

Minimum ammo recoil for gun to be able to fire more than once per attack

recoil

🇻 Variable --> integer

Additional recoil applied per shot before effects of handling are considered, useful for adding recoil effect to guns which otherwise consume no ammo

reload_noise

🇻 Variable --> string

Noise displayed when reloading the weapon

reload_noise_volume

🇻 Variable --> integer

Volume of the noise made when reloading this weapon

reload_time

🇻 Variable --> integer

Reload time, in moves

sight_dispersion

🇻 Variable --> integer

Maximum aim achievable using base weapon sights

skill_used

🇻 Variable --> SkillId

What skill this gun uses

ups_charges

🇻 Variable --> integer

If this uses UPS charges, how many (per shoot), 0 for no UPS charges at all

get_gunmod_locations

🇲 Method --> ( ) -> table<string, integer>

Location for gun mods. Key is the location (untranslated!), value is the number of mods that the location can have. The value should be > 0

get_modes

🇲 Method --> ( ) -> string[]

Firing modes are supported by the gun. Always contains at least DEFAULT mode

IslotGunmod

Members

aim_speed

🇻 Variable --> integer

For sights (see @ref sight_dispersion), this value affects time cost of aiming. Higher is better. In case of multiple usable sights, the one with highest aim speed is used.

ammo_to_fire_modifier

🇻 Variable --> integer

Increases base gun ammo to fire by this value per shot

ammo_to_fire_multiplier

🇻 Variable --> number

Increases base gun ammo to fire by this many times per shot

consume_chance

🇻 Variable --> integer

Percentage value change to the gun's loading time. Higher is less likely

consume_divisor

🇻 Variable --> integer

Divsor to scale back gunmod consumption damage. lower is more damaging. Affected by ammo loudness and recoil, see ranged.cpp for how much.

exclusion

🇻 Variable --> CppVal<std_unordered_set<string_id<itype>>>

What kind of weapons this gunmod can't be used with

exclusion_category

🇻 Variable --> CppVal<std_unordered_set<string_id<weapon_category>>>[]

What category of weapons this gunmod can't be used with

handling

🇻 Variable --> integer

Relative adjustment to base gun handling

install_time

🇻 Variable --> integer

How many moves does this gunmod take to install?

loudness

🇻 Variable --> integer

Modifies base loudness as provided by the currently loaded ammo

min_str_required_mod

🇻 Variable --> integer

Modifies base strength required

reload_modifier

🇻 Variable --> integer

Percentage value change to the gun's loading time. Higher is slower

sight_dispersion

🇻 Variable --> integer

If this value is set (non-negative), this gunmod functions as a sight. A sight is only usable to aim by a character whose current Character::recoil is at or below this value.

ups_charges_modifier

🇻 Variable --> integer

Increases base gun UPS consumption by this value per shot

ups_charges_multiplier

🇻 Variable --> number

Increases base gun UPS consumption by this many times per shot

usable

🇻 Variable --> CppVal<std_unordered_set<string_id<itype>>>

What kind of weapons this gunmod can be used with

usable_category

🇻 Variable --> CppVal<std_unordered_set<string_id<weapon_category>>>[]

What category of weapons this gunmod can be used with

weight_multiplier

🇻 Variable --> number

Increases gun weight by this many times

get_added_slots

🇲 Method --> ( ) -> table<string, integer>

Additional gunmod slots to add to the gun

get_location

🇲 Method --> ( ) -> string

Where is this gunmod installed (e.g. "stock", "rail")?

get_mod_blacklist

🇲 Method --> ( ) -> string[]

Not compatible on weapons that have this mod slot

get_mode_modifiers

🇲 Method --> ( ) -> string[]

Firing modes added to or replacing those of the base gun

IslotMagazine

Members

ammo_type

🇻 Variable --> AmmunitionTypeId[]

What type of ammo this magazine can be loaded with

capacity

🇻 Variable --> integer

Capacity of magazine (in equivalent units to ammo charges)

count

🇻 Variable --> integer

Default amount of ammo contained by a magazine (often set for ammo belts)

default_ammo

🇻 Variable --> ItypeId

Default type of ammo contained by a magazine (often set for ammo belts)

linkage

🇻 Variable --> ItypeId?

For ammo belts one linkage (of given type) is dropped for each unit of ammo consumed

protects_contents

🇻 Variable --> boolean

If false, ammo will cook off if this mag is affected by fire

reliability

🇻 Variable --> integer

How reliable this magazine on a range of 0 to 10?

reload_time

🇻 Variable --> integer

How long it takes to load each unit of ammo into the magazine

IslotMilling

Members

IslotMod

Members

acceptable_ammo

🇻 Variable --> AmmunitionTypeId[]

If non-empty restrict mod to items with those base (before modifiers) ammo types

ammo_modifier

🇻 Variable --> AmmunitionTypeId[]

If set modifies parent ammo to this type

capacity_multiplier

🇻 Variable --> number

Proportional adjustment of parent item ammo capacity

magazine_adaptor

🇻 Variable --> table<AmmunitionTypeId, ItypeId[]>

If non-empty replaces the compatible magazines for the parent item

IslotPetArmor

Members

bodytype

🇻 Variable --> string

What animal bodytype can wear this armor

env_resist

🇻 Variable --> integer

Resistance to environmental effects

env_resist_w_filter

🇻 Variable --> integer

Environmental protection of a gas mask with installed filter

max_vol

🇻 Variable --> Volume

The maximum volume a pet can be and wear this armor

min_vol

🇻 Variable --> Volume

The minimum volume a pet can be and wear this armor

storage

🇻 Variable --> Volume

How much storage this items provides when worn

thickness

🇻 Variable --> integer

Multiplier on resistances provided by this armor

IslotSeed

Members

byproducts

🇻 Variable --> ItypeId[]

Additionally items (a list of their item ids) that will spawn when harvesting the plant.

fruit_div

🇻 Variable --> integer

Amount of harvested charges of fruits is divided by this number.

fruit_id

🇻 Variable --> ItypeId

Type id of the fruit item.

grow

🇻 Variable --> TimeDuration

Time it takes for a seed to grow (based of off a season length of 91 days).

get_plant_name

🇲 Method --> ( integer ) -> string

Name of the plant.

IslotTool

Members

IslotWheel

Members

diameter

🇻 Variable --> integer

Diameter of wheel in millimeters. Integer JSON values are legacy inches.

width

🇻 Variable --> integer

Width of wheel in millimeters. Integer JSON values are legacy inches.

Item

Members

add_item_with_id

🇲 Method --> ( ItypeId, integer )

Adds an item(s) to contents

add_technique

🇲 Method --> ( MartialArtsTechniqueId )

Adds the technique. It isn't treated original, but additional.

ammo_capacity

🇲 Method --> ( boolean ) -> integer

Gets the maximum capacity of a magazine

ammo_consume

🇲 Method --> ( integer, TripointBubMs ) -> integer

ammo_remaining

🇲 Method --> ( ) -> integer

Get remaining ammo, works with batteries & stuff too

can_contain

🇲 Method --> ( Item ) -> boolean

Checks if this item can contain another

convert

🇲 Method --> ( ItypeId )

Converts the item as given <code>[ItypeId](#sol::ItypeId)</code>.

covers

🇲 Method --> ( BodyPartTypeIntId ) -> boolean

Checks if the item covers a bodypart

current_magazine

🇲 Method --> ( ) -> Item

Gets the current magazine

display_name

🇲 Method --> ( integer ) -> string

Display name with all bells and whistles like ammo and prefixes

get_category_id

🇲 Method --> ( ) -> string

Gets the category id this item is in

get_damage

🇲 Method --> ( ) -> integer

Get current item damage value (durability). Higher values mean more damaged. Default range is -1000 (min) to 4000 (max), configurable via 'damage_states' in JSON.

get_damage_level

🇲 Method --> ( ) -> integer
🇲 Method --> ( integer ) -> integer

Get item damage as a level from 0 to max. Used for UI display and damage thresholds.

get_max_damage

🇲 Method --> ( ) -> integer

Get maximum possible damage value before item is destroyed. Default is 4000, configurable via 'damage_states' in JSON.

get_min_damage

🇲 Method --> ( ) -> integer

Get minimum possible damage value (can be negative for reinforced items). Default is -1000, configurable via 'damage_states' in JSON.

get_mtype

🇲 Method --> ( ) -> MonsterTypeId

Almost for a corpse.

get_owner

🇲 Method --> ( ) -> FactionId

Gets the faction id that owns this item

get_relative_health

🇲 Method --> ( ) -> number

Get relative health as ratio 0.0-1.0, where 1.0 is undamaged and 0.0 is destroyed

get_rot

🇲 Method --> ( ) -> TimeDuration

Gets the TimeDuration until this item rots

get_techniques

🇲 Method --> ( ) -> MartialArtsTechniqueId[]

Gets all techniques. Including original techniques.

get_var_num

🇲 Method --> ( string, number ) -> number

Get variable as float number

get_var_str

🇲 Method --> ( string, string ) -> string

Get variable as string

get_var_tri

🇲 Method --> ( string, Tripoint ) -> Tripoint

Get variable as tripoint

has_flag

🇲 Method --> ( JsonFlagId ) -> boolean

has_item_with_id

🇲 Method --> ( ItypeId ) -> boolean

Checks item contents for a given item id

has_own_flag

🇲 Method --> ( JsonFlagId ) -> boolean

has_technique

🇲 Method --> ( MartialArtsTechniqueId ) -> boolean

Checks if this item has the technique as an addition. Doesn't check original techniques.

has_var

🇲 Method --> ( string ) -> boolean

Check for variable of any type

invoke_at

🇲 Method --> ( TripointBubMs ) -> integer

Immediately invokes this item's use action at the given map-square position. Returns the charges consumed by the use action.

is_made_of

🇲 Method --> ( MaterialTypeId ) -> boolean

is_magazine

🇲 Method --> ( ) -> boolean

Is this a magazine? (batteries are magazines)

is_melee

🇲 Method --> ( DamageType ) -> boolean

Is this item an effective melee weapon for the given damage type?

is_owned_by

🇲 Method --> ( Character, boolean ) -> boolean

Checks if this item owned by a character

mod_damage

🇲 Method --> ( integer ) -> boolean
🇲 Method --> ( integer, DamageType ) -> boolean

Modify item damage by given amount. Returns true if item should be destroyed.

price

🇲 Method --> ( boolean ) -> number

Cents of the item. bool is whether it is a post-cataclysm value.

remaining_capacity_for_id

🇲 Method --> ( ItypeId, boolean ) -> integer

Gets the remaining space available for a type of liquid

remove_technique

🇲 Method --> ( MartialArtsTechniqueId )

Removes the additional technique. Doesn't affect originial techniques.

set_damage

🇲 Method --> ( integer )

Set item damage to specified value. Clamped between min_damage and max_damage.

set_owner

🇲 Method --> ( FactionId )

Sets the ownership of this item to a faction

set_owner

🇲 Method --> ( Character )

Sets the ownership of this item to a character

spawn

🇫 Function --> ( ItypeId, integer ) -> Detached<Item>

Spawns a new item. Same as gapi.create_item

tname

🇲 Method --> ( integer, boolean, integer ) -> string

Translated item name with prefixes

total_capacity

🇲 Method --> ( ) -> Volume

Gets maximum volume this item can hold (liquids, ammo, etc)

vars_table

🇲 Method --> ( ) -> table

Returns all stored item vars as a table

volume

🇲 Method --> ( boolean? ) -> Volume

Volume of the item. bool is whether it is integral_volume.

weight

🇲 Method --> ( boolean?, boolean? ) -> Mass

Weight of the item. The first bool is whether including contents, second bool is whether it is integral_weight.

ItemStack

Iterate over this using pairs() for reading. Can also be indexed.

Members

items

🇲 Method --> ( ) -> Item[]

Modifying the stack while iterating may cause problems. This returns a frozen copy of the items in the stack for safe modification of the stack (eg. removing items while iterating).

remove

🇲 Method --> ( Item ) -> Detached<Item>

ItypeId

Constructors

ItypeId.new( )
ItypeId.new( ItypeId )
ItypeId.new( string )

Members

ItypeRaw

Slots for various item type properties. Each slot may contain a valid value or nil

Members

attacks

🇻 Variable --> table<string, CppVal<attack_statblock>>

min_skills

🇻 Variable --> table<SkillId, integer>

qualities

🇻 Variable --> table<QualityId, integer>

techniques

🇻 Variable --> MartialArtsTechniqueId[]

has_flag

🇲 Method --> ( JsonFlagId ) -> boolean

JsonFlagId

Constructors

JsonFlagId.new( )
JsonFlagId.new( JsonFlagId )
JsonFlagId.new( string )

Members

JsonTraitFlagId

Constructors

JsonTraitFlagId.new( )
JsonTraitFlagId.new( JsonTraitFlagId )
JsonTraitFlagId.new( string )

Members

KnownMagic

Represents a character's spellbook and mana pool. Manages all spells known by a character, their mana, and spell learning/forgetting.

Members

casting_ignore

🇻 Variable --> boolean

Whether casting ignores all distractions. Can be read and written.

available_mana

🇲 Method --> ( ) -> integer

Get the current available mana.

can_learn_spell

🇲 Method --> ( Character, SpellTypeId ) -> boolean

Check if the character can learn a specific spell, considering traits and other restrictions.

forget_spell

🇲 Method --> ( SpellTypeId )

Forget a known spell by spell_id.

get_spell

🇲 Method --> ( SpellTypeId ) -> Spell

Get a reference to a known spell for editing. Returns the spell associated with the given spell_id.

get_spells

🇲 Method --> ( ) -> Spell[]

Get all known spells as a vector of spell pointers.

has_enough_energy

🇲 Method --> ( Character, Spell ) -> boolean

Check if the character has enough energy (of the appropriate type) to cast the given spell.

knows_spell

🇲 Method --> ( SpellTypeId ) -> boolean
🇲 Method --> ( ) -> boolean

Check if the character knows a specific spell by spell_id.

learn_spell

🇲 Method --> ( SpellTypeId, Character, boolean? )

Learn a new spell. Requires a Character reference and spell_id. Optional force(boolean) parameter bypasses restrictions.

mana_regen_rate

🇲 Method --> ( Character ) -> number

Get the mana regeneration rate in units per turn for the given character.

max_mana

🇲 Method --> ( Character ) -> integer

Get the maximum mana for the given character.

mod_mana

🇲 Method --> ( Character, integer )

Modify the current mana by adding or subtracting an amount.

set_mana

🇲 Method --> ( integer )

Set the current mana to a specific value.

spells

🇲 Method --> ( ) -> SpellTypeId[]

Get a vector of all known spell IDs.

time_to_learn_spell

🇲 Method --> ( Character, SpellTypeId ) -> integer

Calculate the time in moves required for the character to memorize/learn a spell.

Map

Members

abs_to_bub

🇲 Method --> ( TripointAbsMs ) -> TripointBubMs
🇲 Method --> ( TripointAbsSm ) -> TripointBubSm

Convert absolute coordinates to bubble coordinates.

add_field_at

🇲 Method --> ( TripointBubMs, FieldTypeIntId, integer, TimeDuration ) -> boolean

add_item

🇲 Method --> ( TripointBubMs, Detached<Item> ) -> Detached<Item>
🇲 Method --> ( Tripoint, Detached<Item> ) -> Detached<Item>

Places a detached item onto the map. Returns nil on success (item now owned by map), or returns the item back if placement failed.

ambient_light_at

🇲 Method --> ( TripointBubMs ) -> number

bub_to_abs

🇲 Method --> ( TripointBubMs ) -> TripointAbsMs
🇲 Method --> ( TripointBubSm ) -> TripointAbsSm

Convert bubble coordinates to absolute coordinates.

clear_items_at

🇲 Method --> ( TripointBubMs )
🇲 Method --> ( Tripoint )

create_corpse_at

🇲 Method --> ( TripointBubMs, MonsterTypeId?, TimePoint?, string?, integer? )

Creates a new corpse at a position on the map. You can skip Opt ones by omitting them or passing nil. MtypeId specifies which monster's body it is, <code>[TimePoint](#sol::TimePoint)</code> indicates when it died, string gives it a custom name, and int determines the revival time if the monster has the REVIVES flag.

create_item_at

🇲 Method --> ( TripointBubMs, ItypeId, integer )

Creates a new item(s) at a position on the map. Returns nil. Use gapi.create_item and Map:add_item to modify before placement.

detach_item_at

🇲 Method --> ( TripointBubMs, Item ) -> Detached<Item>
🇲 Method --> ( Tripoint, Item ) -> Detached<Item>

Removes an item from the map and returns it as a detached_ptr. The item is now owned by Lua - store it in a table to keep it alive, or let it be GC'd to destroy it. Use add_item to place it back on a map.

disarm_trap_at

🇲 Method --> ( TripointBubMs )

Disarms a trap using your skills and stats, with consequences depending on success or failure.

drain_vehicle_fuel_at

🇲 Method --> ( TripointBubMs, string, ItypeId, integer ) -> integer

Drains fuel charges from the vehicle when the position has a part with the given feature. Returns the charges drained.

get_field_age_at

🇲 Method --> ( TripointBubMs, FieldTypeIntId ) -> TimeDuration

get_field_int_at

🇲 Method --> ( TripointBubMs, FieldTypeIntId ) -> integer

get_field_name_at

🇲 Method --> ( TripointBubMs, FieldTypeIntId ) -> string

get_furn_at

🇲 Method --> ( TripointBubMs ) -> FurnIntId

get_items_at

🇲 Method --> ( TripointBubMs ) -> MapStack
🇲 Method --> ( Tripoint ) -> MapStack

get_items_in_radius

🇲 Method --> ( TripointBubMs, integer ) -> MapStack[]

get_map_size

🇲 Method --> ( ) -> integer

In map squares

get_temperature_c

🇲 Method --> ( TripointBubMs ) -> number

Get the local ambient temperature in degrees Celsius at a map-square position.

get_ter_at

🇲 Method --> ( TripointBubMs ) -> TerIntId

get_trap_at

🇲 Method --> ( TripointBubMs ) -> TrapIntId

get_vehicle_fuel_left_at

🇲 Method --> ( TripointBubMs, string, ItypeId, boolean? ) -> integer

Returns the vehicle's available fuel charges when the position has a part with the given feature.

get_vehicles

🇲 Method --> ( ) -> WrappedVehicle[]

Returns every vehicle currently on the map.

has_field_at

🇲 Method --> ( TripointBubMs, FieldTypeIntId ) -> boolean

has_flag_at

🇲 Method --> ( string, TripointBubMs ) -> boolean

has_furn_flag_at

🇲 Method --> ( string, TripointBubMs ) -> boolean

has_items_at

🇲 Method --> ( TripointBubMs ) -> boolean
🇲 Method --> ( Tripoint ) -> boolean

has_ter_flag_at

🇲 Method --> ( string, TripointBubMs ) -> boolean

has_vehicle_part_with_feature_at

🇲 Method --> ( TripointBubMs, string, boolean? ) -> boolean

Returns whether a vehicle at this position has an available part with the given feature.

is_in_sunlight

🇲 Method --> ( TripointBubMs ) -> boolean

is_ot_match

🇫 Function --> ( string, OterIntId, OtMatchType ) -> boolean

is_outside

🇲 Method --> ( TripointBubMs ) -> boolean

is_sheltered

🇲 Method --> ( TripointBubMs ) -> boolean

make_rubble

🇲 Method --> ( TripointBubMs, FurnIntId, TerIntId )

mod_field_age_at

🇲 Method --> ( TripointBubMs, FieldTypeIntId, TimeDuration ) -> TimeDuration

mod_field_int_at

🇲 Method --> ( TripointBubMs, FieldTypeIntId, integer ) -> integer

move_item_to

🇲 Method --> ( TripointBubMs, Item, TripointBubMs )

Moves an item from one position to another, preserving all item state including contents.

place_items

🇲 Method --> ( string, integer, PointBubMs, PointBubMs, boolean )

place_npc

🇲 Method --> ( PointBubMs, string ) -> Npc

Forcibly places an npc using a template at a position on the map. Returns the npc.

place_spawns

🇲 Method --> ( string, integer, PointBubMs, PointBubMs, number, boolean )

points_in_radius

🇲 Method --> ( TripointBubMs, integer, integer? ) -> TripointBubMs[]

Returns all points within a radius from the center point. radiusz defaults to 0.

remove_field_at

🇲 Method --> ( TripointBubMs, FieldTypeIntId )

remove_item_at

🇲 Method --> ( TripointBubMs, Item )
🇲 Method --> ( Tripoint, Item )

remove_trap_at

🇲 Method --> ( TripointBubMs )

Simpler version of set_trap_at with trap_null.

replace_vehicle

🇲 Method --> ( WrappedVehicle, string, table? ) -> boolean
🇲 Method --> ( TripointBubMs, string, table? ) -> boolean

Replaces a specific vehicle with a different prototype, preserving origin tile by default. Pass an optional table with orientation (Angle or degrees), status, and locks to override spawn settings.

set_field_age_at

🇲 Method --> ( TripointBubMs, FieldTypeIntId, TimeDuration, boolean ) -> TimeDuration

set_field_int_at

🇲 Method --> ( TripointBubMs, FieldTypeIntId, integer, boolean ) -> integer

set_furn_at

🇲 Method --> ( TripointBubMs, FurnIntId )

set_temperature

🇲 Method --> ( TripointBubMs, integer )

set_ter_at

🇲 Method --> ( TripointBubMs, TerIntId ) -> boolean

set_trap_at

🇲 Method --> ( TripointBubMs, TrapIntId )

Set a trap at a position on the map. It can also replace existing trap, even with trap_null.

spawn_artifact_at

🇲 Method --> ( TripointBubMs )

Spawns a random artifact at a position on the map.

spawn_natural_artifact_at

🇲 Method --> ( TripointBubMs, string? )

Spawns a natural artifact at a position on the map. Omit property to choose one at random.

MapStack

MapgenData

Members

above

🇲 Method --> ( ) -> OterIntId

Gets the oter id to the above.

below

🇲 Method --> ( ) -> OterIntId

Gets the oter id to the below.

east

🇲 Method --> ( ) -> OterIntId

Gets the oter id to the east.

fill_groundcover

🇲 Method --> ( )

Fills the ground with default terrain.

generate

🇲 Method --> ( string )

Generates Normal Mapgen

get_nesw

🇲 Method --> ( integer ) -> OterIntId

Returns t_nesw at index i

get_rot_suffix

🇲 Method --> ( ) -> string

Gets rotation string

get_rotation

🇲 Method --> ( ) -> integer

Gets rotation

id

🇲 Method --> ( ) -> OterIntId

Gets it's oter id.

neast

🇲 Method --> ( ) -> OterIntId

Gets the oter id to the neast.

nest

🇲 Method --> ( string, PointRelMs )

Generates Nested Mapgen

north

🇲 Method --> ( ) -> OterIntId

Gets the oter id to the north.

nwest

🇲 Method --> ( ) -> OterIntId

Gets the oter id to the nwest.

seast

🇲 Method --> ( ) -> OterIntId

Gets the oter id to the seast.

set_dir

🇲 Method --> ( integer, integer )

Sets the direction of the mapgen.

south

🇲 Method --> ( ) -> OterIntId

Gets the oter id to the south.

swest

🇲 Method --> ( ) -> OterIntId

Gets the oter id to the swest.

west

🇲 Method --> ( ) -> OterIntId

Gets the oter id to the west.

zlevel

🇲 Method --> ( ) -> integer

Gets the z-level that it is generated at.

MartialArtsBuffId

Constructors

MartialArtsBuffId.new( )
MartialArtsBuffId.new( MartialArtsBuffId )
MartialArtsBuffId.new( string )

Members

NULL_ID

🇫 Function --> ( ) -> MartialArtsBuffId

obj

🇲 Method --> ( ) -> MartialArtsBuffRaw

MartialArtsId

Constructors

MartialArtsId.new( )
MartialArtsId.new( MartialArtsId )
MartialArtsId.new( string )

Members

MartialArtsTechniqueId

Constructors

MartialArtsTechniqueId.new( )
MartialArtsTechniqueId.new( MartialArtsTechniqueId )
MartialArtsTechniqueId.new( string )

Members

NULL_ID

🇫 Function --> ( ) -> MartialArtsTechniqueId

obj

🇲 Method --> ( ) -> MartialArtsTechniqueRaw

MartialArtsTechniqueRaw

Members

Mass

Members

MaterialTypeId

Constructors

MaterialTypeId.new( )
MaterialTypeId.new( MaterialTypeId )
MaterialTypeId.new( string )

Members

MaterialTypeRaw

Members

Mission

Members

assign

🇲 Method --> ( Avatar )

Assigns this mission to the given avatar.

get_deadline

🇲 Method --> ( ) -> TimePoint

Returns the mission's deadline as a time_point.

get_description

🇲 Method --> ( ) -> string

Returns the mission description.

get_follow_up

🇲 Method --> ( ) -> MissionTypeIdRaw

Returns the follow-up mission type ID.

get_id

🇲 Method --> ( ) -> integer

Returns the mission's unique ID.

get_item_id

🇲 Method --> ( ) -> ItypeId

Returns the item ID associated with the mission.

get_likely_rewards

🇲 Method --> ( ) -> (integer, ItypeId)[]

Returns the likely rewards of the mission (vector of (int chance, itype_id) pairs).

get_npc_id

🇲 Method --> ( ) -> CharacterId

Returns the NPC character ID associated with the mission.

get_target_point

🇲 Method --> ( ) -> TripointAbsOmt

Returns the target of the mission as absolute overmap terrain coordinates.

get_type

🇲 Method --> ( ) -> MissionType

Returns the mission type of the target (pointer to mission_type).

get_value

🇲 Method --> ( ) -> integer

Returns the mission's value as an integer.

has_deadline

🇲 Method --> ( ) -> boolean

Returns true if the mission has a deadline.

has_failed

🇲 Method --> ( ) -> boolean

Returns true if the mission has failed.

has_follow_up

🇲 Method --> ( ) -> boolean

Returns true if the mission has a follow-up mission.

has_generic_rewards

🇲 Method --> ( ) -> boolean

Returns true if the mission has generic rewards.

has_target

🇲 Method --> ( ) -> boolean

Returns true if the mission has a target.

in_progress

🇲 Method --> ( ) -> boolean

Returns true if the mission is currently in progress.

is_assigned

🇲 Method --> ( ) -> boolean

Returns true if the mission is currently assigned.

is_complete

🇲 Method --> ( CharacterId? ) -> boolean

Returns true if the mission goal has been completed (optionally checked against given NPC ID).

mission_id

🇲 Method --> ( ) -> MissionTypeIdRaw

Returns the mission type ID of this mission.

name

🇲 Method --> ( ) -> string

Returns the mission's name as a string.

reserve_new

🇫 Function --> ( MissionTypeIdRaw, CharacterId ) -> Mission

Reserves a new mission of the given type for the specified NPC. Returns the new mission.

reserve_random

🇫 Function --> ( MissionOrigin, TripointAbsOmt, CharacterId ) -> Mission

Reserves a random mission at the specified origin and position for the given NPC. Returns the new mission.

step_complete

🇲 Method --> ( integer )

Marks a mission step as complete, taking an integer step index.

wrap_up

🇲 Method --> ( )

Wraps up the mission successfully.

MissionType

Members

deadline_high

🇻 Variable --> TimeDuration

Returns the maximum allowed deadline for the mission.

deadline_low

🇻 Variable --> TimeDuration

Returns the minimum allowed deadline for the mission.

description

🇻 Variable --> CppVal<translation>

Returns the mission's description as a string.

dialogue

🇻 Variable --> table<string, CppVal<translation>>

Returns any associated dialogue for the mission.

difficulty

🇻 Variable --> integer

Returns the mission's difficulty as an integer.

empty_container

🇻 Variable --> ItypeId

Returns true if the mission requires the container to be empty.

follow_up

🇻 Variable --> MissionTypeIdRaw

Returns any follow-up mission type ID.

goal

🇻 Variable --> MissionGoal

Returns the mission's goal text.

has_generic_rewards

🇻 Variable --> boolean

Returns true if the mission has generic rewards.

item_count

🇻 Variable --> integer

Returns the count of items involved in the mission.

item_id

🇻 Variable --> ItypeId

Returns the ID of the mission's main item target, if applicable.

likely_rewards

🇻 Variable --> (integer, ItypeId)[]

Returns a vector of likely rewards (chance, itype_id pairs).

monster_kill_goal

🇻 Variable --> integer

Returns the number of monsters required to kill for this mission.

monster_type

🇻 Variable --> MonsterTypeId

Returns the monster type associated with the mission, if any.

origins

🇻 Variable --> MissionOrigin[]

Returns a list of origins from which this mission can be generated.

remove_container

🇻 Variable --> boolean

Returns true if the mission requires removing a container.

target_npc_id

🇻 Variable --> CharacterId

Returns the ID of the target NPC for the mission, if any.

urgent

🇻 Variable --> boolean

Returns true if the mission is marked as urgent.

value

🇻 Variable --> integer

Returns the mission's reward value as an integer.

get_all

🇫 Function --> ( ) -> MissionType[]

Returns all available missions.

get_random_mission_id

🇫 Function --> ( MissionOrigin, TripointAbsOmt ) -> MissionTypeIdRaw

Returns a random mission type ID at the specified origin and overmap tile position.

MissionTypeIdRaw

ModInfoId

Constructors

ModInfoId.new( )
ModInfoId.new( ModInfoId )
ModInfoId.new( string )

Members

Mongroup

Members

abs_pos

🇲 Method --> ( ) -> TripointAbsSm

Get the group position in absolute submap coordinates.

avg_speed

🇲 Method --> ( ) -> number

Average movement speed of monsters in the group.

clear

🇲 Method --> ( )

Remove all monsters and clear population.

dec_interest

🇲 Method --> ( integer )

Decrease horde interest by the given amount (clamped 15..100).

inc_interest

🇲 Method --> ( integer )

Increase horde interest by the given amount (clamped 15..100).

is_empty

🇲 Method --> ( ) -> boolean

Check if the group has no members or population.

is_safe

🇲 Method --> ( ) -> boolean

Check if the group is safe.

monsters

🇲 Method --> ( ) -> Monster[]

Get individual monster instances tracked inside the horde (if any).

nemesis_target

🇲 Method --> ( ) -> TripointAbsSm

Get the nemesis target for this group.

set_interest

🇲 Method --> ( integer )

Set horde interest directly (clamped 15..100).

set_nemesis_target

🇲 Method --> ( TripointAbsSm )

Set the nemesis target for this group using absolute submap coordinates.

set_pos

🇲 Method --> ( TripointAbsSm )

Set the group position in absolute submap coordinates.

set_target

🇲 Method --> ( TripointAbsSm )

Set the current target in absolute submap coordinates.

target

🇲 Method --> ( ) -> TripointAbsSm

Get the current target in absolute submap coordinates.

Monster

Members

attitude

🇲 Method --> ( Character ) -> MonsterAttitude

bash_at

🇲 Method --> ( TripointBubMs ) -> boolean
🇲 Method --> ( Tripoint ) -> boolean

heal

🇲 Method --> ( integer, boolean ) -> integer

move_to

🇲 Method --> ( TripointBubMs, boolean, boolean, number ) -> boolean
🇲 Method --> ( Tripoint, boolean, boolean, number ) -> boolean

remove_item

🇲 Method --> ( Item ) -> Detached<Item>

set_move_target

🇲 Method --> ( TripointBubMs )
🇲 Method --> ( Tripoint )

wander_to

🇲 Method --> ( TripointBubMs, integer )

MonsterFactionId

Constructors

MonsterFactionId.new( )
MonsterFactionId.new( MonsterFactionId )
MonsterFactionId.new( MonsterFactionIntId )
MonsterFactionId.new( string )

Members

NULL_ID

🇫 Function --> ( ) -> MonsterFactionId

int_id

🇲 Method --> ( ) -> MonsterFactionIntId

MonsterFactionIntId

Constructors

MonsterFactionIntId.new( )
MonsterFactionIntId.new( MonsterFactionIntId )
MonsterFactionIntId.new( MonsterFactionId )

Members

MonsterGroupEntry

Members

MonsterGroupId

Constructors

MonsterGroupId.new( )
MonsterGroupId.new( MonsterGroupId )
MonsterGroupId.new( string )

Members

MonsterGroupRaw

Members

contains

🇲 Method --> ( MonsterTypeId ) -> boolean

Check if a monster type appears in this group.

MonsterTypeId

Constructors

MonsterTypeId.new( )
MonsterTypeId.new( MonsterTypeId )
MonsterTypeId.new( string )

Members

MonsterTypeRaw

Members

MoraleTypeDataId

Constructors

MoraleTypeDataId.new( )
MoraleTypeDataId.new( MoraleTypeDataId )
MoraleTypeDataId.new( string )

Members

NULL_ID

🇫 Function --> ( ) -> MoraleTypeDataId

MutationBranchId

Constructors

MutationBranchId.new( )
MutationBranchId.new( MutationBranchId )
MutationBranchId.new( string )

Members

NULL_ID

🇫 Function --> ( ) -> MutationBranchId

MutationBranchRaw

Members

activated

🇻 Variable --> boolean

Whether this mutation can be activated at will.

allow_soft_gear

🇻 Variable --> boolean

Mutation allows soft gear to be worn over otherwise-restricted parts.

construction_speed_modifier

🇻 Variable --> number

Construction speed multiplier. 2.0 doubles construction speed; 0.5 halves it.

cooldown

🇻 Variable --> integer

Costs are incurred every 'cooldown' turns.

crafting_speed_modifier

🇻 Variable --> number

Crafting speed multiplier. 2.0 doubles crafting speed; 0.5 halves it.

debug

🇻 Variable --> boolean

Whether or not this mutation is limited to debug use.

fatigue

🇻 Variable --> boolean

Mutation causes fatigue when used.

healing_awake

🇻 Variable --> number

Healing per turn from mutation.

healing_resting

🇻 Variable --> number

Healing per turn from mutation, while asleep.

healthy_rate

🇻 Variable --> number

How quickly health (not HP) trends toward healthy_mod.

hp_adjustment

🇻 Variable --> number

Flat adjustment to HP.

hp_modifier

🇻 Variable --> number

Bonus HP multiplier. 1.0 doubles HP; -0.5 halves it.

hp_modifier_secondary

🇻 Variable --> number

Secondary HP multiplier; stacks with the other one. 1.0 doubles HP; -0.5 halves it.

hunger

🇻 Variable --> boolean

Mutation deducts calories when used.

mending_modifier

🇻 Variable --> number

Multiplier applied to broken limb regeneration. Normally 0.25; clamped to 0.25..1.0.

mixed_effect

🇻 Variable --> boolean

Whether this mutation has positive /and/ negative effects.

packmule_modifier

🇻 Variable --> number

Packmule multiplier. 2.0 doubles backpack/container volume; 0.5 halves it.

pain_recovery

🇻 Variable --> number

Pain recovery per turn from mutation.

player_display

🇻 Variable --> boolean

Whether or not this mutation shows up in the status (@) menu.

points

🇻 Variable --> integer

Point cost in character creation(?).

profession

🇻 Variable --> boolean

Whether this trait is ONLY gained through professional training/experience (and/or quests).

purifiable

🇻 Variable --> boolean

Whether this mutation is possible to remove through Purifier. False for 'special' mutations.

starting_trait

🇻 Variable --> boolean

Whether this trait can normally be taken during character generation.

starts_active

🇻 Variable --> boolean

Whether a mutation activates when granted.

str_modifier

🇻 Variable --> number

Adjustment to Strength that doesn't affect HP.

thirst

🇻 Variable --> boolean

Mutation dehydrates when used.

threshold

🇻 Variable --> boolean

Whether this is a Threshold mutation, and thus especially difficult to mutate. One per character.

ugliness

🇻 Variable --> integer

How physically unappealing the mutation is. Can be negative.

valid

🇻 Variable --> boolean

Whether this mutation is available through generic mutagen.

visibility

🇻 Variable --> integer

How visible the mutation is to others.

addition_mutations

🇲 Method --> ( ) -> MutationBranchId[]

conflicts_with

🇲 Method --> ( ) -> MutationBranchId[]

Lists conflicting mutations.

get_all

🇫 Function --> ( ) -> MutationBranchRaw[]

Returns a (long) list of every mutation in the game.

mutation_types

🇲 Method --> ( ) -> string[]

Lists the type(s) of this mutation. Mutations of a given type are mutually exclusive.

other_prerequisites

🇲 Method --> ( ) -> MutationBranchId[]

Lists the secondary mutation(s) needed to gain this mutation.

prerequisites

🇲 Method --> ( ) -> MutationBranchId[]

Lists the primary mutation(s) needed to gain this mutation.

replaced_by

🇲 Method --> ( ) -> MutationBranchId[]

Lists mutations that replace (e.g. evolve from) this one.

thresh_requirements

🇲 Method --> ( ) -> MutationBranchId[]

Lists the threshold mutation(s) required to gain this mutation.

MutationCategoryTraitId

Constructors

MutationCategoryTraitId.new( )
MutationCategoryTraitId.new( MutationCategoryTraitId )
MutationCategoryTraitId.new( string )

Members

NULL_ID

🇫 Function --> ( ) -> MutationCategoryTraitId

obj

🇲 Method --> ( ) -> MutationCategoryTraitRaw

Npc

Members

can_move_to

🇲 Method --> ( TripointBubMs, boolean ) -> boolean

can_open_door

🇲 Method --> ( TripointBubMs, boolean ) -> boolean

complain

🇲 Method --> ( ) -> boolean

Finds something to complain about and complains. Returns if complained.

complain_about

🇲 Method --> ( string, TimeDuration, string, boolean? ) -> boolean

Complain about an issue if enough time has passed. The first string is the issue identifier, with the second being the complaint text. The optional bool allows you to force a complaint without concern for the input time.

current_ally

🇲 Method --> ( ) -> Creature

Returns the npc's current ally, if it has one.

current_target

🇲 Method --> ( ) -> Creature

Returns the npc's current target as a creature, if it has one.

danger_assessment

🇲 Method --> ( ) -> number

Gets a value based on the npc's perspective of the area's danger.

evaluate_enemy

🇲 Method --> ( Creature ) -> number

Rates how dangerous a target is from 0 (harmless) to 1 (max danger).

follow_distance

🇲 Method --> ( ) -> integer

Gets the npc's follow distance. This can only be a few values, and is determined by npc rules.

get_first_topic

🇲 Method --> ( ) -> string

Returns the first topic of the npc's chatbin.

get_monster_faction

🇲 Method --> ( ) -> MonsterFactionIntId

Returns the npc's faction id. If it's part of a monster faction, it returns the id of the monster faction.

guaranteed_hostile

🇲 Method --> ( ) -> boolean

Returns true if the npc would be hostile to the player on sight regardless of their current attitude.

is_minion

🇲 Method --> ( ) -> boolean

Returns true if the npc is a player ally and their op_of_u.trust is >= 5.

is_simulated

🇲 Method --> ( ) -> boolean

True if this NPC is in a simulated (fully loaded, AI-eligible) submap.

is_travelling

🇲 Method --> ( ) -> boolean

Returns true if the npc has the 'NPC_MISSION_TRAVELLING' mission.

move_to

🇲 Method --> ( TripointBubMs, boolean? )

Attempts to move the NPC to an adjacent map square.

mutiny

🇲 Method --> ( )

Causes the npc to leave your faction, incur various negative opinion maluses, and say explatives to the player.

npc_menu

🇲 Method --> ( boolean? )

Triggers the npc menu to open.

say

🇲 Method --> ( string )

Has the npc say the given string in the sidebar.

set_first_topic

🇲 Method --> ( string )

Sets the first topic of the npc's chatbin. Note that some circumstances may cause this to not be the first topic used, such as player allies.

set_move_target

🇲 Method --> ( TripointBubMs, boolean?, boolean? ) -> boolean
🇲 Method --> ( Tripoint, boolean?, boolean? ) -> boolean

smash_ability

🇲 Method --> ( ) -> integer

Gets the npc's blunt damage with their currently equipped weapon.

talk_to_u

🇲 Method --> ( string?, boolean? )

Causes the npc to talk to you. Passing a topic will force that topic to be used in place of all others, including code enforced topics such as 'TALK_STOLE_ITEM'.

warn_about

🇲 Method --> ( string, TimeDuration, string, integer, TripointBubMs )

Wrapper for complain_about that warns about a specific type of threat, with different warnings for hostile or friendly NPCs and hostile NPCs always complaining.

NpcOpinion

Constructors

NpcOpinion.new( )
NpcOpinion.new( int, int, int, int, int )

Members

NpcPersonality

Members

OmtFindParams

Members

exclude_types

🇻 Variable --> (string, OtMatchType)[]

Vector of (terrain_type, match_type) pairs to exclude from search.

existing_only

🇻 Variable --> boolean

If true, restricts search to existing overmaps only.

explored

🇻 Variable --> boolean?

If set, filters by terrain explored status (true = explored only, false = unexplored only).

max_results

🇻 Variable --> integer?

If set, limits the number of results returned.

seen

🇻 Variable --> boolean?

If set, filters by terrain seen status (true = seen only, false = unseen only).

types

🇻 Variable --> (string, OtMatchType)[]

Vector of (terrain_type, match_type) pairs to search for.

add_exclude_type

🇲 Method --> ( string, OtMatchType )

Helper method to add a terrain type to exclude from search.

add_type

🇲 Method --> ( string, OtMatchType )

Helper method to add a terrain type to search for.

set_search_layers

🇲 Method --> ( integer, integer )

Set the search layer range (z-levels).

set_search_range

🇲 Method --> ( integer, integer )

Set the search range in overmap tiles (min, max).

OterId

Constructors

OterId.new( )
OterId.new( OterId )
OterId.new( OterIntId )
OterId.new( string )

Members

OterIntId

Constructors

OterIntId.new( )
OterIntId.new( OterIntId )
OterIntId.new( OterId )

Members

OvermapBuffer

Global overmap buffer that manages all overmap data

Members

add_grid_connection

🇲 Method --> ( TripointAbsOmt, TripointAbsOmt ) -> boolean

Add an electric grid connection between two positions

electric_grid_at

🇲 Method --> ( TripointAbsOmt ) -> TripointAbsOmt[]

Get all overmap tiles belonging to the electric grid at the given position

electric_grid_connectivity_at

🇲 Method --> ( TripointAbsOmt ) -> TripointRelOmt[]

Get all electric grid connections from the given position

remove_grid_connection

🇲 Method --> ( TripointAbsOmt, TripointAbsOmt ) -> boolean

Remove an electric grid connection between two positions

Player

PlayerActivity

Members

Point

Constructors

Point.new( )
Point.new( Point )
Point.new( int, int )

Members

reinterpret_as

🇲 Method --> ( origin: string, scale: string ) -> PointCoord

Reinterpret this raw point as a typed point coordinate without changing x or y.

rotate

🇲 Method --> ( integer, Point ) -> Point

PointCoord

A typed two-dimensional coordinate. Its origin and scale describe how to interpret x and y, and coordinate operations only combine compatible coordinate spaces.

Members

project_combine

🇲 Method --> ( fine: any ) -> nil | PointCoord | TripointCoord

Combines this coarse point with a remainder from project_remain. Returns PointCoord or TripointCoord depending on the inputs, or nil if the pair is incompatible.

project_remain

🇲 Method --> ( scale: string ) -> (PointCoord?, PointCoord?)

Splits this point into a coarse PointCoord at the requested scale and a PointCoord remainder at this point's original scale. Returns nil, nil if the split is not valid.

project_remain_mmr

🇲 Method --> ( ) -> (PointCoord?, PointCoord?)

Shortcut for project_remain("mmr").

project_remain_om

🇲 Method --> ( ) -> (PointCoord?, PointCoord?)

Shortcut for project_remain("om").

project_remain_omt

🇲 Method --> ( ) -> (PointCoord?, PointCoord?)

Shortcut for project_remain("omt").

project_remain_seg

🇲 Method --> ( ) -> (PointCoord?, PointCoord?)

Shortcut for project_remain("seg").

project_remain_sm

🇲 Method --> ( ) -> (PointCoord?, PointCoord?)

Shortcut for project_remain("sm").

reinterpret_as

🇲 Method --> ( origin: string, scale: string ) -> PointCoord

Reinterpret this coordinate as another point coordinate kind without changing x or y.

rl_dist

🇲 Method --> ( other: PointCoord ) -> integer?

Rectilinear distance to another PointCoord with matching origin and scale. Returns nil if the argument is incompatible.

rotate

🇲 Method --> ( integer, Point ) -> PointCoord

square_dist

🇲 Method --> ( other: PointCoord ) -> integer?

Chebyshev distance to another PointCoord with matching origin and scale. Returns nil if the argument is incompatible.

to

🇲 Method --> ( scale: string ) -> PointCoord?

Projects this coordinate to another scale, preserving its origin and point dimension. Returns nil if the conversion is not valid.

to_mmr

🇲 Method --> ( ) -> PointCoord?

Shortcut for to("mmr").

to_ms

🇲 Method --> ( ) -> PointCoord?

Shortcut for to("ms").

to_om

🇲 Method --> ( ) -> PointCoord?

Shortcut for to("om").

to_omt

🇲 Method --> ( ) -> PointCoord?

Shortcut for to("omt").

to_seg

🇲 Method --> ( ) -> PointCoord?

Shortcut for to("seg").

to_sm

🇲 Method --> ( ) -> PointCoord?

Shortcut for to("sm").

to_veh

🇲 Method --> ( ) -> PointCoord?

Shortcut for to("veh").

trig_dist

🇲 Method --> ( other: PointCoord ) -> number?

Euclidean distance to another PointCoord with matching origin and scale. Returns nil if the argument is incompatible.

PopupInputStr

Members

desc

🇲 Method --> ( string )

desc is above input field.

query_int

🇲 Method --> ( ) -> integer

Returns your input, but allows numbers only.

query_str

🇲 Method --> ( ) -> string

Returns your input.

title

🇲 Method --> ( string )

title is on the left of input field.

PowerStat

Power generation and consumption statistics for a grid

Members

gen_w

🇻 Variable --> integer

Power generation in watts

use_w

🇻 Variable --> integer

Power consumption in watts

net_w

🇲 Method --> ( ) -> integer

Net power (generation - consumption) in watts

QualityId

Constructors

QualityId.new( )
QualityId.new( QualityId )
QualityId.new( string )

Members

QueryPopup

Members

allow_any_key

🇲 Method --> ( boolean )

Set whether to allow any key

query

🇲 Method --> ( ) -> string

Returns selected action

query_yn

🇲 Method --> ( ) -> string

Returns YES or NO. If ESC pressed, returns NO.

query_ynq

🇲 Method --> ( ) -> string

Returns YES, NO or QUIT. If ESC pressed, returns QUIT.

RangedData

Members

RecipeId

Constructors

RecipeId.new( )
RecipeId.new( RecipeId )
RecipeId.new( string )

Members

RecipeRaw

Members

booksets

🇻 Variable --> table<ItypeId, integer>

learn_by_disassembly

🇻 Variable --> table<SkillId, integer>

required_skills

🇻 Variable --> table<SkillId, integer>

get_from_flag

🇫 Function --> ( string ) -> RecipeRaw[]

get_from_skill_used

🇫 Function --> ( SkillId ) -> RecipeRaw[]

Relic

Members

get_enchantments

🇲 Method --> ( ) -> CppVal<enchantment>[]

get_recharge_scheme

🇲 Method --> ( ) -> CppVal<relic_recharge>[]

RequirementData

Represents crafting requirements (tools, components, qualities)

Members

can_make_with_inventory

🇲 Method --> ( Inventory ) -> boolean

Check if requirements can be made with given inventory

get_components

🇲 Method --> ( ) -> CppVal<item_comp>[][]

Get list of all required components

get_qualities

🇲 Method --> ( ) -> CppVal<quality_requirement>[][]

Get list of all required qualities

get_tools

🇲 Method --> ( ) -> CppVal<tool_comp>[][]

Get list of all required tools

id

🇲 Method --> ( ) -> string

Get the requirement ID as string

is_blacklisted

🇲 Method --> ( ) -> boolean

Check if this requirement is blacklisted

is_empty

🇲 Method --> ( ) -> boolean

Check if this requirement is empty

is_null

🇲 Method --> ( ) -> boolean

Check if this is a null requirement

list_all

🇲 Method --> ( ) -> string

Get a formatted list of all requirements

list_missing

🇲 Method --> ( ) -> string

Get a formatted list of missing requirements

Resistances

Members

get_all_resist

🇲 Method --> ( ) -> table<DamageType, number>

SkillId

Constructors

SkillId.new( )
SkillId.new( SkillId )
SkillId.new( string )

Members

SkillLevel

Members

SkillLevelMap

Members

get_skill_level_object

🇲 Method --> ( SkillId ) -> SkillLevel

SpeciesTypeId

Constructors

SpeciesTypeId.new( )
SpeciesTypeId.new( SpeciesTypeId )
SpeciesTypeId.new( string )

Members

Spell

The class used for spells that a player knows, casts, and gains experience for using. If a given spell is not supposed to be directly cast by a player, consider using SpellSimple instead.

Members

cast

🇲 Method --> ( Creature, TripointBubMs )

Cast this spell, as well as any sub-spells.

cast_single_effect

🇲 Method --> ( Creature, TripointBubMs )

Cast only this spell's main effects. Generally, cast() should be used instead.

SpellSimple

The type for basic spells. If you don't need to track XP from casting (e.g., if a spell is intended to be cast by anything other than a player), this is likely the appropriate type. Otherwise, see the Spell type.

Constructors

SpellSimple.new( SpellTypeId, bool )
SpellSimple.new( SpellTypeId, bool, int )

Members

force_target_source

🇻 Variable --> boolean

Whether or not the target point is locked to the source's location.

trigger_once_in

🇻 Variable --> integer

Used for enchantments; the spell's chance to trigger every turn.

cast

🇲 Method --> ( Creature, TripointBubMs, integer? )

max_level

🇲 Method --> ( ) -> integer

Returns the defined maximum level of this SpellSimple instance, if defined. Otherwise, returns 0.

prompt_cast

🇫 Function --> ( SpellTypeId, TripointBubMs, integer? ) -> SpellSimple

Static function: Creates and immediately casts a SimpleSpell, then returns the new spell for potential reuse. If the given tripoint is the player's location, the spell will be locked to the player. (This does not necessarily cause friendly fire!) If an integer is specified, the spell will be cast at that level.

SpellTypeId

Constructors

SpellTypeId.new( )
SpellTypeId.new( SpellTypeId )
SpellTypeId.new( string )

Members

SpellTypeRaw

The 'raw' type for storing the information defining every spell in the game. It's not possible to cast directly from this type; check SpellSimple and Spell.

Members

effect_name

🇻 Variable --> string

The name of the primary effect this spell will enact.

effect_str

🇻 Variable --> string

Specifics about the effect this spell will enact.

additional_spells

🇲 Method --> ( ) -> SpellSimple[]

Other spells cast by this spell.

get_all

🇫 Function --> ( ) -> SpellTypeRaw[]

Returns a (long) list of every spell in the game.

TerId

Constructors

TerId.new( )
TerId.new( TerId )
TerId.new( TerIntId )
TerId.new( string )

Members

TerIntId

Constructors

TerIntId.new( )
TerIntId.new( TerIntId )
TerIntId.new( TerId )

Members

TerRaw

Members

TimeDuration

Represent duration between 2 fixed points in time

Members

from_days

🇫 Function --> ( integer ) -> TimeDuration

from_hours

🇫 Function --> ( integer ) -> TimeDuration

from_minutes

🇫 Function --> ( integer ) -> TimeDuration

from_seconds

🇫 Function --> ( integer ) -> TimeDuration

from_turns

🇫 Function --> ( integer ) -> TimeDuration

from_weeks

🇫 Function --> ( integer ) -> TimeDuration

make_random

🇲 Method --> ( TimeDuration ) -> TimeDuration

TimePoint

Library for dealing with time primitives.
Represent fixed point in time

Members

from_turn

🇫 Function --> ( integer ) -> TimePoint

TrapId

Constructors

TrapId.new( )
TrapId.new( TrapId )
TrapId.new( TrapIntId )
TrapId.new( string )

Members

TrapIntId

Constructors

TrapIntId.new( )
TrapIntId.new( TrapIntId )
TrapIntId.new( TrapId )

Members

Tripoint

Constructors

Tripoint.new( )
Tripoint.new( Point, int )
Tripoint.new( Tripoint )
Tripoint.new( int, int, int )

Members

reinterpret_as

🇲 Method --> ( origin: string, scale: string ) -> TripointCoord

Reinterpret this raw tripoint as a typed tripoint coordinate without changing x, y, or z.

rotate_2d

🇲 Method --> ( integer, Point ) -> Tripoint

TripointCoord

A typed three-dimensional coordinate. Its origin and scale describe how to interpret x, y, and z, and coordinate operations only combine compatible coordinate spaces.

Members

project_combine

🇲 Method --> ( fine: any ) -> nil | PointCoord | TripointCoord

Combines this coarse tripoint with a remainder from project_remain. Returns TripointCoord, or nil if the pair is incompatible.

project_remain

🇲 Method --> ( scale: string ) -> (TripointCoord?, PointCoord?)

Splits this tripoint into a coarse TripointCoord at the requested scale and a PointCoord remainder at this tripoint's original scale. The z value stays on the coarse tripoint. Returns nil, nil if the split is not valid.

project_remain_mmr

🇲 Method --> ( ) -> (TripointCoord?, PointCoord?)

Shortcut for project_remain("mmr").

project_remain_om

🇲 Method --> ( ) -> (TripointCoord?, PointCoord?)

Shortcut for project_remain("om").

project_remain_omt

🇲 Method --> ( ) -> (TripointCoord?, PointCoord?)

Shortcut for project_remain("omt").

project_remain_seg

🇲 Method --> ( ) -> (TripointCoord?, PointCoord?)

Shortcut for project_remain("seg").

project_remain_sm

🇲 Method --> ( ) -> (TripointCoord?, PointCoord?)

Shortcut for project_remain("sm").

reinterpret_as

🇲 Method --> ( origin: string, scale: string ) -> TripointCoord

Reinterpret this coordinate as another tripoint coordinate kind without changing x, y, or z.

rl_dist

🇲 Method --> ( other: TripointCoord ) -> integer?

Rectilinear distance to another TripointCoord with matching origin and scale. Returns nil if the argument is incompatible.

rotate_2d

🇲 Method --> ( integer, Point ) -> TripointCoord

square_dist

🇲 Method --> ( other: TripointCoord ) -> integer?

Chebyshev distance to another TripointCoord with matching origin and scale. Returns nil if the argument is incompatible.

to

🇲 Method --> ( scale: string ) -> TripointCoord?

Projects this coordinate to another scale, preserving its origin and tripoint dimension. Returns nil if the conversion is not valid.

to_mmr

🇲 Method --> ( ) -> TripointCoord?

Shortcut for to("mmr").

to_ms

🇲 Method --> ( ) -> TripointCoord?

Shortcut for to("ms").

to_om

🇲 Method --> ( ) -> TripointCoord?

Shortcut for to("om").

to_omt

🇲 Method --> ( ) -> TripointCoord?

Shortcut for to("omt").

to_seg

🇲 Method --> ( ) -> TripointCoord?

Shortcut for to("seg").

to_sm

🇲 Method --> ( ) -> TripointCoord?

Shortcut for to("sm").

to_veh

🇲 Method --> ( ) -> TripointCoord?

Shortcut for to("veh").

trig_dist

🇲 Method --> ( other: TripointCoord ) -> number?

Euclidean distance to another TripointCoord with matching origin and scale. Returns nil if the argument is incompatible.

UiList

Members

entries

🇻 Variable --> UiListEntry[]

Entries from uilist. Remember, in lua, the first element of vector is entries[1], not entries[0].

add

🇲 Method --> ( integer, string )

Adds an entry. string is its name, and int is what it returns. If int is -1, the number is decided orderly.

add_w_col

🇲 Method --> ( integer, string, string, string )

Adds an entry with desc and col(third string). col is additional text on the right of the entry name.

add_w_desc

🇲 Method --> ( integer, string, string )

Adds an entry with desc(second string). desc_enabled(true) is required for showing desc.

border_color

🇲 Method --> ( Color )

Changes the color. Default color is c_magenta.

desc_enabled

🇲 Method --> ( boolean )

Puts a lower box. Footer or entry desc appears on it.

🇲 Method --> ( string )

Sets footer text which is in lower box. It overwrites descs of entries unless is empty.

hilight_color

🇲 Method --> ( Color )

Changes the color. Default color is h_white.

hotkey_color

🇲 Method --> ( Color )

Changes the color. Default color is c_light_green.

query

🇲 Method --> ( ) -> integer

Returns retval for selected entry, or a negative number on fail/cancel

text

🇲 Method --> ( string )

Sets text which is in upper box.

text_color

🇲 Method --> ( Color )

Changes the color. Default color is c_light_gray.

title

🇲 Method --> ( string )

Sets title which is on the top line.

title_color

🇲 Method --> ( Color )

Changes the color. Default color is c_green.

UiListEntry

This type came from UiList.

Members

ctxt

🇻 Variable --> string

Entry text of column.

desc

🇻 Variable --> string

Entry description

enable

🇻 Variable --> boolean

Entry whether it's enabled or not. Default is true.

txt_color

🇲 Method --> ( Color )

Entry text color. Its default color is c_red_red, which makes color of the entry same as what uilist decides. So if you want to make color different, choose one except c_red_red.

VitaminId

Constructors

VitaminId.new( )
VitaminId.new( VitaminId )
VitaminId.new( string )

Members

VitaminRaw

Members

Volume

Members

WeaponCategoryId

Constructors

WeaponCategoryId.new( )
WeaponCategoryId.new( WeaponCategoryId )
WeaponCategoryId.new( string )

Members

NULL_ID

🇫 Function --> ( ) -> WeaponCategoryId

WrappedVehicle

Members

pos

🇲 Method --> ( ) -> TripointBubMs

Returns the vehicle origin tile in local map-square coordinates.

type

🇲 Method --> ( ) -> string

Returns the vehicle prototype id string.

Enums

ActionId

Entries

ACTION_NULL = 0
ACTION_SELECT = 1
ACTION_SEC_SELECT = 2
ACTION_PAUSE = 3
ACTION_TIMEOUT = 4
ACTION_MOVE_FORTH = 5
ACTION_MOVE_FORTH_RIGHT = 6
ACTION_MOVE_RIGHT = 7
ACTION_MOVE_BACK_RIGHT = 8
ACTION_MOVE_BACK = 9
ACTION_MOVE_BACK_LEFT = 10
ACTION_MOVE_LEFT = 11
ACTION_MOVE_FORTH_LEFT = 12
ACTION_MOVE_DOWN = 13
ACTION_MOVE_UP = 14
ACTION_CYCLE_MOVE = 15
ACTION_RESET_MOVE = 16
ACTION_TOGGLE_RUN = 17
ACTION_TOGGLE_CROUCH = 18
ACTION_OPEN_MOVEMENT = 19
ACTION_TOGGLE_MAP_MEMORY = 20
ACTION_CENTER = 21
ACTION_SHIFT_N = 22
ACTION_SHIFT_NE = 23
ACTION_SHIFT_E = 24
ACTION_SHIFT_SE = 25
ACTION_SHIFT_S = 26
ACTION_SHIFT_SW = 27
ACTION_SHIFT_W = 28
ACTION_SHIFT_NW = 29
ACTION_OPEN = 30
ACTION_CLOSE = 31
ACTION_SMASH = 32
ACTION_EXAMINE = 33
ACTION_PICKUP = 34
ACTION_PICKUP_ALL = 35
ACTION_PICKUP_FEET = 36
ACTION_GRAB = 37
ACTION_HAUL = 38
ACTION_BUTCHER = 39
ACTION_CHAT = 40
ACTION_LOOK = 41
ACTION_PEEK = 42
ACTION_LIST_ITEMS = 43
ACTION_ZONES = 44
ACTION_LOOT = 45
ACTION_INVENTORY = 46
ACTION_ADVANCEDINV = 47
ACTION_COMPARE = 48
ACTION_ORGANIZE = 49
ACTION_USE = 50
ACTION_USE_WIELDED = 51
ACTION_WEAR = 52
ACTION_TAKE_OFF = 53
ACTION_EAT = 54
ACTION_OPEN_CONSUME = 55
ACTION_READ = 56
ACTION_WIELD = 57
ACTION_PICK_STYLE = 58
ACTION_RELOAD_ITEM = 59
ACTION_RELOAD_WEAPON = 60
ACTION_RELOAD_WIELDED = 61
ACTION_UNLOAD = 62
ACTION_UNLOAD_ALL = 63
ACTION_MEND = 64
ACTION_THROW = 65
ACTION_FIRE = 66
ACTION_FIRE_BURST = 67
ACTION_SELECT_FIRE_MODE = 68
ACTION_SELECT_DEFAULT_AMMO = 69
ACTION_CAST_SPELL = 70
ACTION_CAST_LAST_SPELL = 71
ACTION_DROP = 72
ACTION_DIR_DROP = 73
ACTION_BIONICS = 74
ACTION_MUTATIONS = 75
ACTION_SORT_ARMOR = 76
ACTION_AUTOATTACK = 77
ACTION_WAIT = 78
ACTION_CRAFT = 79
ACTION_RECRAFT = 80
ACTION_LONGCRAFT = 81
ACTION_CONSTRUCT = 82
ACTION_DISASSEMBLE = 83
ACTION_SALVAGE = 84
ACTION_SLEEP = 85
ACTION_CONTROL_VEHICLE = 86
ACTION_TOGGLE_AUTO_TRAVEL_MODE = 87
ACTION_TOGGLE_SAFEMODE = 88
ACTION_TOGGLE_AUTOSAFE = 89
ACTION_TOGGLE_THIEF_MODE = 90
ACTION_IGNORE_ENEMY = 91
ACTION_WHITELIST_ENEMY = 92
ACTION_SAVE = 93
ACTION_QUICKSAVE = 94
ACTION_QUICKLOAD = 95
ACTION_SUICIDE = 96
ACTION_PL_INFO = 97
ACTION_MAP = 98
ACTION_SKY = 99
ACTION_MISSIONS = 100
ACTION_SCORES = 101
ACTION_FACTIONS = 102
ACTION_MORALE = 103
ACTION_MESSAGES = 104
ACTION_OPEN_WIKI = 105
ACTION_OPEN_HHG = 106
ACTION_HELP = 107
ACTION_MAIN_MENU = 108
ACTION_DIARY = 109
ACTION_KEYBINDINGS = 110
ACTION_OPTIONS = 111
ACTION_AUTOPICKUP = 112
ACTION_AUTONOTES = 113
ACTION_SAFEMODE = 114
ACTION_COLOR = 115
ACTION_WORLD_MODS = 116
ACTION_DISTRACTION_MANAGER = 117
ACTION_TOGGLE_CHARACTER_PREVIEW_CLOTHES = 118
ACTION_TOGGLE_FULLSCREEN = 119
ACTION_DEBUG = 120
ACTION_LUA_CONSOLE = 121
ACTION_LUA_RELOAD = 122
ACTION_DISPLAY_SCENT = 123
ACTION_DISPLAY_SCENT_TYPE = 124
ACTION_TOGGLE_DEBUG_MODE = 125
ACTION_ZOOM_OUT = 126
ACTION_ZOOM_IN = 127
ACTION_ACTIONMENU = 128
ACTION_ITEMACTION = 129
ACTION_TOGGLE_PIXEL_MINIMAP = 130
ACTION_TOGGLE_PANEL_ADM = 131
ACTION_PANEL_MGMT = 132
ACTION_RELOAD_TILESET = 133
ACTION_TOGGLE_AUTO_FEATURES = 134
ACTION_TOGGLE_AUTO_PULP_BUTCHER = 135
ACTION_TOGGLE_AUTO_MINING = 136
ACTION_TOGGLE_AUTO_FORAGING = 137
ACTION_TOGGLE_AUTO_PICKUP = 138
ACTION_DISPLAY_TEMPERATURE = 139
ACTION_DISPLAY_VEHICLE_AI = 140
ACTION_DISPLAY_VISIBILITY = 141
ACTION_DISPLAY_LIGHTING = 142
ACTION_DISPLAY_RADIATION = 143
ACTION_DISPLAY_TRANSPARENCY = 144
ACTION_DISPLAY_OUTSIDE = 145
ACTION_DISPLAY_SUBMAP_GRID = 146
ACTION_DISPLAY_SOUND_ABSORPTION = 147
ACTION_DISPLAY_SOUND_WALLS = 148
ACTION_TOGGLE_ZONE_OVERLAY = 149
ACTION_DISPLAY_TILES_NO_VFX = 150
ACTION_TOGGLE_HOUR_TIMER = 151
ACTION_SWAP_TO_NPC = 152

AddictionType

Entries

NONE = 0
CAFFEINE = 1
ALCOHOL = 2
SLEEP = 3
PKILLER = 4
SPEED = 5
CIG = 6
COKE = 7
CRACK = 8
MUTAGEN = 9
DIAZEPAM = 10
MARLOSS_R = 11
MARLOSS_B = 12
MARLOSS_Y = 13

ArtifactCharge

Entries

ARTC_NULL = 0
ARTC_TIME = 1
ARTC_SOLAR = 2
ARTC_PAIN = 3
ARTC_HP = 4
ARTC_FATIGUE = 5
ARTC_PORTAL = 6

ArtifactChargeReq

Entries

ACR_NULL = 0
ACR_EQUIP = 1
ACR_SKIN = 2
ACR_SLEEP = 3
ACR_RAD = 4
ACR_WET = 5
ACR_SKY = 6

ArtifactEffectActive

Entries

AEP_NULL = 0
AEP_STR_UP = 1
AEP_DEX_UP = 2
AEP_PER_UP = 3
AEP_INT_UP = 4
AEP_ALL_UP = 5
AEP_SPEED_UP = 6
AEP_PBLUE = 7
AEP_SNAKES = 8
AEP_INVISIBLE = 9
AEP_CLAIRVOYANCE = 10
AEP_SUPER_CLAIRVOYANCE = 11
AEP_STEALTH = 12
AEP_EXTINGUISH = 13
AEP_GLOW = 14
AEP_PSYSHIELD = 15
AEP_RESIST_ELECTRICITY = 16
AEP_CARRY_MORE = 17
AEP_SAP_LIFE = 18
AEP_FUN = 19
AEP_SPLIT = 20
AEP_HUNGER = 21
AEP_THIRST = 22
AEP_SMOKE = 23
AEP_EVIL = 24
AEP_SCHIZO = 25
AEP_RADIOACTIVE = 26
AEP_MUTAGENIC = 27
AEP_ATTENTION = 28
AEP_STR_DOWN = 29
AEP_DEX_DOWN = 30
AEP_PER_DOWN = 31
AEP_INT_DOWN = 32
AEP_ALL_DOWN = 33
AEP_SPEED_DOWN = 34
AEP_FORCE_TELEPORT = 35
AEP_MOVEMENT_NOISE = 36
AEP_BAD_WEATHER = 37
AEP_SICK = 38
AEP_CLAIRVOYANCE_PLUS = 39

ArtifactEffectPassive

Entries

AEA_NULL = 0
AEA_STORM = 1
AEA_FIREBALL = 2
AEA_ADRENALINE = 3
AEA_MAP = 4
AEA_BLOOD = 5
AEA_FATIGUE = 6
AEA_ACIDBALL = 7
AEA_PULSE = 8
AEA_HEAL = 9
AEA_CONFUSED = 10
AEA_ENTRANCE = 11
AEA_BUGS = 12
AEA_TELEPORT = 13
AEA_LIGHT = 14
AEA_GROWTH = 15
AEA_HURTALL = 16
AEA_FUN = 17
AEA_SPLIT = 18
AEA_RADIATION = 19
AEA_PAIN = 20
AEA_MUTATE = 21
AEA_PARALYZE = 22
AEA_FIRESTORM = 23
AEA_ATTENTION = 24
AEA_TELEGLOW = 25
AEA_NOISE = 26
AEA_SCREAM = 27
AEA_DIM = 28
AEA_FLASH = 29
AEA_VOMIT = 30
AEA_SHADOWS = 31
AEA_STAMINA_EMPTY = 32

Attitude

Entries

Hostile = 0
Neutral = 1
Friendly = 2
Any = 3

BodyPart

Entries

TORSO = 0
HEAD = 1
EYES = 2
MOUTH = 3
ARM_L = 4
ARM_R = 5
HAND_L = 6
HAND_R = 7
LEG_L = 8
LEG_R = 9
FOOT_L = 10
FOOT_R = 11

Color

Entries

c_black = 0
c_white = 1
c_light_gray = 2
c_dark_gray = 3
c_red = 4
c_green = 5
c_blue = 6
c_cyan = 7
c_magenta = 8
c_brown = 9
c_light_red = 10
c_light_green = 11
c_light_blue = 12
c_light_cyan = 13
c_pink = 14
c_yellow = 15
h_black = 16
h_white = 17
h_light_gray = 18
h_dark_gray = 19
h_red = 20
h_green = 21
h_blue = 22
h_cyan = 23
h_magenta = 24
h_brown = 25
h_light_red = 26
h_light_green = 27
h_light_blue = 28
h_light_cyan = 29
h_pink = 30
h_yellow = 31
i_black = 32
i_white = 33
i_light_gray = 34
i_dark_gray = 35
i_red = 36
i_green = 37
i_blue = 38
i_cyan = 39
i_magenta = 40
i_brown = 41
i_light_red = 42
i_light_green = 43
i_light_blue = 44
i_light_cyan = 45
i_pink = 46
i_yellow = 47
c_unset = 48
c_black_red = 49
c_white_red = 50
c_light_gray_red = 51
c_dark_gray_red = 52
c_red_red = 53
c_green_red = 54
c_blue_red = 55
c_cyan_red = 56
c_magenta_red = 57
c_brown_red = 58
c_light_red_red = 59
c_light_green_red = 60
c_light_blue_red = 61
c_light_cyan_red = 62
c_pink_red = 63
c_yellow_red = 64
c_black_white = 65
c_dark_gray_white = 66
c_light_gray_white = 67
c_white_white = 68
c_red_white = 69
c_light_red_white = 70
c_green_white = 71
c_light_green_white = 72
c_brown_white = 73
c_yellow_white = 74
c_blue_white = 75
c_light_blue_white = 76
c_magenta_white = 77
c_pink_white = 78
c_cyan_white = 79
c_light_cyan_white = 80
c_black_green = 81
c_dark_gray_green = 82
c_light_gray_green = 83
c_white_green = 84
c_red_green = 85
c_light_red_green = 86
c_green_green = 87
c_light_green_green = 88
c_brown_green = 89
c_yellow_green = 90
c_blue_green = 91
c_light_blue_green = 92
c_magenta_green = 93
c_pink_green = 94
c_cyan_green = 95
c_light_cyan_green = 96
c_black_yellow = 97
c_dark_gray_yellow = 98
c_light_gray_yellow = 99
c_white_yellow = 100
c_red_yellow = 101
c_light_red_yellow = 102
c_green_yellow = 103
c_light_green_yellow = 104
c_brown_yellow = 105
c_yellow_yellow = 106
c_blue_yellow = 107
c_light_blue_yellow = 108
c_magenta_yellow = 109
c_pink_yellow = 110
c_cyan_yellow = 111
c_light_cyan_yellow = 112
c_black_magenta = 113
c_dark_gray_magenta = 114
c_light_gray_magenta = 115
c_white_magenta = 116
c_red_magenta = 117
c_light_red_magenta = 118
c_green_magenta = 119
c_light_green_magenta = 120
c_brown_magenta = 121
c_yellow_magenta = 122
c_blue_magenta = 123
c_light_blue_magenta = 124
c_magenta_magenta = 125
c_pink_magenta = 126
c_cyan_magenta = 127
c_light_cyan_magenta = 128
c_black_cyan = 129
c_dark_gray_cyan = 130
c_light_gray_cyan = 131
c_white_cyan = 132
c_red_cyan = 133
c_light_red_cyan = 134
c_green_cyan = 135
c_light_green_cyan = 136
c_brown_cyan = 137
c_yellow_cyan = 138
c_blue_cyan = 139
c_light_blue_cyan = 140
c_magenta_cyan = 141
c_pink_cyan = 142
c_cyan_cyan = 143
c_light_cyan_cyan = 144

DamageType

Entries

DT_NULL = 0
DT_TRUE = 1
DT_BIOLOGICAL = 2
DT_BASH = 3
DT_CUT = 4
DT_ACID = 5
DT_STAB = 6
DT_HEAT = 7
DT_COLD = 8
DT_DARK = 9
DT_LIGHT = 10
DT_PSI = 11
DT_ELECTRIC = 12
DT_BULLET = 13

Direction

Entries

center = 0
west = 1
east = 2
north = 3
north_west = 4
north_east = 5
south = 6
south_west = 7
south_east = 8
below = 9
below_west = 10
below_east = 11
below_north = 12
below_north_west = 13
below_north_east = 14
below_south = 15
below_south_west = 16
below_south_east = 17
above = 18
above_west = 19
above_east = 20
above_north = 21
above_north_west = 22
above_north_east = 23
above_south = 24
above_south_west = 25
above_south_east = 26

MissionGoal

Entries

MGOAL_NULL = 0
MGOAL_GO_TO = 1
MGOAL_GO_TO_TYPE = 2
MGOAL_FIND_ITEM = 3
MGOAL_FIND_ANY_ITEM = 4
MGOAL_FIND_ITEM_GROUP = 5
MGOAL_FIND_MONSTER = 6
MGOAL_FIND_NPC = 7
MGOAL_ASSASSINATE = 8
MGOAL_KILL_MONSTER = 9
MGOAL_KILL_MONSTER_TYPE = 10
MGOAL_KILL_NEMESIS = 11
MGOAL_RECRUIT_NPC = 12
MGOAL_RECRUIT_NPC_CLASS = 13
MGOAL_COMPUTER_TOGGLE = 14
MGOAL_KILL_MONSTER_SPEC = 15
MGOAL_TALK_TO_NPC = 16
MGOAL_CONDITION = 17
MGOAL_KILL_MONSTERS = 18

MissionOrigin

Entries

ORIGIN_NULL = 0
ORIGIN_GAME_START = 1
ORIGIN_OPENER_NPC = 2
ORIGIN_ANY_NPC = 3
ORIGIN_SECONDARY = 4
ORIGIN_COMPUTER = 5

MonsterAttitude

Entries

MATT_NULL = 0
MATT_FRIEND = 1
MATT_FPASSIVE = 2
MATT_FLEE = 3
MATT_IGNORE = 4
MATT_FOLLOW = 5
MATT_ATTACK = 6
MATT_ZLAVE = 7
MATT_UNKNOWN = 8

MonsterFactionAttitude

Entries

ByMood = 0
Neutral = 1
Friendly = 2
Hate = 3

MonsterFlag

Entries

SEES = 0
HEARS = 1
GOODHEARING = 2
SMELLS = 3
KEENNOSE = 4
STUMBLES = 5
WARM = 6
NEMESIS = 7
NOHEAD = 8
HARDTOSHOOT = 9
GRABS = 10
BASHES = 11
DESTROYS = 12
BORES = 13
POISON = 14
VENOM = 15
BADVENOM = 16
PARALYZEVENOM = 17
BLEED = 18
WEBWALK = 19
DIGS = 20
CAN_DIG = 21
FLIES = 22
AQUATIC = 23
SWIMS = 24
ATTACKMON = 25
ANIMAL = 26
PLASTIC = 27
SUNDEATH = 28
ELECTRIC = 29
ACIDPROOF = 30
ACIDTRAIL = 31
SHORTACIDTRAIL = 32
FIREPROOF = 33
SLUDGEPROOF = 34
SLUDGETRAIL = 35
COLDPROOF = 36
BIOPROOF = 37
DARKPROOF = 38
LIGHTPROOF = 39
PSIPROOF = 40
FIREY = 41
QUEEN = 42
ELECTRONIC = 43
FUR = 44
LEATHER = 45
WOOL = 46
FEATHER = 47
BONES = 48
FAT = 49
CONSOLE_DESPAWN = 50
IMMOBILE = 51
STATIONARY = 52
ID_CARD_DESPAWN = 53
RIDEABLE_MECH = 54
CARD_OVERRIDE = 55
MILITARY_MECH = 56
MECH_RECON_VISION = 57
MECH_DEFENSIVE = 58
HIT_AND_RUN = 59
GUILT = 60
PAY_BOT = 61
HUMAN = 62
NO_BREATHE = 63
FLAMMABLE = 64
REVIVES = 65
CHITIN = 66
VERMIN = 67
NOGIB = 68
LARVA = 69
ARTHROPOD_BLOOD = 70
ACID_BLOOD = 71
BILE_BLOOD = 72
ABSORBS = 73
ABSORBS_SPLITS = 74
CBM_CIV = 75
CBM_POWER = 76
CBM_SCI = 77
CBM_OP = 78
CBM_TECH = 79
CBM_SUBS = 80
UNUSED_76 = 81
FISHABLE = 82
GROUP_BASH = 83
SWARMS = 84
GROUP_MORALE = 85
INTERIOR_AMMO = 86
CLIMBS = 87
PACIFIST = 88
PUSH_MON = 89
PUSH_VEH = 90
NIGHT_INVISIBILITY = 91
REVIVES_HEALTHY = 92
NO_NECRO = 93
PATH_AVOID_DANGER_1 = 94
PATH_AVOID_DANGER_2 = 95
PATH_AVOID_FIRE = 96
PATH_AVOID_FALL = 97
PRIORITIZE_TARGETS = 98
NOT_HALLUCINATION = 99
CANPLAY = 100
PET_MOUNTABLE = 101
PET_HARNESSABLE = 102
CAN_FETCH = 103
DOGFOOD = 104
MILKABLE = 105
SHEARABLE = 106
NO_BREED = 107
NO_FUNG_DMG = 108
PET_WONT_FOLLOW = 109
DRIPS_NAPALM = 110
DRIPS_GASOLINE = 111
ELECTRIC_FIELD = 112
LOUDMOVES = 113
CAN_OPEN_DOORS = 114
STUN_IMMUNE = 115
DROPS_AMMO = 116
CAN_BE_ORDERED = 117
SMALL_HEAD = 118
TINY_HEAD = 119
NO_HEAD_BONUS_CRIT = 120
HEAD_BONUS_CRIT_1 = 121
HEAD_BONUS_CRIT_2 = 122
TORSO_BONUS_CRIT_1 = 123
TORSO_BONUS_CRIT_2 = 124
PROJECTILE_RESISTANT_1 = 125
PROJECTILE_RESISTANT_2 = 126
PROJECTILE_RESISTANT_3 = 127
PROJECTILE_RESISTANT_4 = 128
VOLATILE = 129
CANT_CLONE = 130
MOUNTABLE_STAIRS = 131
MOUNTABLE_LADDER = 132
MOUNTABLE_OBSTACLES = 133
MOUNTABLE_DOORS = 134
MOUNTABLE_LEDGE = 135
FACTION_MEMORY = 136
COMBAT_MOUNT = 137
CANT_TRAIN = 138

MonsterSize

Entries

TINY = 0
SMALL = 1
MEDIUM = 2
LARGE = 3
HUGE = 4

MoonPhase

Entries

MOON_NEW = 0
MOON_WAXING_CRESCENT = 1
MOON_HALF_MOON_WAXING = 2
MOON_WAXING_GIBBOUS = 3
MOON_FULL = 4
MOON_WANING_GIBBOUS = 5
MOON_HALF_MOON_WANING = 6
MOON_WANING_CRESCENT = 7

MsgType

Entries

good = 0
bad = 1
mixed = 2
warning = 3
info = 4
neutral = 5
debug = 6
headshot = 7
critical = 8
grazing = 9

NpcAttitude

Entries

NPCATT_NULL = 0
NPCATT_TALK = 1
NPCATT_LEGACY_1 = 2
NPCATT_FOLLOW = 3
NPCATT_LEGACY_2 = 4
NPCATT_LEAD = 5
NPCATT_WAIT = 6
NPCATT_LEGACY_6 = 7
NPCATT_MUG = 8
NPCATT_WAIT_FOR_LEAVE = 9
NPCATT_KILL = 10
NPCATT_FLEE = 11
NPCATT_LEGACY_3 = 12
NPCATT_HEAL = 13
NPCATT_LEGACY_4 = 14
NPCATT_LEGACY_5 = 15
NPCATT_ACTIVITY = 16
NPCATT_FLEE_TEMP = 17
NPCATT_RECOVER_GOODS = 18

NpcNeed

Entries

need_none = 0
need_ammo = 1
need_weapon = 2
need_gun = 3
need_food = 4
need_drink = 5
need_safety = 6

OtMatchType

Entries

EXACT = 0
TYPE = 1
PREFIX = 2
CONTAINS = 3

SfxChannel

Entries

daytime_outdoors_env = 0
nighttime_outdoors_env = 1
underground_env = 2
indoors_env = 3
indoors_rain_env = 4
outdoors_snow_env = 5
outdoors_flurry_env = 6
outdoors_thunderstorm_env = 7
outdoors_rain_env = 8
outdoors_drizzle_env = 9
outdoor_blizzard = 10
deafness_tone = 11
danger_extreme_theme = 12
danger_high_theme = 13
danger_medium_theme = 14
danger_low_theme = 15
stamina_75 = 16
stamina_50 = 17
stamina_35 = 18
idle_chainsaw = 19
chainsaw_theme = 20
player_activities = 21
exterior_engine_sound = 22
interior_engine_sound = 23
radio = 24

VitaminType

Entries

vitamin = 0
toxin = 1
drug = 2
counter = 3

Libraries

PointAbsMmr

Members

new

🇫 Function --> ( ) -> PointAbsMmr
🇫 Function --> ( Point ) -> PointAbsMmr
🇫 Function --> ( integer, integer ) -> PointAbsMmr

PointAbsMs

Members

new

🇫 Function --> ( ) -> PointAbsMs
🇫 Function --> ( Point ) -> PointAbsMs
🇫 Function --> ( integer, integer ) -> PointAbsMs

PointAbsOm

Members

new

🇫 Function --> ( ) -> PointAbsOm
🇫 Function --> ( Point ) -> PointAbsOm
🇫 Function --> ( integer, integer ) -> PointAbsOm

PointAbsOmt

Members

new

🇫 Function --> ( ) -> PointAbsOmt
🇫 Function --> ( Point ) -> PointAbsOmt
🇫 Function --> ( integer, integer ) -> PointAbsOmt

PointAbsSeg

Members

new

🇫 Function --> ( ) -> PointAbsSeg
🇫 Function --> ( Point ) -> PointAbsSeg
🇫 Function --> ( integer, integer ) -> PointAbsSeg

PointAbsSm

Members

new

🇫 Function --> ( ) -> PointAbsSm
🇫 Function --> ( Point ) -> PointAbsSm
🇫 Function --> ( integer, integer ) -> PointAbsSm

PointBubMs

Members

new

🇫 Function --> ( ) -> PointBubMs
🇫 Function --> ( Point ) -> PointBubMs
🇫 Function --> ( integer, integer ) -> PointBubMs

PointBubSm

Members

new

🇫 Function --> ( ) -> PointBubSm
🇫 Function --> ( Point ) -> PointBubSm
🇫 Function --> ( integer, integer ) -> PointBubSm

PointMmrMs

Members

new

🇫 Function --> ( ) -> PointMmrMs
🇫 Function --> ( Point ) -> PointMmrMs
🇫 Function --> ( integer, integer ) -> PointMmrMs

PointMmrOmt

Members

new

🇫 Function --> ( ) -> PointMmrOmt
🇫 Function --> ( Point ) -> PointMmrOmt
🇫 Function --> ( integer, integer ) -> PointMmrOmt

PointMmrSm

Members

new

🇫 Function --> ( ) -> PointMmrSm
🇫 Function --> ( Point ) -> PointMmrSm
🇫 Function --> ( integer, integer ) -> PointMmrSm

PointMntVeh

Members

new

🇫 Function --> ( ) -> PointMntVeh
🇫 Function --> ( Point ) -> PointMntVeh
🇫 Function --> ( integer, integer ) -> PointMntVeh

PointOmMmr

Members

new

🇫 Function --> ( ) -> PointOmMmr
🇫 Function --> ( Point ) -> PointOmMmr
🇫 Function --> ( integer, integer ) -> PointOmMmr

PointOmMs

Members

new

🇫 Function --> ( ) -> PointOmMs
🇫 Function --> ( Point ) -> PointOmMs
🇫 Function --> ( integer, integer ) -> PointOmMs

PointOmOmt

Members

new

🇫 Function --> ( ) -> PointOmOmt
🇫 Function --> ( Point ) -> PointOmOmt
🇫 Function --> ( integer, integer ) -> PointOmOmt

PointOmSeg

Members

new

🇫 Function --> ( ) -> PointOmSeg
🇫 Function --> ( Point ) -> PointOmSeg
🇫 Function --> ( integer, integer ) -> PointOmSeg

PointOmSm

Members

new

🇫 Function --> ( ) -> PointOmSm
🇫 Function --> ( Point ) -> PointOmSm
🇫 Function --> ( integer, integer ) -> PointOmSm

PointOmtMs

Members

new

🇫 Function --> ( ) -> PointOmtMs
🇫 Function --> ( Point ) -> PointOmtMs
🇫 Function --> ( integer, integer ) -> PointOmtMs

PointOmtSm

Members

new

🇫 Function --> ( ) -> PointOmtSm
🇫 Function --> ( Point ) -> PointOmtSm
🇫 Function --> ( integer, integer ) -> PointOmtSm

PointRelMmr

Members

new

🇫 Function --> ( ) -> PointRelMmr
🇫 Function --> ( Point ) -> PointRelMmr
🇫 Function --> ( integer, integer ) -> PointRelMmr

PointRelMs

Members

new

🇫 Function --> ( ) -> PointRelMs
🇫 Function --> ( Point ) -> PointRelMs
🇫 Function --> ( integer, integer ) -> PointRelMs

PointRelOm

Members

new

🇫 Function --> ( ) -> PointRelOm
🇫 Function --> ( Point ) -> PointRelOm
🇫 Function --> ( integer, integer ) -> PointRelOm

PointRelOmt

Members

new

🇫 Function --> ( ) -> PointRelOmt
🇫 Function --> ( Point ) -> PointRelOmt
🇫 Function --> ( integer, integer ) -> PointRelOmt

PointRelSeg

Members

new

🇫 Function --> ( ) -> PointRelSeg
🇫 Function --> ( Point ) -> PointRelSeg
🇫 Function --> ( integer, integer ) -> PointRelSeg

PointRelSm

Members

new

🇫 Function --> ( ) -> PointRelSm
🇫 Function --> ( Point ) -> PointRelSm
🇫 Function --> ( integer, integer ) -> PointRelSm

PointRelVeh

Members

new

🇫 Function --> ( ) -> PointRelVeh
🇫 Function --> ( Point ) -> PointRelVeh
🇫 Function --> ( integer, integer ) -> PointRelVeh

PointSegMmr

Members

new

🇫 Function --> ( ) -> PointSegMmr
🇫 Function --> ( Point ) -> PointSegMmr
🇫 Function --> ( integer, integer ) -> PointSegMmr

PointSegMs

Members

new

🇫 Function --> ( ) -> PointSegMs
🇫 Function --> ( Point ) -> PointSegMs
🇫 Function --> ( integer, integer ) -> PointSegMs

PointSegOmt

Members

new

🇫 Function --> ( ) -> PointSegOmt
🇫 Function --> ( Point ) -> PointSegOmt
🇫 Function --> ( integer, integer ) -> PointSegOmt

PointSegSm

Members

new

🇫 Function --> ( ) -> PointSegSm
🇫 Function --> ( Point ) -> PointSegSm
🇫 Function --> ( integer, integer ) -> PointSegSm

PointSmMs

Members

new

🇫 Function --> ( ) -> PointSmMs
🇫 Function --> ( Point ) -> PointSmMs
🇫 Function --> ( integer, integer ) -> PointSmMs

🇫 Function --> ( ) -> TripointAbsMmr
🇫 Function --> ( Tripoint ) -> TripointAbsMmr
🇫 Function --> ( Point, integer ) -> TripointAbsMmr
🇫 Function --> ( PointAbsMmr, integer ) -> TripointAbsMmr
🇫 Function --> ( integer, integer, integer ) -> TripointAbsMmr

TripointAbsMs

Members

new

🇫 Function --> ( ) -> TripointAbsMs
🇫 Function --> ( Tripoint ) -> TripointAbsMs
🇫 Function --> ( Point, integer ) -> TripointAbsMs
🇫 Function --> ( PointAbsMs, integer ) -> TripointAbsMs
🇫 Function --> ( integer, integer, integer ) -> TripointAbsMs

TripointAbsOm

Members

new

🇫 Function --> ( ) -> TripointAbsOm
🇫 Function --> ( Tripoint ) -> TripointAbsOm
🇫 Function --> ( Point, integer ) -> TripointAbsOm
🇫 Function --> ( PointAbsOm, integer ) -> TripointAbsOm
🇫 Function --> ( integer, integer, integer ) -> TripointAbsOm

TripointAbsOmt

Members

new

🇫 Function --> ( ) -> TripointAbsOmt
🇫 Function --> ( Tripoint ) -> TripointAbsOmt
🇫 Function --> ( Point, integer ) -> TripointAbsOmt
🇫 Function --> ( PointAbsOmt, integer ) -> TripointAbsOmt
🇫 Function --> ( integer, integer, integer ) -> TripointAbsOmt

TripointAbsSeg

Members

new

🇫 Function --> ( ) -> TripointAbsSeg
🇫 Function --> ( Tripoint ) -> TripointAbsSeg
🇫 Function --> ( Point, integer ) -> TripointAbsSeg
🇫 Function --> ( PointAbsSeg, integer ) -> TripointAbsSeg
🇫 Function --> ( integer, integer, integer ) -> TripointAbsSeg

TripointAbsSm

Members

new

🇫 Function --> ( ) -> TripointAbsSm
🇫 Function --> ( Tripoint ) -> TripointAbsSm
🇫 Function --> ( Point, integer ) -> TripointAbsSm
🇫 Function --> ( PointAbsSm, integer ) -> TripointAbsSm
🇫 Function --> ( integer, integer, integer ) -> TripointAbsSm

TripointBubMs

Members

new

🇫 Function --> ( ) -> TripointBubMs
🇫 Function --> ( Tripoint ) -> TripointBubMs
🇫 Function --> ( Point, integer ) -> TripointBubMs
🇫 Function --> ( PointBubMs, integer ) -> TripointBubMs
🇫 Function --> ( integer, integer, integer ) -> TripointBubMs

TripointBubSm

Members

new

🇫 Function --> ( ) -> TripointBubSm
🇫 Function --> ( Tripoint ) -> TripointBubSm
🇫 Function --> ( Point, integer ) -> TripointBubSm
🇫 Function --> ( PointBubSm, integer ) -> TripointBubSm
🇫 Function --> ( integer, integer, integer ) -> TripointBubSm

TripointMmrMs

Members

new

🇫 Function --> ( ) -> TripointMmrMs
🇫 Function --> ( Tripoint ) -> TripointMmrMs
🇫 Function --> ( Point, integer ) -> TripointMmrMs
🇫 Function --> ( PointMmrMs, integer ) -> TripointMmrMs
🇫 Function --> ( integer, integer, integer ) -> TripointMmrMs

TripointMmrOmt

Members

new

🇫 Function --> ( ) -> TripointMmrOmt
🇫 Function --> ( Tripoint ) -> TripointMmrOmt
🇫 Function --> ( Point, integer ) -> TripointMmrOmt
🇫 Function --> ( PointMmrOmt, integer ) -> TripointMmrOmt
🇫 Function --> ( integer, integer, integer ) -> TripointMmrOmt

TripointMmrSm

Members

new

🇫 Function --> ( ) -> TripointMmrSm
🇫 Function --> ( Tripoint ) -> TripointMmrSm
🇫 Function --> ( Point, integer ) -> TripointMmrSm
🇫 Function --> ( PointMmrSm, integer ) -> TripointMmrSm
🇫 Function --> ( integer, integer, integer ) -> TripointMmrSm

TripointMntVeh

Members

new

🇫 Function --> ( ) -> TripointMntVeh
🇫 Function --> ( Tripoint ) -> TripointMntVeh
🇫 Function --> ( Point, integer ) -> TripointMntVeh
🇫 Function --> ( PointMntVeh, integer ) -> TripointMntVeh
🇫 Function --> ( integer, integer, integer ) -> TripointMntVeh

TripointOmMmr

Members

new

🇫 Function --> ( ) -> TripointOmMmr
🇫 Function --> ( Tripoint ) -> TripointOmMmr
🇫 Function --> ( Point, integer ) -> TripointOmMmr
🇫 Function --> ( PointOmMmr, integer ) -> TripointOmMmr
🇫 Function --> ( integer, integer, integer ) -> TripointOmMmr

TripointOmMs

Members

new

🇫 Function --> ( ) -> TripointOmMs
🇫 Function --> ( Tripoint ) -> TripointOmMs
🇫 Function --> ( Point, integer ) -> TripointOmMs
🇫 Function --> ( PointOmMs, integer ) -> TripointOmMs
🇫 Function --> ( integer, integer, integer ) -> TripointOmMs

TripointOmOmt

Members

new

🇫 Function --> ( ) -> TripointOmOmt
🇫 Function --> ( Tripoint ) -> TripointOmOmt
🇫 Function --> ( Point, integer ) -> TripointOmOmt
🇫 Function --> ( PointOmOmt, integer ) -> TripointOmOmt
🇫 Function --> ( integer, integer, integer ) -> TripointOmOmt

TripointOmSeg

Members

new

🇫 Function --> ( ) -> TripointOmSeg
🇫 Function --> ( Tripoint ) -> TripointOmSeg
🇫 Function --> ( Point, integer ) -> TripointOmSeg
🇫 Function --> ( PointOmSeg, integer ) -> TripointOmSeg
🇫 Function --> ( integer, integer, integer ) -> TripointOmSeg

TripointOmSm

Members

new

🇫 Function --> ( ) -> TripointOmSm
🇫 Function --> ( Tripoint ) -> TripointOmSm
🇫 Function --> ( Point, integer ) -> TripointOmSm
🇫 Function --> ( PointOmSm, integer ) -> TripointOmSm
🇫 Function --> ( integer, integer, integer ) -> TripointOmSm

TripointOmtMs

Members

new

🇫 Function --> ( ) -> TripointOmtMs
🇫 Function --> ( Tripoint ) -> TripointOmtMs
🇫 Function --> ( Point, integer ) -> TripointOmtMs
🇫 Function --> ( PointOmtMs, integer ) -> TripointOmtMs
🇫 Function --> ( integer, integer, integer ) -> TripointOmtMs

TripointOmtSm

Members

new

🇫 Function --> ( ) -> TripointOmtSm
🇫 Function --> ( Tripoint ) -> TripointOmtSm
🇫 Function --> ( Point, integer ) -> TripointOmtSm
🇫 Function --> ( PointOmtSm, integer ) -> TripointOmtSm
🇫 Function --> ( integer, integer, integer ) -> TripointOmtSm

TripointRelMmr

Members

new

🇫 Function --> ( ) -> TripointRelMmr
🇫 Function --> ( Tripoint ) -> TripointRelMmr
🇫 Function --> ( Point, integer ) -> TripointRelMmr
🇫 Function --> ( PointRelMmr, integer ) -> TripointRelMmr
🇫 Function --> ( integer, integer, integer ) -> TripointRelMmr

TripointRelMs

Members

new

🇫 Function --> ( ) -> TripointRelMs
🇫 Function --> ( Tripoint ) -> TripointRelMs
🇫 Function --> ( Point, integer ) -> TripointRelMs
🇫 Function --> ( PointRelMs, integer ) -> TripointRelMs
🇫 Function --> ( integer, integer, integer ) -> TripointRelMs

TripointRelOm

Members

new

🇫 Function --> ( ) -> TripointRelOm
🇫 Function --> ( Tripoint ) -> TripointRelOm
🇫 Function --> ( Point, integer ) -> TripointRelOm
🇫 Function --> ( PointRelOm, integer ) -> TripointRelOm
🇫 Function --> ( integer, integer, integer ) -> TripointRelOm

TripointRelOmt

Members

new

🇫 Function --> ( ) -> TripointRelOmt
🇫 Function --> ( Tripoint ) -> TripointRelOmt
🇫 Function --> ( Point, integer ) -> TripointRelOmt
🇫 Function --> ( PointRelOmt, integer ) -> TripointRelOmt
🇫 Function --> ( integer, integer, integer ) -> TripointRelOmt

TripointRelSeg

Members

new

🇫 Function --> ( ) -> TripointRelSeg
🇫 Function --> ( Tripoint ) -> TripointRelSeg
🇫 Function --> ( Point, integer ) -> TripointRelSeg
🇫 Function --> ( PointRelSeg, integer ) -> TripointRelSeg
🇫 Function --> ( integer, integer, integer ) -> TripointRelSeg

TripointRelSm

Members

new

🇫 Function --> ( ) -> TripointRelSm
🇫 Function --> ( Tripoint ) -> TripointRelSm
🇫 Function --> ( Point, integer ) -> TripointRelSm
🇫 Function --> ( PointRelSm, integer ) -> TripointRelSm
🇫 Function --> ( integer, integer, integer ) -> TripointRelSm

TripointRelVeh

Members

new

🇫 Function --> ( ) -> TripointRelVeh
🇫 Function --> ( Tripoint ) -> TripointRelVeh
🇫 Function --> ( Point, integer ) -> TripointRelVeh
🇫 Function --> ( PointRelVeh, integer ) -> TripointRelVeh
🇫 Function --> ( integer, integer, integer ) -> TripointRelVeh

TripointSegMmr

Members

new

🇫 Function --> ( ) -> TripointSegMmr
🇫 Function --> ( Tripoint ) -> TripointSegMmr
🇫 Function --> ( Point, integer ) -> TripointSegMmr
🇫 Function --> ( PointSegMmr, integer ) -> TripointSegMmr
🇫 Function --> ( integer, integer, integer ) -> TripointSegMmr

TripointSegMs

Members

new

🇫 Function --> ( ) -> TripointSegMs
🇫 Function --> ( Tripoint ) -> TripointSegMs
🇫 Function --> ( Point, integer ) -> TripointSegMs
🇫 Function --> ( PointSegMs, integer ) -> TripointSegMs
🇫 Function --> ( integer, integer, integer ) -> TripointSegMs

TripointSegOmt

Members

new

🇫 Function --> ( ) -> TripointSegOmt
🇫 Function --> ( Tripoint ) -> TripointSegOmt
🇫 Function --> ( Point, integer ) -> TripointSegOmt
🇫 Function --> ( PointSegOmt, integer ) -> TripointSegOmt
🇫 Function --> ( integer, integer, integer ) -> TripointSegOmt

TripointSegSm

Members

new

🇫 Function --> ( ) -> TripointSegSm
🇫 Function --> ( Tripoint ) -> TripointSegSm
🇫 Function --> ( Point, integer ) -> TripointSegSm
🇫 Function --> ( PointSegSm, integer ) -> TripointSegSm
🇫 Function --> ( integer, integer, integer ) -> TripointSegSm

TripointSmMs

Members

new

🇫 Function --> ( ) -> TripointSmMs
🇫 Function --> ( Tripoint ) -> TripointSmMs
🇫 Function --> ( Point, integer ) -> TripointSmMs
🇫 Function --> ( PointSmMs, integer ) -> TripointSmMs
🇫 Function --> ( integer, integer, integer ) -> TripointSmMs

ch_names

Members

generate

🇫 Function --> ( boolean? ) -> string

Generates a random full name with an optional boolean for gender. The loaded name is one of usage with optional gender. The combinations used in names files are as follows: Backer | (Female|Male|Unisex) Given | (Female|Male) // unisex names are duplicated in each group Family | Unisex Nick City World

pick

🇫 Function --> ( any ) -> string

Generates a single name using any combination of search flags.

const

Various game constants

Members

OMT_MS_SIZE

🇨 Constant --> integer = 24

OMT_SM_SIZE

🇨 Constant --> integer = 2

OM_MS_SIZE

🇨 Constant --> integer = 4320

OM_OMT_SIZE

🇨 Constant --> integer = 180

OM_SM_SIZE

🇨 Constant --> integer = 360

SM_MS_SIZE

🇨 Constant --> integer = 12

coords

Members

overmap_terrain_tiles

🇫 Function --> ( ) -> PointCoord[]

Returns every map-square offset within one overmap terrain tile as PointCoord values.

overmap_tiles

🇫 Function --> ( ) -> PointCoord[]

Returns every map-square offset within one overmap as PointCoord values.

point

🇫 Function --> ( string, string, Point ) -> PointCoord
🇫 Function --> ( string, string, integer, integer ) -> PointCoord

point_abs_mmr

🇫 Function --> ( integer, integer ) -> PointCoord

point_abs_ms

🇫 Function --> ( integer, integer ) -> PointCoord

point_abs_om

🇫 Function --> ( integer, integer ) -> PointCoord

point_abs_omt

🇫 Function --> ( integer, integer ) -> PointCoord

point_abs_seg

🇫 Function --> ( integer, integer ) -> PointCoord

point_abs_sm

🇫 Function --> ( integer, integer ) -> PointCoord

point_bub_ms

🇫 Function --> ( integer, integer ) -> PointCoord

point_bub_sm

🇫 Function --> ( integer, integer ) -> PointCoord

point_mmr_ms

🇫 Function --> ( integer, integer ) -> PointCoord

point_mmr_omt

🇫 Function --> ( integer, integer ) -> PointCoord

point_mmr_sm

🇫 Function --> ( integer, integer ) -> PointCoord

point_mnt_veh

🇫 Function --> ( integer, integer ) -> PointCoord

point_om_mmr

🇫 Function --> ( integer, integer ) -> PointCoord

point_om_ms

🇫 Function --> ( integer, integer ) -> PointCoord

point_om_omt

🇫 Function --> ( integer, integer ) -> PointCoord

point_om_seg

🇫 Function --> ( integer, integer ) -> PointCoord

point_om_sm

🇫 Function --> ( integer, integer ) -> PointCoord

point_omt_ms

🇫 Function --> ( integer, integer ) -> PointCoord

point_omt_sm

🇫 Function --> ( integer, integer ) -> PointCoord

point_rel_mmr

🇫 Function --> ( integer, integer ) -> PointCoord

point_rel_ms

🇫 Function --> ( integer, integer ) -> PointCoord

point_rel_om

🇫 Function --> ( integer, integer ) -> PointCoord

point_rel_omt

🇫 Function --> ( integer, integer ) -> PointCoord

point_rel_seg

🇫 Function --> ( integer, integer ) -> PointCoord

point_rel_sm

🇫 Function --> ( integer, integer ) -> PointCoord

point_rel_veh

🇫 Function --> ( integer, integer ) -> PointCoord

point_seg_mmr

🇫 Function --> ( integer, integer ) -> PointCoord

point_seg_ms

🇫 Function --> ( integer, integer ) -> PointCoord

point_seg_omt

🇫 Function --> ( integer, integer ) -> PointCoord

point_seg_sm

🇫 Function --> ( integer, integer ) -> PointCoord

point_sm_ms

🇫 Function --> ( integer, integer ) -> PointCoord

project_combine

🇫 Function --> ( coarse: any, fine: any ) -> nil | PointCoord | TripointCoord

Combines a coarse coordinate with a remainder from project_remain. Returns PointCoord or TripointCoord depending on the inputs, or nil if the pair is incompatible.

project_remain

🇫 Function --> ( coord: any, scale: string ) -> (nil | PointCoord | TripointCoord, PointCoord?)

Splits a PointCoord or TripointCoord into a coarser coordinate plus a remainder. Point input returns PointCoord, PointCoord; tripoint input returns TripointCoord, PointCoord. Returns nil, nil if the split is not valid.

project_remain_mmr

🇫 Function --> ( coord: any ) -> (nil | PointCoord | TripointCoord, PointCoord?)

Shortcut for project_remain(coord, "mmr").

project_remain_om

🇫 Function --> ( coord: any ) -> (nil | PointCoord | TripointCoord, PointCoord?)

Shortcut for project_remain(coord, "om").

project_remain_omt

🇫 Function --> ( coord: any ) -> (nil | PointCoord | TripointCoord, PointCoord?)

Shortcut for project_remain(coord, "omt").

project_remain_seg

🇫 Function --> ( coord: any ) -> (nil | PointCoord | TripointCoord, PointCoord?)

Shortcut for project_remain(coord, "seg").

project_remain_sm

🇫 Function --> ( coord: any ) -> (nil | PointCoord | TripointCoord, PointCoord?)

Shortcut for project_remain(coord, "sm").

project_to

🇫 Function --> ( coord: any, scale: string ) -> nil | PointCoord | TripointCoord

Projects a PointCoord or TripointCoord to another scale, preserving its origin and point dimension. Returns nil if the conversion is not valid.

project_to_mmr

🇫 Function --> ( coord: any ) -> nil | PointCoord | TripointCoord

Shortcut for project_to(coord, "mmr").

project_to_ms

🇫 Function --> ( coord: any ) -> nil | PointCoord | TripointCoord

Shortcut for project_to(coord, "ms").

project_to_om

🇫 Function --> ( coord: any ) -> nil | PointCoord | TripointCoord

Shortcut for project_to(coord, "om").

project_to_omt

🇫 Function --> ( coord: any ) -> nil | PointCoord | TripointCoord

Shortcut for project_to(coord, "omt").

project_to_seg

🇫 Function --> ( coord: any ) -> nil | PointCoord | TripointCoord

Shortcut for project_to(coord, "seg").

project_to_sm

🇫 Function --> ( coord: any ) -> nil | PointCoord | TripointCoord

Shortcut for project_to(coord, "sm").

project_to_veh

🇫 Function --> ( coord: any ) -> nil | PointCoord | TripointCoord

Shortcut for project_to(coord, "veh").

rl_dist

🇫 Function --> ( lhs: Point, rhs: Point ) -> integer
🇫 Function --> ( lhs: Tripoint, rhs: Tripoint ) -> integer
🇫 Function --> ( lhs: PointCoord, rhs: PointCoord ) -> integer?
🇫 Function --> ( lhs: TripointCoord, rhs: TripointCoord ) -> integer?

Rectilinear distance between two raw coordinates, or between two typed coordinates with matching origin and scale. Returns nil if the typed coordinates are incompatible.

square_dist

Chebyshev distance between two raw coordinates, or between two typed coordinates with matching origin and scale. Returns nil if the typed coordinates are incompatible.

submap_tiles

🇫 Function --> ( ) -> PointCoord[]

Returns every map-square offset within one submap as PointCoord values.

tinymap_tiles

🇫 Function --> ( ) -> PointCoord[]

Returns every map-square offset within the tinymap as PointCoord values.

trig_dist

🇫 Function --> ( lhs: Point, rhs: Point ) -> number
🇫 Function --> ( lhs: Tripoint, rhs: Tripoint ) -> number
🇫 Function --> ( lhs: PointCoord, rhs: PointCoord ) -> number?
🇫 Function --> ( lhs: TripointCoord, rhs: TripointCoord ) -> number?

Euclidean distance between two raw coordinates, or between two typed coordinates with matching origin and scale. Returns nil if the typed coordinates are incompatible.

tripoint

🇫 Function --> ( string, string, Tripoint ) -> TripointCoord
🇫 Function --> ( string, string, integer, integer, integer ) -> TripointCoord

tripoint_abs_mmr

🇫 Function --> ( integer, integer, integer ) -> TripointCoord

tripoint_abs_ms

🇫 Function --> ( integer, integer, integer ) -> TripointCoord

tripoint_abs_om

🇫 Function --> ( integer, integer, integer ) -> TripointCoord

tripoint_abs_omt

🇫 Function --> ( integer, integer, integer ) -> TripointCoord

tripoint_abs_seg

🇫 Function --> ( integer, integer, integer ) -> TripointCoord

tripoint_abs_sm

🇫 Function --> ( integer, integer, integer ) -> TripointCoord

tripoint_bub_ms

🇫 Function --> ( integer, integer, integer ) -> TripointCoord

tripoint_bub_sm

🇫 Function --> ( integer, integer, integer ) -> TripointCoord

tripoint_mmr_ms

🇫 Function --> ( integer, integer, integer ) -> TripointCoord

tripoint_mmr_omt

🇫 Function --> ( integer, integer, integer ) -> TripointCoord

tripoint_mmr_sm

🇫 Function --> ( integer, integer, integer ) -> TripointCoord

tripoint_mnt_veh

🇫 Function --> ( integer, integer, integer ) -> TripointCoord

tripoint_om_mmr

🇫 Function --> ( integer, integer, integer ) -> TripointCoord

tripoint_om_ms

🇫 Function --> ( integer, integer, integer ) -> TripointCoord

tripoint_om_omt

🇫 Function --> ( integer, integer, integer ) -> TripointCoord

tripoint_om_seg

🇫 Function --> ( integer, integer, integer ) -> TripointCoord

tripoint_om_sm

🇫 Function --> ( integer, integer, integer ) -> TripointCoord

tripoint_omt_ms

🇫 Function --> ( integer, integer, integer ) -> TripointCoord

tripoint_omt_sm

🇫 Function --> ( integer, integer, integer ) -> TripointCoord

tripoint_rel_mmr

🇫 Function --> ( integer, integer, integer ) -> TripointCoord

tripoint_rel_ms

🇫 Function --> ( integer, integer, integer ) -> TripointCoord

tripoint_rel_om

🇫 Function --> ( integer, integer, integer ) -> TripointCoord

tripoint_rel_omt

🇫 Function --> ( integer, integer, integer ) -> TripointCoord

tripoint_rel_seg

🇫 Function --> ( integer, integer, integer ) -> TripointCoord

tripoint_rel_sm

🇫 Function --> ( integer, integer, integer ) -> TripointCoord

tripoint_rel_veh

🇫 Function --> ( integer, integer, integer ) -> TripointCoord

tripoint_seg_mmr

🇫 Function --> ( integer, integer, integer ) -> TripointCoord

tripoint_seg_ms

🇫 Function --> ( integer, integer, integer ) -> TripointCoord

tripoint_seg_omt

🇫 Function --> ( integer, integer, integer ) -> TripointCoord

tripoint_seg_sm

🇫 Function --> ( integer, integer, integer ) -> TripointCoord

tripoint_sm_ms

🇫 Function --> ( integer, integer, integer ) -> TripointCoord

date_time

System date and time API.

Members

day

🇫 Function --> ( ) -> integer

hour

🇫 Function --> ( ) -> integer

0 -> 23

millisecond

🇫 Function --> ( ) -> integer

minute

🇫 Function --> ( ) -> integer

month

🇫 Function --> ( ) -> integer

second

🇫 Function --> ( ) -> integer

weekday

🇫 Function --> ( ) -> integer

Days since Saturday.

weekday_str

🇫 Function --> ( ) -> string

year

🇫 Function --> ( ) -> integer

gapi

Global game methods

Members

abs_to_bub

🇫 Function --> ( TripointAbsSm ) -> TripointBubSm

abs_to_bub

🇫 Function --> ( TripointAbsMs ) -> TripointBubMs

add_msg

🇫 Function --> ( MsgType, any )
🇫 Function --> ( any )

add_npc_follower

🇫 Function --> ( Npc )

add_on_every_x_hook

🇫 Function --> ( TimeDuration, function )

before_time_starts

🇫 Function --> ( ) -> TimePoint

bodytemp_cold

🇫 Function --> ( ) -> integer

bodytemp_hot

🇫 Function --> ( ) -> integer

bodytemp_norm

🇫 Function --> ( ) -> integer

bub_to_abs

🇫 Function --> ( TripointBubMs ) -> TripointAbsMs

bub_to_abs

🇫 Function --> ( TripointBubSm ) -> TripointAbsSm

call_builtin_examine

🇫 Function --> ( string, Player, TripointBubMs )

Run a built-in examine action at a position.

choose_adjacent

🇫 Function --> ( string, boolean? ) -> TripointBubMs?

choose_adjacent_highlight

🇫 Function --> ( string, string, ActionId, boolean? ) -> TripointBubMs?
🇫 Function --> ( string, string, bool, boolean? ) -> TripointBubMs?

choose_adjacent_uilist

🇫 Function --> ( string, string, function, function ) -> TripointBubMs?

choose_area

🇫 Function --> ( string, TripointBubMs, boolean ) -> (TripointBubMs, TripointBubMs)?

choose_direction

🇫 Function --> ( string, boolean? ) -> TripointRelMs?

create_item

🇫 Function --> ( ItypeId, integer ) -> Detached<Item>

Spawns a new item. Same as Item::spawn

current_turn

🇫 Function --> ( ) -> TimePoint

direction_from

🇫 Function --> ( TripointCoord ) -> Direction

Get direction from a relative tripoint coordinate delta.

direction_name

🇫 Function --> ( Direction ) -> string

Get direction name from direction enum

get_all_creatures

🇫 Function --> ( ) -> table

Returns all active creatures (monsters, NPCs, and the player) as a Lua array.

get_all_monsters

🇫 Function --> ( ) -> table

Returns all active monsters as a Lua array.

get_all_npcs

🇫 Function --> ( ) -> table

Returns all active NPCs as a Lua array.

get_avatar

🇫 Function --> ( ) -> Avatar

get_character_at

🇫 Function --> ( TripointBubMs, boolean? ) -> Character
🇫 Function --> ( Tripoint, boolean? ) -> Character

get_creature_at

🇫 Function --> ( TripointBubMs, boolean? ) -> Creature
🇫 Function --> ( Tripoint, boolean? ) -> Creature

get_distribution_grid_tracker

🇫 Function --> ( ) -> DistributionGridTracker

get_lua_log

🇫 Function --> ( integer ) -> table

Get recent Lua console log entries. Returns array of { level=string, text=string, from_user=bool }.

get_map

🇫 Function --> ( ) -> Map

get_messages

🇫 Function --> ( integer ) -> table

Get recent player message log entries. Returns array of { time=string, text=string }.

get_monster_at

🇫 Function --> ( TripointBubMs, boolean? ) -> Monster
🇫 Function --> ( Tripoint, boolean? ) -> Monster

get_monsters_near_omt

🇫 Function --> ( table ) -> table

Returns active monsters near an absolute overmap terrain tile as a Lua array.
Takes a table with keys: center, radius, and optional ignore_z.

get_npc_at

🇫 Function --> ( TripointBubMs, boolean? ) -> Npc
🇫 Function --> ( Tripoint, boolean? ) -> Npc

get_npcs_near_omt

🇫 Function --> ( table ) -> table

Returns active NPCs near an absolute overmap terrain tile as a Lua array.
Takes a table with keys: center, radius, and optional ignore_z.

get_overmap_buffer

🇫 Function --> ( ) -> OvermapBuffer

Get the global overmap buffer

get_player_pets

🇫 Function --> ( ) -> table

Get the player's pet monsters

get_simulated_npcs

🇫 Function --> ( ) -> table

Returns NPCs in simulated (fully loaded, AI-eligible) submaps as a Lua array.

Teleports player to local coordinates within active map

place_player_overmap_at

🇫 Function --> ( TripointAbsOmt )

Teleports player to absolute coordinate in overmap

Register a Lua-defined action menu entry in the in-game action menu.

Get the six cardinal overmap-terrain direction offsets (N, S, E, W, Up, Down).

Called when a character is dead.
The hook receives a table with keys:

char (Character)

killer (Creature)

on_character_display_skill_action

🇫 Function --> ( params: table )

Called when a skill is confirmed on the character display (@) skill tab.
The hook receives a table with keys:

character (Character)

skill (SkillId)
Set params.results.handled = true to prevent the default training toggle.

on_character_display_skill_info

🇫 Function --> ( params: table )

Called when drawing skill info on the character display (@) skill tab.
The hook receives a table with keys:

character (Character)

skill (SkillId)
Set params.results.text to append text below the regular skill description.

on_character_effect

🇫 Function --> ( params: table )

Called when character is on the effect which has EFFECT_LUA_ON_TICK flag.
The hook receives a table with keys:

character (Character)

effect (Effect)

on_character_effect_added

🇫 Function --> ( params: table )

Called when character gets the effect which has EFFECT_LUA_ON_ADDED flag.
The hook receives a table with keys:

char (Character)

effect (Effect)

on_character_effect_removed

🇫 Function --> ( params: table )

Called when character loses the effect which has EFFECT_LUA_ON_REMOVED flag.
The hook receives a table with keys:

character (Character)

effect (Effect)

on_character_reset_stats

🇫 Function --> ( params: table )

Called when character stat gets reset.
The hook receives a table with keys:

character (Character)

on_character_try_move

🇫 Function --> ( params: table )

Called after on_player_try_move or on_npc_try_move regardless of whether the specific hook vetoed.
All registered callbacks run; if any returns false, movement is blocked.
The hook receives a table with keys:

char (Character)

from (TripointBubMs)

to (TripointBubMs)

movement_mode (CharacterMoveMode)

via_ramp (bool)

mounted (bool)

mount (Creature, if mounted)
Return false to block the move.

on_creature_blocked

🇫 Function --> ( params: table )

Called when a character successfully blocks.
The hook receives a table with keys:

char (Character)

source (Creature)

bodypart_id (BodyPartTypeId)

damage_instance (DamageInstance)

damage_blocked (float)

on_creature_dodged

🇫 Function --> ( params: table )

Called when a character or monster successfully dodges.
The hook receives a table with keys:

char (Character)

source (Creature)

difficulty (integer)

on_creature_loaded

🇫 Function --> ( params: table )

Called when any creature is loaded onto the active map.
This is the base hook; on_monster_loaded and on_npc_loaded also trigger this.
The hook receives a table with keys:

creature (Creature)

on_creature_melee_attacked

🇫 Function --> ( params: table )

Called after a character or monster has attacked in melee.
The hook receives a table with keys:

char (Character)

target (Creature)

success (bool)

on_creature_performed_technique

🇫 Function --> ( params: table )

Called when a character has performed a technique.
The hook receives a table with keys:

char (Character)

technique (MartialArtsTechniqueRaw)

target (Creature)

damage_instance (DamageInstance)

move_cost (integer)

on_creature_spawn

🇫 Function --> ( params: table )

Called when any creature is spawned for the first time.
This is the base hook; on_monster_spawn and on_npc_spawn also trigger this.
The hook receives a table with keys:

creature (Creature)

on_dialogue_end

🇫 Function --> ( params: table )

Called when the dialogue window closes.
The hook receives a table with keys:

npc (NPC): The NPC speaking

on_dialogue_option

🇫 Function --> ( params: table )

Called when a dialogue option is selected.
The hook receives a table with keys:

npc (NPC): The NPC speaking

next_topic (string): The topic that was selected
Return a new talk_topic id to add it as the next topic.

on_dialogue_start

🇫 Function --> ( params: table )

Called just before the dialogue window opens and the first topic is chosen.
The hook receives a table with keys:

npc (NPC): The NPC speaking

next_topic (string): The topic that will be shown first
Return a new talk_topic id to add it as the next topic.

on_elevator_try_use

🇫 Function --> ( params: table )

Called before the player uses elevator controls.
All registered callbacks run; if any returns false, elevator use is blocked.
The hook receives a table with keys:

player (Player)

pos (TripointBubMs)

om_terrain (string)
Return false to block elevator use.

on_every_x

🇫 Function --> ( table )

Called every in-game period

on_explosion_start

🇫 Function --> ( params: table )

Called when an explosion starts.
The hook receives a table with keys:

pos (TripointBubMs)

damage (int)

radius (int)

fire (bool)

on_game_load

🇫 Function --> ( )

Called right after game has loaded.

on_game_save

🇫 Function --> ( )

Called when game is about to save.

on_game_started

🇫 Function --> ( )

Called when the game has first started.

on_mapgen_postprocess

🇫 Function --> ( params: table )

Called right after mapgen has completed.
The hook receives a table with keys:

map (Map): The tinymap that represents 24x24 area (2x2 submaps, or 1x1 omt).

omt (TripointAbsOmt): The absolute overmap terrain position.

when (TimePoint): The current time (for time-based effects).

on_mission_end

🇫 Function --> ( params: table )

Called right after mission has ended.
The hook receives a table with keys:

mission_type (mission_type): The type of the mission.

mission (mission): The mission instance.

success (bool): Successful if true else failed.

on_mission_start

🇫 Function --> ( params: table )

Called right after mission has started.
The hook receives a table with keys:

mission_type (mission_type): The type of the mission.

mission (mission): The mission instance.

on_mon_death

🇫 Function --> ( params: table )

Called when a monster is dead.
The hook receives a table with keys:

mon (Monster)

killer (Creature)

on_mon_effect

🇫 Function --> ( params: table )

Called when character is on the effect which has EFFECT_LUA_ON_TICK flag.
The hook receives a table with keys:

mon (Monster)

effect (Effect)

on_mon_effect_added

🇫 Function --> ( params: table )

Called when monster gets the effect which has EFFECT_LUA_ON_ADDED flag.
The hook receives a table with keys:

mon (Monster)

effect (Effect)

on_mon_effect_removed

🇫 Function --> ( params: table )

Called when monster loses the effect which has EFFECT_LUA_ON_REMOVED flag.
The hook receives a table with keys:

mon (Monster)

effect (Effect)

on_monster_loaded

🇫 Function --> ( params: table )

Called when a monster is loaded onto the active map.
Also triggers on_creature_loaded.
The hook receives a table with keys:

monster (Monster)

on_monster_spawn

🇫 Function --> ( params: table )

Called when a monster is spawned for the first time.
Also triggers on_creature_spawn.
Note: monsters spawned via mapgen submap spawn points will fire this hook,
but monsters materialized from overmap monster groups may not.
The hook receives a table with keys:

monster (Monster)

on_monster_try_move

🇫 Function --> ( params: table )

Called when a monster attempts to move.
All registered callbacks run; if any returns false, movement is blocked.
The hook receives a table with keys:

monster (Monster)

from (TripointBubMs)

to (TripointBubMs)

force (bool): If the monster move call was forced
Return false to block the move.

on_npc_interaction

🇫 Function --> ( params: table )

Called when the player interacts with an NPC.
The hook receives a table with keys:

npc (NPC): The NPC being interacted with

on_npc_loaded

🇫 Function --> ( params: table )

Called when an NPC is loaded onto the active map.
Also triggers on_creature_loaded.
The hook receives a table with keys:

npc (Npc)

on_npc_spawn

🇫 Function --> ( params: table )

Called when an NPC is spawned for the first time.
Also triggers on_creature_spawn.
The hook receives a table with keys:

npc (Npc)

on_npc_try_move

🇫 Function --> ( params: table )

Called when an NPC attempts to move.
All registered callbacks run; if any returns false, movement is blocked.
The hook receives a table with keys:

npc (Npc)

from (TripointBubMs)

to (TripointBubMs)

movement_mode (CharacterMoveMode)

via_ramp (bool)

mounted (bool)

mount (Creature, if mounted)
Return false to block the move.

on_player_try_move

🇫 Function --> ( params: table )

Called when the player attempts to move.
All registered callbacks run; if any returns false, movement is blocked.
The hook receives a table with keys:

player (Player)

from (TripointBubMs)

to (TripointBubMs)

movement_mode (CharacterMoveMode)

via_ramp (bool)

mounted (bool)

mount (Creature, if mounted)
Return false to block the move.

on_shoot

🇫 Function --> ( params: table )

Called when shot(s) is fired from a gun.
The hook receives a table with keys:

shooter (Character)

target_pos (TripointBubMs)

shots (int)

gun (item)

ammo (item): For RELOAD_AND_SHOOT guns like a bow. On the others, it returns nil value.

on_throw

🇫 Function --> ( params: table )

Called when an item is thrown.
The hook receives a table with keys:

thrower (Character)

target_pos (TripointBubMs)

throw_from_pos (TripointBubMs)

thrown (item)

on_try_monster_interaction

🇫 Function --> ( params: table )

Called when the player tries to interact with a monster.
The hook receives a table with keys:

monster (Monster): The monster being interacted with
Return false to prevent monster interaction actions from running.

on_try_npc_interaction

🇫 Function --> ( params: table )

Called when the player tries to interact with an NPC.
The hook receives a table with keys:

npc (NPC): The NPC being interacted with
Return false to prevent the npc interaction menu from appearing.

on_weather_changed

🇫 Function --> ( params: table )

Called when the weather has changed.
The hook receives a table with keys:

weather_id (string): Current weather ID

old_weather_id (string): Previous weather ID

temperature (float): Current temperature in Celsius

temperature_f (float): Current temperature in Fahrenheit

windspeed (float): Wind speed

winddirection (integer): Wind direction in degrees

humidity (float): Humidity percentage

pressure (float): Atmospheric pressure

is_sheltered (boolean): Whether player is sheltered

on_weather_updated

🇫 Function --> ( params: table )

Called every 5 minutes when weather data is updated.
The hook receives a table with keys:

weather_id (string): Current weather ID

temperature (float): Current temperature in Celsius

temperature_f (float): Current temperature in Fahrenheit

windspeed (float): Wind speed

winddirection (integer): Wind direction in degrees

humidity (float): Humidity percentage

pressure (float): Atmospheric pressure

is_sheltered (boolean): Whether player is sheltered

Expects english source string, returns translated string.

pgettext

🇫 Function --> ( string, string ) -> string

First is context string. Second is english source string.

vgettext

🇫 Function --> ( string, string, integer ) -> string

First is english singular string, second is english plural string. Number is amount to translate for.

vpgettext

🇫 Function --> ( string, string, string, integer ) -> string

First is context string. Second is english singular string. third is english plural. Number is amount to translate for.

Get all monster group definitions.

get_all_ids

🇫 Function --> ( ) -> MonsterGroupId[]

List all monster group ids currently loaded.

get_group

🇫 Function --> ( MonsterGroupId ) -> MonsterGroupRaw

Get a monster group definition by id.

get_monsters_from_group

🇫 Function --> ( MonsterGroupId ) -> MonsterTypeId[]

Get the monster ids directly listed in a group (default monster first).

List all monster type ids currently loaded.

Add an electric grid connection between two positions. Returns true on success.

check_ot

🇫 Function --> ( string, OtMatchType, TripointAbsOmt ) -> boolean

Check if the terrain at the given position matches the type and match mode. Returns boolean.

create_horde

🇫 Function --> ( table ) -> Mongroup

Create a monster horde at the given absolute OMT position. Pass a table with fields: type (mongroup_id, required), pos (TripointAbsOmt, required), radius (int), population (int), horde (bool), behaviour (string), diffuse (bool), target (TripointAbsOmt).

drain_fluid_grid_liquid_charges

🇫 Function --> ( TripointAbsOmt, ItypeId, integer ) -> integer

Drain liquid charges from the fluid grid at the given TripointAbsOmt position. Returns the number removed.

electric_grid_at

🇫 Function --> ( TripointAbsOmt ) -> TripointAbsOmt[]

Get all overmap tiles belonging to the electric grid at the given position. Returns TripointAbsOmt values.

electric_grid_connectivity_at

🇫 Function --> ( TripointAbsOmt ) -> TripointRelOmt[]

Get all electric grid connections from the given position. Returns TripointRelOmt offsets.

find_all

🇫 Function --> ( TripointAbsOmt, OmtFindParams ) -> TripointAbsOmt[]

Find all overmap terrain tiles matching the given parameters. Returns TripointAbsOmt values.

find_closest

🇫 Function --> ( TripointAbsOmt, OmtFindParams ) -> TripointAbsOmt?

Find the closest overmap terrain tile matching the given parameters. Returns TripointAbsOmt or nil if not found.

find_random

🇫 Function --> ( TripointAbsOmt, OmtFindParams ) -> TripointAbsOmt?

Find a random overmap terrain tile matching the given parameters. Returns TripointAbsOmt or nil if not found.

fluid_grid_at

🇫 Function --> ( TripointAbsOmt ) -> TripointAbsOmt[]

Get all overmap tiles belonging to the fluid grid at the given TripointAbsOmt position. Returns TripointAbsOmt values.

fluid_grid_connectivity_at

🇫 Function --> ( TripointAbsOmt ) -> TripointRelOmt[]

Get all fluid grid connections from the given TripointAbsOmt position. Returns TripointRelOmt offsets.

fluid_grid_liquid_charges_at

🇫 Function --> ( TripointAbsOmt, ItypeId ) -> integer

Get the available charges of a liquid in the fluid grid at the given TripointAbsOmt position.

fluid_grid_would_contaminate

🇫 Function --> ( TripointAbsOmt, ItypeId ) -> boolean

Check whether adding a liquid would contaminate the fluid grid at the given TripointAbsOmt position.

get_note

🇫 Function --> ( TripointAbsOmt ) -> string?

Get a player note at the given position. Returns string or nil.

has_horde

🇫 Function --> ( TripointAbsOmt ) -> boolean

Check if a horde is present at the given overmap tile.

horde_count

🇫 Function --> ( TripointAbsOmt ) -> integer

Count hordes influencing the given overmap tile (absolute OMT coordinates).

horde_size

🇫 Function --> ( TripointAbsOmt ) -> integer

Get the estimated size of the horde at the given overmap tile.

hordes_at

🇫 Function --> ( TripointAbsOmt ) -> Mongroup[]

List hordes influencing the given overmap tile (absolute OMT coordinates).

is_explored

🇫 Function --> ( TripointAbsOmt ) -> boolean

Check if the terrain at the given position has been explored by the player. Returns boolean.

monster_groups_at

🇫 Function --> ( TripointAbsOmt ) -> Mongroup[]

List monster groups influencing the given overmap tile (absolute OMT coordinates).

move_hordes

🇫 Function --> ( )

Advance horde movement across all loaded overmaps.

remove_grid_connection

🇫 Function --> ( TripointAbsOmt, TripointAbsOmt ) -> boolean

Remove an electric grid connection between two positions. Returns true on success.

reveal

🇫 Function --> ( TripointAbsOmt, integer, function? ) -> boolean

Reveal a square area around a TripointAbsOmt center on the overmap. Returns true if any new tiles were revealed. Optional filter callback receives oter_id and should return true to reveal that tile.

seen

🇫 Function --> ( TripointAbsOmt ) -> boolean

Check if the terrain at the given position has been seen by the player. Returns boolean.

set_note

🇫 Function --> ( TripointAbsOmt, string? )

Set a player note at the given position. Pass nil or empty string to clear.

set_seen

🇫 Function --> ( TripointAbsOmt, boolean? )

Set the seen status of terrain at the given position.

signal_hordes

🇫 Function --> ( TripointAbsSm, integer )

Signal nearby hordes toward an absolute submap position with the given strength.

ter

🇫 Function --> ( TripointAbsOmt ) -> OterIntId

Get the overmap terrain type at the given position. Returns an oter_id.

Sidebar utility functions.

Members

clear_widgets

🇫 Function --> ( )

Clear all registered Lua sidebar widgets.

get_layout_id

🇫 Function --> ( ) -> string

Returns current sidebar layout id (e.g. classic, compact, labels).

register_widget

🇫 Function --> ( table )

Register a Lua sidebar widget. Options: id(string), name(string), height(int, use -2 to fill remaining space), order(int, 1-based), draw(function), default_toggle(bool), redraw_every_frame(bool), panel_visible(bool|function), render(function). draw(width, height) returns an array of entries: each entry is string or table { text=string, color=Color|string }. text may include color tags like <color_red>text for multi-color lines.