Character

Creates an alert bubble (tiny !) above this character.

@param duration — The number of frames to show the bubble for. (Defaults to 20)

@param options — A table defining additional properties to control the bubble.

options:
    | "play_sound" -- Whether the alert sound will be played. (Defaults to `true`)
    | "sprite" -- The sprite to use for the alert bubble. (Defaults to `"effects/alert"`)
    | "offset_x" -- The x-offset of the icon.
    | "offset_y" -- The y-offset of the icon.
    | "layer" -- The layer to put the icon on. (Defaults to `100`)
    | "callback" -- A callback that is run when the alert finishes.

Moves the character to a new position with a jumping arc motion.

@param x — The x-coordinate to move the character to.

@param y — The y-cooridinate to move the character to.

@param marker — The name of a marker in the map to move the character to.

@param speed — The speed, as upwards velocity of the character when they start the jump. Defaults to 0.

@param time — The time, in seconds, that the jump will take. Defaults to 1 second.

@param jump_sprite — The sprite that will be used whilst the character is in midair.

@param land_sprite — The sprite that will be used just as the character leaves the ground and as they land.

Resets the character's to their default animation or sprite.

Makes the character face in the direction specified by dir.

@param dir — The direction the character should face. Must be "up", "down", "left", or "right".

Makes the character start spinning.

@param speed — The spin speed to set on the character. Negative numbers = anticlockwise, positive numbers = clockwise. Higher value = slower spin.

Walks the character along a given path.

@param path — The name of a path in the current map file, or a table defining several points (as additional tables) that constitute a path.

@param options — A table defining additional properties to control the walk.

options:
    | "facing" -- The direction the character should face when they finish their walk. If `keep_facing` is `true`, they will instead face way immediately.
    | "keep_facing" -- If `true`, the facing direction of the character will be preserved. Otherwise, they will face the direction they are walking. (Defaults to `false`)
    | "time" -- The amount of time, in seconds, that the object should take to travel along the full path.
    | "speed" -- The speed at which the object should travel along the path, in pixels per frame at 30FPS.
    | "ease" -- The ease type to use when travelling along the path. Unused if `speed` is specified instead of `time`. (Defaults to "linear")
    | "after" -- A function that will be called when the end of the path is reached. Receives no arguments.
    | "relative" -- Whether the path should be relative to the object's current position, or simply set its position directly.
    | "loop" -- Whether the path should loop back to the first point when reaching the end, or if it should stop.
    | "reverse" -- If true, reverse all of the points on the path.
    | "skip" -- A number defining how many points of the path to skip.
    | "snap" -- Whether the object's position should immediately "snap" to the first point, or if its initial position should be counted as a point on the path.

Walks this character to a new x and y over time seconds.

@param x — The new x value to approach.

@param y — The new y value to approach.

@param marker — A map marker whose position the object should approach.

@param time — The amount of time, in seconds, that the slide should take. (Defaults to 1 second)

@param facing — The direction the character should face when they finish their walk. If keep_facing is true, they will instead face way immediately.

@param keep_facing — If true, the facing direction of the character will be preserved. Otherwise, they will face the direction they are walking. (Defaults to false)

@param after — A callback function that is run after the character has finished walking.

@return success — Whether the walking will occur. False if the character's current position is already at the specified position, and true otherwise.

Walks this character to a new x and y at speed pixels per frame.

@param x — The new x value to approach.

@param y — The new y value to approach.

@param marker — A map marker whose position the object should approach.

@param speed — The amount that the object's x and y should approach the specified position, in pixels per frame at 30FPS. (Defaults to 4)

@param facing — The direction the character should face when they finish their walk. If keep_facing is true, they will instead face way immediately.

@param keep_facing — If true, the facing direction of the character will be preserved. Otherwise, they will face the direction they are walking. (Defaults to false)

@param after — A callback function that is run after the character has finished walking.

@return success — Whether the walking will occur. False if the character's current position is already at the specified position, and true otherwise.

Actors are a type of data class that represent the visuals of a character - anything that is some type of character, be it the player, an NPC, or an enemy in battle, it will require an actor.
As a data class, actors are stored in scripts/data/actors/, and extend this class. Their filepath starting from here becomes their id, unless an id is specified as an argument to Class().

A simple object that renders a texture.
This texture must be placed inside assets/sprites/.

A simple object that renders a texture.
This texture must be placed inside assets/sprites/.

A simple object that renders a texture.
This texture must be placed inside assets/sprites/.

if (landsprite == spr_kris_dw_landed) -- If it's the Kris kneeling one, { self.x = self.x - 4 self.y = self.y + 2 self.false_end_x = self.false_end_x - 8 self.jump_start_x = self.jump_start_x - 8 self.jump_start_y = self.jump_start_y - 8 } if (landsprite == spr_susie_dw_landed) { self.x = self.x - 8 self.false_end_x = self.false_end_x - 8 self.jump_start_x = self.jump_start_x + 12 self.jump_start_y = self.jump_start_y - 12 } if (landsprite == spr_teacup_ralsei_land) { self.y = self.y + 4 self.jump_start_y = self.jump_start_y + 8 self.jump_start_x = self.jump_start_x - 12 self.false_end_x = self.false_end_x - 6 self.false_end_y = self.false_end_y + 4 } if (jumpsprite == spr_ralsei_jump) { shadowoffx = shadowoffx - 10 shadowoffy = shadowoffy - 4 } }

dark = (global.darkzone + 1)

The party member id represented by this character

An extension of Sprite that can integrate with an actor. If an object defines an Actor, it will use this over Sprite for its sprite.

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