API reference

Find AeoScript and Worldkiln APIs.

Global functions

debug.log Print values to Output.
find Find named Cells, Actors, and live Entities.
get_entity Find a live Entity by name.
getAllCellsOfClass Find active Cells of a class.
get_light Find a Light at World coordinates.
spawn Create a live Entity at a position.
wait Pause this script, then continue.
time.delta Read the current frame duration.
attach Attach an object to a named rig point.
detach Remove an attachment and restore normal movement.

Actors and Modules

proj.find Find one authored Actor in the project hierarchy.
proj.find.all Find every matching Actor in the selected scope.
player.find Find one Player-attached Module.
player.find.all Find all matching Player-attached Modules.
scripts Load a reusable script Module.
self.parent Read the Actor that owns this Module.
player.controller Read the enabled Player Module named controller.
object.get_children Read the children exposed by the engine host.
object.get_parent Read the parent exposed by the engine host.

Math

math.abs Return the distance of a number from zero.
math.min Return the smaller number.
math.max Return the larger number.
math.floor Round down to a whole number.
math.ceil Round up to a whole number.
math.round Round to the nearest whole number.
math.sqrt Return the square root.
math.pow Raise a number to a power.
math.sin Return the sine of an angle.
math.cos Return the cosine of an angle.
math.tan Return the tangent of an angle.
math.deg_to_rad Convert degrees to radians.
math.rad_to_deg Convert radians to degrees.
math.clamp Keep a number within a range.
math.lerp Find a value along the range from a to b.
math.random Choose a random number.

Basket

basket.len Count basket elements.
basket.create Create a basket of a given length.
basket.insert Insert a value, or append it at the end.
basket.remove Remove an element.
basket.sort Sort values in ascending order.
basket.clear Remove all elements.
basket.find Find a value inside a basket.
basket.move Copy an inclusive range into a destination basket.
basket.concat Join basket values into text.
basket.clone Copy the outer basket.
basket.freeze Make a basket read-only.

String

string.len Count Unicode characters.
string.lower Convert text to lowercase.
string.upper Convert text to uppercase.
string.reverse Reverse text characters.
string.split Split text into pieces.

Cells

cell.get Find a Cell by ID.
cell.exists Check whether a Cell exists.
cell.new Create a temporary Cell.
cell.delete Remove a Cell from the active game.
cell.id Read the persistent Cell ID.
cell.name Read the Cell identity name.
cell.cellType Read the Cell type name.
cell.position Read or change a runtime-created Cell position.
cell.visible Show or hide the Cell.
cell.enabled Enable or disable the Cell or Light.
cell.solid Control Cell collision.
cell.anchored Control whether the Cell stays fixed.
cell.color Change the Cell color.
cell.offset Change the Cell visual offset.
cell.attributes Read custom Cell values.
cell.sound Get an AudioEmitter Cell sound control.
light.getObject Get the object associated with this Cell.
light.is_enabled Read whether this Light is enabled.
light.set_enabled Change whether this Light is enabled.

Actor handles

actor.id Read the authored Actor ID.
actor.actor_id Read the authored Actor ID.
actor.is_actor Check the authored Actor kind.
actor.name Read the Actor name.
actor.position Read or change the Actor position.
actor.rotation Read or change Actor rotation.
actor.scale Read or change Actor scale.
actor.visible Show or hide the Actor.
actor.enabled Enable or disable the Actor.
actor.package Read the Actor package name.
actor.attributes Read the Actor attributes.
actor.facing Read the Actor facing direction.
actor.is_valid Check whether the object still exists.
actor.name() Read the object name.
actor.set_position Set the object position.
actor.translate Move the object by an offset.
actor.destroy Destroy the live object.
actor.set_horizontal_velocity Set horizontal movement speed.
actor.set_facing_direction Set the direction the Character faces.
actor.select_animation Choose a Character animation.
actor.is_grounded Check whether the Character is on the ground.
actor.apply_vertical_impulse Apply upward or downward movement.
actor.navigate_to [BETA]Ask the engine to move an Actor along a route.
actor.cancel_navigation [BETA]Cancel the current navigation request.
actor.is_navigating [BETA]Check whether the Actor has an active route.

Entity handles

entity.get Find a live Entity by ID.
entity.exists Check whether a runtime Entity exists.
entity.is_valid Check whether the object still exists.
entity.name() Read the object name.
entity.set_position Set the object position.
entity.translate Move the object by an offset.
entity.destroy Destroy the live object.
entity.id Read the runtime Entity ID.
entity.name Read the Entity name.
entity.position Read or change Entity position.
entity.velocity Read or change Entity velocity.
entity.facing Read or change Entity facing.
entity.grounded Read whether the Entity is on the ground.
entity.animation_name Read or select the base animation name.
entity.health Read or set current health.
entity.max_health Read or set maximum health.
entity.alive Read whether the Character is alive.
entity.is_actor Read whether this Entity backs an Actor.
entity.actor_id Read the authored Actor ID, if present.
entity.package Read the Character package, if present.
entity.attributes Read the Entity attribute view.
entity.sound Get the Entity sound capability where supported.
entity.physics Get the Entity physics controls.
entity.animation Get the Entity animation controls.
entity.appearance Get the Entity appearance capability.
entity.jump Make a Character jump.
entity.damage Reduce Character health.
entity.heal Restore Character health.
entity.find_path Request a path through the World.
entity.animation.play_layer Play an animation over part of a rig.
entity.animation.entity Read the owning Entity.
entity.animation.kind Read the capability kind.
entity.appearance.entity Read the owning Entity.
entity.appearance.kind Read the capability kind.
entity.animation.is_valid Check whether the owning Entity still exists.
entity.appearance.is_valid Check whether the owning Entity still exists.

