Home Wiki Source Downloads Discord

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⮭

Player

┗> Character > Object > Class

Constructor

Player(chara: any, x: any, y: any)

Arguments:

chara: any
x: any
y: any

Methods

Player:alignFollowers(facing: any, x: any, y: any, dist: any)

Arguments:

facing: any
x: any
y: any
dist: any

Player:beginSlide(last_state: any, in_place: any, lock_movement: any)

Arguments:

last_state: any
in_place: any
lock_movement: any

Player:draw()

Player:endSlide(next_state: any)

Arguments:

next_state: any

Player:getDebugInfo()

Returns:

Player:getDebugOptions(context: any)

Arguments:

context: any

Returns:

Player:handleMovement()

Player:interact()

Returns:

Player:interpolateFollowers()

Player:isCameraAttachable()

Returns:

Player:isMovementEnabled()

Returns:

Player:isMoving()

Returns:

Player:onAdd(parent: any)

Arguments:

parent: any

Player:onRemove(parent: any)

Arguments:

parent: any

Player:onRemoveFromStage(stage: any)

Arguments:

stage: any

Player:resetFollowerHistory()

Player:setActor(actor: any)

Arguments:

actor: any

Player:setState(state: any, : unknown)

Arguments:

state: any
: unknown

Player:update()

Player:updateHistory()

Player:updateSlide()

Player:updateSlideDust()

Player:updateWalk()

Fields

Undocumented

Player.auto_moving: boolean

Player.auto_moving: boolean

Player.auto_moving: boolean

Player.battle_alpha: integer

Player.battle_alpha: number

Player.battle_alpha: number

Player.current_slide_area: nil

Player.force_run: boolean

Player.force_run: boolean

Player.force_walk: boolean

Player.force_walk: boolean

Player.history: table

Player.history: table

Player.history_time: integer

Player.history_time: number

Player.hurt_timer: integer

Player.hurt_timer: number

Player.interact_buffer: integer

Player.interact_buffer: integer

Player.interact_buffer: number

Player.interact_collider: table

Player.is_player: boolean

Player.last_move_x: any

Player.last_move_x: any

Player.last_move_y: any

Player.last_move_y: any

Player.moving_x: integer

Player.moving_x: integer

Player.moving_y: integer

Player.moving_y: integer

Player.noclip: boolean

Player.outlinefx: BattleOutlineFX

Player.persistent: boolean

Player.run_timer: integer

Player.run_timer: integer

Player.run_timer: integer

Player.run_timer: number

Player.run_timer: integer

Player.run_timer: integer

Player.run_timer_grace: integer

Player.run_timer_grace: integer

Player.run_timer_grace: number

Player.slide_dust_timer: integer

Player.slide_dust_timer: number

Player.slide_dust_timer: integer

Player.slide_in_place: boolean

Player.slide_in_place: any

Player.slide_land_timer: integer

Player.slide_land_timer: integer

Player.slide_land_timer: integer

Player.slide_land_timer: number

Player.slide_lock_movement: boolean

Player.slide_lock_movement: any

Player.slide_lock_movement: boolean

Player.slide_sound: love.Source|nil

A Source represents audio you can play back.

You can do interesting things with Sources, like set the volume, pitch, and its position relative to the listener. Please note that positional audio only works for mono (i.e. non-stereo) sources.

The Source controls (play/pause/stop) act according to the following state table.

Open in Browser

Player.state_manager: StateManager

Player.walk_speed: integer