Player

┗> Character > Object > Class

The character controlled by the player when in the Overworld.

Constructor

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

Arguments:

chara: number
x: number
y: number

Methods

Player:alignFollowers(facing: string?, x: number?, y: number?, dist: number?)

Aligns the player's followers' directions and positions.

Arguments:

facing: string?	The direction every character should face (Defaults to player's direction)
x: number?	The x-coordinate of the 'front' of the line. (Defaults to player's x-position)
y: number?	The y-coordinate of the 'front' of the line. (Defaults to player's y-position)
dist: number?	The distance between each follower.

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:getBaseWalkSpeed()

Returns:

Player:getCurrentSpeed(running: any)

Arguments:

running: any

Returns:

Player:getDebugInfo()

Returns:

Player:getDebugOptions(context: ContextMenu)

Arguments:

context: ContextMenu

Returns:

Player:handleMovement()

Player:interact()

Returns:

Player:interpolateFollowers()

Adds all followers' current positions to their movement history.

Player:isCameraAttachable()

Returns:

Player:isMovementEnabled()

Returns:

Player:isMoving()

Returns:

Player:onAdd(parent: World)

Arguments:

parent: World

The World Object manages everything relating to the overworld in Kristal.
A globally available instance of World is stored in Game.world.

Player:onRemove(parent: World)

Arguments:

parent: World

The World Object manages everything relating to the overworld in Kristal.
A globally available instance of World is stored in Game.world.

Player:onRemoveFromStage(stage: Object)

Arguments:

stage: Object

The base class of all objects in Kristal.
When added to the stage, an object will be updated and rendered.

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()

Undocumented

Player.auto_moving: boolean

Player.battle_alpha: integer

Player.current_slide_area: nil

Player.force_run: boolean

Player.force_walk: boolean

Player.history: table

Player.history_time: integer

Player.hurt_timer: integer

Player.interact_buffer: integer

Player.interact_collider: table

Player.is_player: boolean

Player.last_move_x: number

Player.last_move_y: number

Player.moving_x: integer

Player.moving_y: integer

Player.noclip: boolean

Player.outlinefx: BattleOutlineFX

Player.persistent: boolean

Player.run_timer: integer

Player.run_timer_grace: integer

Player.slide_dust_timer: integer

Player.slide_in_place: boolean

Player.slide_land_timer: integer

Player.slide_lock_movement: boolean

Player.slide_sound: Sound

The sound class. This is a transparent wrapper over Love2D's Source.

Player.state_manager: StateManager