HomeWikiSourceDownloadsDiscord

Kristal Wiki

Getting Started

These pages get you ready to use the engine.


General Mod Creation

These pages teach you about mod development.


The Overworld

Everything to do with the overworld.


Battles

Everything related to creating battles.


API Reference

An auto-generated API reference for Kristal.

⮬Back to Top⮭

Constructor




Methods

PartyMember:addFlag(name: any, amount: any)

Arguments:

name: any
amount: any

Returns:

1: unknown

PartyMember:addSpell(spell: any)

Arguments:

spell: any

PartyMember:addStatBuff(stat: any, amount: any, max: any)

Arguments:

stat: any
amount: any
max: any




PartyMember:canEquip(item: any, slot_type: any, slot_index: any)

Arguments:

item: any
slot_type: any
slot_index: any

Returns:

1: boolean|unknown

PartyMember:checkArmor(id: any)

Arguments:

id: any

Returns:

1: boolean
2: integer

PartyMember:checkWeapon(id: any)

Arguments:

id: any

Returns:

1: boolean



PartyMember:drawPowerStat(index: any, x: any, y: any, menu: any)

Arguments:

index: any
x: any
y: any
menu: any

PartyMember:getActor(light: any)

Arguments:

light: any

Returns:

1: Actor|nil

PartyMember:getArmor(i: any)

Arguments:

i: any

Returns:

1: unknown






PartyMember:getBaseStat(name: any, default: any, light: any)

Arguments:

name: any
default: any
light: any

Returns:

1: integer

PartyMember:getBaseStats(light: any)

Arguments:

light: any

Returns:

1: table





PartyMember:getEquipmentBonus(stat: any)

Arguments:

stat: any

Returns:

1: unknown

PartyMember:getFlag(name: any, default: any)

Arguments:

name: any
default: any

Returns:

1: unknown







PartyMember:getLightEXPNeeded(lv: any)

Arguments:

lv: any

Returns:

1: integer


PartyMember:getMaxStat(stat: any)

Arguments:

stat: any

Returns:

1: unknown






PartyMember:getReaction(item: any, user: any)

Arguments:

item: any
user: any




PartyMember:getStat(name: any, default: any, light: any)

Arguments:

name: any
default: any
light: any

Returns:

1: unknown

PartyMember:getStatBuff(stat: any)

Arguments:

stat: any

Returns:

1: integer


PartyMember:getStats(light: any)

Arguments:

light: any

Returns:

1: table|nil







PartyMember:hasSpell(spell: any)

Arguments:

spell: any

Returns:

1: boolean



PartyMember:heal(amount: any, playsound: any)

Arguments:

amount: any
playsound: any

Returns:

1: boolean

PartyMember:increaseStat(stat: any, amount: any, max: any)

Arguments:

stat: any
amount: any
max: any

PartyMember:load(data: any)

Arguments:

data: any

PartyMember:loadEquipment(data: any)

Arguments:

data: any

PartyMember:loadSpells(data: any)

Arguments:

data: any

PartyMember:onActionBox(box: any, overworld: any)

Arguments:

box: any
overworld: any

PartyMember:onActionSelect(battler: any, undo: any)

Arguments:

battler: any
undo: any

PartyMember:onAttackHit(enemy: any, damage: any)

Arguments:

enemy: any
damage: any

PartyMember:onEquip(item: any, item2: any)

Arguments:

item: any
item2: any

Returns:

1: boolean

PartyMember:onLevelUp(level: any)

Arguments:

level: any

PartyMember:onLoad(data: any)

Arguments:

data: any

PartyMember:onPowerDeselect(menu: any)

Arguments:

menu: any

PartyMember:onPowerSelect(menu: any)

Arguments:

menu: any

PartyMember:onSave(data: any)

Arguments:

data: any

PartyMember:onTurnStart(battler: any)

Arguments:

battler: any

PartyMember:onUnequip(item: any, item2: any)

Arguments:

item: any
item2: any

Returns:

1: boolean

PartyMember:removeSpell(spell: any)

Arguments:

spell: any

PartyMember:resetBuff(stat: any)

Arguments:

stat: any


PartyMember:save()

Returns:

1: table



PartyMember:setActor(actor: any)

Arguments:

actor: any

PartyMember:setArmor(i: any, item: any)

Arguments:

i: any
item: any

PartyMember:setFlag(name: any, value: any)

Arguments:

name: any
value: any

PartyMember:setHealth(health: any)

Arguments:

health: any

PartyMember:setLightActor(actor: any)

Arguments:

actor: any

PartyMember:setStatBuff(stat: any, amount: any)

Arguments:

stat: any
amount: any

PartyMember:setWeapon(item: any)

Arguments:

item: any


Fields


Undocumented


PartyMember.actor: nil

Actor (handles overworld/battle sprites)



PartyMember.attack_bar_color: nil

Attack bar color (for the target bar used in attack mode) (defaults to the main color)


PartyMember.attack_box_color: nil

Attack box color (for the attack area in attack mode) (defaults to darkened main color)


PartyMember.attack_pitch: integer

Pitch of the attack sound


PartyMember.attack_sound: string

Sound played when this character attacks


PartyMember.attack_sprite: string

Effect shown above enemy after attacking it


PartyMember.battle_offset: nil

Battle position offset (optional)


PartyMember.color: table

Character color (for action box outline and hp bar)


PartyMember.dmg_color: nil

Damage color (for the number when attacking enemies) (defaults to the main color)


PartyMember.equipped: table

Equipment (saved to the save file)




PartyMember.flags: table

Character flags (saved to the save file)



PartyMember.gameover_message: nil

Message shown on gameover (optional)


PartyMember.has_act: boolean

Whether the party member can act / use spells



PartyMember.has_xact: boolean

Whether the party member can use their X-Action


PartyMember.head_icon_offset: nil

Head icon position offset (optional)


PartyMember.head_icons: string

Path to head icons used in battle


PartyMember.health: integer

Current health (saved to the save file)




PartyMember.level: integer

Display level (saved to the save file)



PartyMember.lw_actor: nil

Light World Actor (handles overworld/battle sprites in light world maps) (optional)




PartyMember.lw_exp: integer

Light world EXP (saved to the save file)



PartyMember.lw_exp_needed: table

Light world EXP requirements


PartyMember.lw_health: integer

Current light world health (saved to the save file)



PartyMember.lw_health: unknown|nil

For deltarune accuracy, you heal here, bc health conversion code is broken



PartyMember.lw_lv: integer

Light world LV (saved to the save file)



PartyMember.lw_stats: table

Light world stats (saved to the save file)



PartyMember.lw_weapon_default: string

Default light world equipment item IDs (saves current equipment)


PartyMember.max_stats: table

Max stats from level-ups





PartyMember.name_sprite: nil

Name sprite (optional)


PartyMember.soul_color: table

The color of this character's soul (optional, defaults to red)


PartyMember.soul_priority: integer

Determines which character the soul comes from (higher number = higher priority)




PartyMember.stat_buffs: table

Temporary stat buffs in battles




PartyMember.stats: table

Base stats (saved to the save file)



PartyMember.title: string

Default title / class (saved to the save file)



PartyMember.weapon_icon: string

Weapon icon in equip menu


PartyMember.xact_color: nil

X-Action color (for the color of X-Action menu items) (defaults to the main color)


PartyMember.xact_name: string

X-Action name (displayed in this character's spell menu)