Skip to main content
Link
Menu
Expand
(external link)
Document
Search
Copy
Copied
Crystal
Getting Started
API Reference
crystal
crystal.developer_start
crystal.player_start
crystal.prelude
crystal.ai
crystal.AISystem
crystal.Navigation
crystal.assets
crystal.assets.add_loader
crystal.assets.get
crystal.assets.is_loaded
crystal.assets.load
crystal.assets.set_directories
crystal.assets.unload
crystal.assets.unload_all
crystal.assets.unload_context
crystal.Animation
crystal.Map
crystal.Sequence
crystal.Spritesheet
crystal.Tileset
crystal.cmd
crystal.cmd.add
crystal.cmd.run
crystal.const
crystal.const.define
crystal.const.get
crystal.const.set
crystal.ecs
crystal.Component
crystal.ECS
crystal.Entity
crystal.Event
crystal.Query
crystal.System
crystal.graphics
crystal.AnimatedSprite
crystal.Color
crystal.DrawEffect
crystal.DrawOrder
crystal.DrawSystem
crystal.Drawable
crystal.Sprite
crystal.SpriteBatch
crystal.WorldWidget
crystal.hot_reload
crystal.hot_reload.disable
crystal.hot_reload.enable
crystal.hot_reload.persist
crystal.input
crystal.input.add_mouse_target
crystal.input.assign_gamepad
crystal.input.assign_mouse
crystal.input.axis_action_value
crystal.input.configure_autorepeat
crystal.input.current_mouse_target
crystal.input.gamepad_id
crystal.input.input_method
crystal.input.is_action_down
crystal.input.map_axis_to_actions
crystal.input.mouse_player
crystal.input.set_unassigned_gamepad_handler
crystal.input.unassign_gamepad
crystal.InputListener
crystal.InputSystem
crystal.MouseArea
InputMethod
crystal.log
crystal.log.debug
crystal.log.error
crystal.log.fatal
crystal.log.info
crystal.log.set_verbosity
crystal.log.warning
Verbosity
crystal.physics
crystal.physics.define_categories
crystal.Body
crystal.Collider
crystal.Movement
crystal.PhysicsSystem
crystal.Sensor
crystal.scene
crystal.scene.current
crystal.scene.replace
crystal.Camera
crystal.CameraController
crystal.Scene
crystal.Transition
LoadScene
crystal.script
crystal.Behavior
crystal.Script
crystal.ScriptRunner
crystal.ScriptSystem
crystal.Thread
crystal.test
crystal.test.add
crystal.test.is_running_tests
crystal.TestContext
crystal.tool
crystal.tool.add
crystal.tool.hide
crystal.tool.is_visible
crystal.tool.show
crystal.Tool
crystal.ui
crystal.ui.font
crystal.ui.register_font
crystal.BasicJoint
crystal.Border
crystal.Container
crystal.HorizontalList
crystal.HorizontalListJoint
crystal.Image
crystal.Joint
crystal.Overlay
crystal.Padding
crystal.Painter
crystal.RoundedCorners
crystal.Switcher
crystal.Text
crystal.UIElement
crystal.VerticalList
crystal.VerticalListJoint
crystal.Widget
crystal.Wrapper
BindingRelevance
Direction
HorizontalAlignment
SwitcherSizing
VerticalAlignment
crystal.window
crystal.window.draw
crystal.window.draw_native
crystal.window.draw_via_canvas
crystal.window.set_aspect_ratio_limits
crystal.window.set_native_height
crystal.window.set_safe_area
crystal.window.set_scaling_mode
crystal.window.transform
crystal.window.viewport_scale
crystal.window.viewport_size
ScalingMode
Lua Extensions
Math Extensions
math.angle_between
math.angle_delta
math.angle_to_cardinal
math.clamp
math.cross_product
math.damp
math.distance
math.distance_squared
math.dot_product
math.index_to_xy
math.length
math.length_squared
math.lerp
math.normalize
math.round
OOP (Object Oriented Programming)
String Extensions
string.ends_with
string.file_extension
string.merge_paths
string.parent_directory
string.split
string.starts_with
string.strip_file_extension
string.strip_whitespace
string.trim
Table Extensions
table.any_key
table.append
table.clear
table.contains
table.copy
table.count
table.deep_copy
table.deserialize
table.equals
table.index_of
table.is_array
table.is_empty
table.map
table.merge
table.overlay
table.pop
table.push
table.serialize
Built-in Tools
Console
FPS Counter
Search Crystal
Built-in Tools
FPS Counter
FPS Counter
Console Commands
Name
Description
HideFPSCounter
Stops drawing the FPS Counter.
ShowFPSCounter
Starts drawing the FPS Counter.