UI

control.key Read or set the Script key.
control.anchor Choose the point used for layout.
control.position Read or change position in viewport pixels.
control.size Read or change control size.
control.visible Show or hide the control.
control.enabled Enable or disable interaction.
control.color Read or change the control color.
control.parent Choose a parent control.
control.z_index Choose the drawing order.
control.corner_radius Round the control corners.
control.border_width Choose the border width.
control.border_color Choose the border color.
control.text Read or change the label text.
control.font_size [BETA]Choose the font size.
control.horizontal_align [BETA]Align text horizontally.
control.vertical_align [BETA]Align text vertically.
control.wrap [BETA]Choose whether text wraps.
control.padding [BETA]Set space around the text.
control.line_spacing [BETA]Set extra space between lines.
control.on_click Set the function called when a Button is clicked.
ui.find Find a UI control by Script key.
ui.get Find a UI control by Script key.
ui.new Create a temporary UI control.
ui.delete Remove a control during Play.
ui.get_viewport_size Read the playable viewport size.

Input

player.set_horizontal_velocity Set horizontal movement speed.
player.set_facing_direction Set the direction the Character faces.
player.select_animation Choose a Character animation.
player.is_grounded Check whether the Character is on the ground.
player.apply_vertical_impulse Apply upward or downward movement.
input.get_move_vector Read movement input.
input.is_jump_pressed Read jump input.
input.get_orbit_delta Read camera orbit input.
input.is_key_down Check whether a physical key is held.
get.mouse Get the runtime mouse controls.
mouse.setCursorVisible Show or hide the cursor.
mouse.setScreenLocked Lock or unlock the mouse.
player.position Read the active Player position.

Camera

camera.get_horizontal_basis Read camera-relative forward and right directions.
camera.set_position Place the gameplay camera.
camera.set_target Choose the gameplay camera target.
camera.set_orientation Set gameplay camera orientation.

Physics

physics.resolve_camera_collision Adjust a desired camera position for collision.
entity.physics.entity Read the owning Entity.
entity.physics.kind Read the capability kind.
entity.physics.grounded Read whether the body is grounded.
entity.physics.enabled Enable or disable body simulation.
entity.physics.solid Choose whether the body blocks movement.
entity.physics.anchored Choose whether the body is fixed.
entity.physics.collision_enabled Enable or disable body collision.
entity.physics.mass Set body mass.
entity.physics.velocity Read or change body velocity.
entity.physics.gravity_scale Scale gravity for this body.
entity.physics.size Read or change collider dimensions.
entity.physics.is_valid Check whether the owning Entity exists.
entity.physics.apply_force Apply a force to the body.
entity.physics.apply_impulse Apply an immediate impulse.
entity.physics.stop Stop the body movement.
entity.physics.wake Wake a sleeping body.

Audio

sound.playing Read or change whether sound is playing.
sound.looped Choose whether the sound loops.
sound.volume Read or change sound volume.
sound.play Start sound playback.
sound.pause Pause sound playback.
sound.stop Stop sound playback.

Script

script.enable Enable script execution.
script.disable Stop script execution and cancel its active work.
script.is_enabled Check whether a script is enabled.

Events

event.fire Send an event to matching script handlers.
on_touch React when another object starts touching this object.
on_overlap Receive a supported overlap event.
on.keypress React to key press and release.
navigation_finished [BETA]React when an engine-owned route completes.
navigation_failed [BETA]React when navigation cannot finish.

Test

test.complete Record the result of an in-game test.
test.is_completed Check whether a test has finished.
test.passed Read a recorded test result.
test.summary Read test totals.

Save data

save.get [BETA]Read a saved value.
save.set [BETA]Stage a save value in memory.
save.has [BETA]Check whether a save key exists.
save.remove [BETA]Stage removal of a save key.
save.commit [BETA]Write staged save changes to disk.

Particles

particles.burst [BETA]Create a burst of temporary particles.
particles.set_enabled [BETA]Enable or disable a ParticleEmitter Cell.
particles.count [BETA]Count active particles.
particles.clear [BETA]Remove all active particles.

Engine internals

Runtime and waiting
How Worldkiln runs and pauses script work.
Engine host
How scripts reach engine-owned objects.
Physics architecture
How simulation and script controls fit together.
Persistence [BETA]
Keep authored content, runtime changes, and save data separate.

[BETA] marks features newer than the current public release. Current release: 0.8.0.