Event

@param shape — Shape data for this event. First two indexes are the width and height of the object. The third (optional) index is polygon data.

Adds amount to a numeric flag named flag (or defines it if it does not exist)
This variant of Game:addFlag() interacts with flags specific to this event's unique id

@param flag — The name of the flag to add to

@param amt — (Defaults to 1)

Causes this event to flash once

@param sprite — An optional sprite to use for the flash instead of the event's default sprite.

Gets the value of the flag named flag, returning default if the flag does not exist
This variant of Game:getFlag() interacts with flags specific to this event's unique id

Gets this Event instance's unique id within the whole mod The returned id follows the format #[map.id](file:///vercel/path0/tmp/kristal/luadoc_meta/class.lua#26)#[object_id](file:///vercel/path0/tmp/kristal/src/engine/game/world/event.lua#11) if a custom unique_id is not defined

Called when the event is added as the child of another object

(Override) Called every frame the player and event are colliding with each other

(Override) Called whenever the player enters this event

(Override) Called whenever the player leaves this event

(Override) Called whenever the player interacts with this event

@param player — The interacting Player

@param dir — The direction the player is facing

@return blocking — Whether this interaction should prevent other events in the interaction region activating with this frame

Runs once the map has finished loading

Called when the event is removed

Runs once the entire world has finished loading

Sets the value of the flag named flag to value
This variant of Game:setFlag() interacts with flags specific to this event's unique id

Changes the object's sprite

@param texture — The name of the new texture to set, removes the object's sprite if nil

@param speed — The speed at which the new sprite should animate if it has multiple frames

@param use_size — Whether to use the sprite's size for the event's size (defaults to true)

Shakes this Event by the specified amount, shaking the sprite instead if it exists

@param x — The amount of shake in the x direction. (Defaults to 4)

@param y — The amount of shake in the y direction. (Defaults to 0)

@param friction — The amount that the shake should decrease by, per frame at 30FPS. (Defaults to 1)

@param delay — The time it takes for the object to invert its shake direction, in seconds. (Defaults to 1/30)

Shakes this event by the specified amount

@param x — The amount of shake in the x direction. (Defaults to 4)

@param y — The amount of shake in the y direction. (Defaults to 0)

@param friction — The amount that the shake should decrease by, per frame at 30FPS. (Defaults to 1)

@param delay — The time it takes for the object to invert its shake direction, in seconds. (Defaults to 1/30)

Stops this event or its sprite from shaking

Stops a shake applied directly to this event

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

The world that this event is contained in

Default collider (Object width and height)