Skip to content
luxe API

luxe: world/world

Wire

Section titled “Wire”
import "luxe: world/world" for Wire

no docs found

Variables

Section titled “Variables”
var id : Num = null
var uuid : String = null
var all_uuid : String = null
var type : String = null
var target : String = null

Wire.create(.)

Section titled “Wire.create(.)”
Wire.create() : Wire

no docs found

Wire.send(.)

Section titled “Wire.send(.)”
Wire.send(entity : Entity) : unknown

no docs found

Wire.send(..)

Section titled “Wire.send(..)”
Wire.send(entity : Entity, data : Any) : unknown

no docs found

Wire.prepare(.)

Section titled “Wire.prepare(.)”
Wire.prepare() : Any

no docs found

Wire.connect(…)

Section titled “Wire.connect(…)”
Wire.connect(world : World, uuid : String, fn : Fn) : unknown

no docs found

Wire.disconnect(…)

Section titled “Wire.disconnect(…)”
Wire.disconnect(world : World, uuid : String, event_id : String) : unknown

no docs found

Wire.send(…)

Section titled “Wire.send(…)”
Wire.send(world : World, uuid : String, entity : Entity) : unknown

no docs found

Wire.send(…)

Section titled “Wire.send(…)”
Wire.send(world : World, uuid : String, entity : Entity, args : Any) : unknown

no docs found

World

Section titled “World”
import "luxe: world/world" for World

no docs found

World.none

Section titled “World.none”
World.none : World

A world representing no value. Note, not for comparisons! Use World.valid(entity) for that

World.get_system(..)

Section titled “World.get_system(..)”
World.get_system(world : World, modifier_id : String) : unknown

no docs found

World.has_system(..)

Section titled “World.has_system(..)”
World.has_system(world : World, modifier_id : String) : unknown

no docs found

World.get_scene(..)

Section titled “World.get_scene(..)”
World.get_scene(world : World, scene_id : String) : unknown

no docs found

World.get_scene_for(..)

Section titled “World.get_scene_for(..)”
World.get_scene_for(world : World, scene : Entity) : unknown

no docs found

World.exists(.)

Section titled “World.exists(.)”
World.exists(id : String) : Bool

no docs found

World.valid(.)

Section titled “World.valid(.)”
World.valid(world : World) : Bool

no docs found

World.get(.)

Section titled “World.get(.)”
World.get(id : String) : World

no docs found

World.get_id(.)

Section titled “World.get_id(.)”
World.get_id(world : World) : String

no docs found

World.set_id(..)

Section titled “World.set_id(..)”
World.set_id(world : World, id : String) : unknown

no docs found

World.get_default(.)

Section titled “World.get_default(.)”
World.get_default() : World

no docs found

World.set_default(.)

Section titled “World.set_default(.)”
World.set_default(world : World) : None

no docs found

World.list(.)

Section titled “World.list(.)”
World.list(world : World) : List

no docs found

World.list_ids(.)

Section titled “World.list_ids(.)”
World.list_ids(world : World) : List

no docs found

World.clear(.)

Section titled “World.clear(.)”
World.clear(world : World) : None

no docs found

World.duplicate(.)

Section titled “World.duplicate(.)”
World.duplicate(world : World) : World

no docs found

World.tag_add(..)

Section titled “World.tag_add(..)”
World.tag_add(world : Any, tag : Any) : unknown

no docs found

World.tag_remove(..)

Section titled “World.tag_remove(..)”
World.tag_remove(world : Any, tag : Any) : unknown

no docs found

World.tag_has(..)

Section titled “World.tag_has(..)”
World.tag_has(world : Any, tag : Any) : unknown

no docs found

World.get_scene_roots(.)

Section titled “World.get_scene_roots(.)”
World.get_scene_roots(world : World) : unknown

Returns a Set of scene root entities in the given world

World.get_delta(.)

Section titled “World.get_delta(.)”
World.get_delta(world : Any) : unknown

no docs found

World.tick(…)

Section titled “World.tick(…)”
World.tick(world : World, when : FrameWhen, section : FrameSection, priority : Num) : unknown

no docs found

World.tick(.)

Section titled “World.tick(.)”
World.tick(world : World) : unknown

no docs found

World.tick(..)

Section titled “World.tick(..)”
World.tick(world : World, delta : Num) : unknown

no docs found

World.schedule(…)

Section titled “World.schedule(…)”
World.schedule(world : Any, time : Any, count : Any, fn : Any) : unknown

no docs found

World.schedule(…)

Section titled “World.schedule(…)”
World.schedule(world : Any, time : Any, fn : Any) : unknown

no docs found

World.unschedule(..)

Section titled “World.unschedule(..)”
World.unschedule(world : Any, handle : Any) : unknown

no docs found

World.render_with_set(…)

Section titled “World.render_with_set(…)”
World.render_with_set(world : Any, camera : Any, set : Any, target_path : Any) : unknown

no docs found

World.render_with_set(…)

Section titled “World.render_with_set(…)”
World.render_with_set(world : Any, camera : Any, set : Any, target_path : Any, settings : Any) : unknown

no docs found

World.render_with_set(…)

Section titled “World.render_with_set(…)”
World.render_with_set(world : Any, camera : Any, set : Any, target_path : Any, target_resource : Any, target_region : Any, settings : Any) : unknown

no docs found

World.render(…)

Section titled “World.render(…)”
World.render(world : Any, camera : Any, target_path : Any) : unknown

no docs found

World.render(…)

Section titled “World.render(…)”
World.render(world : Any, camera : Any, target_path : Any, settings : Any) : unknown

no docs found

World.render(…)

Section titled “World.render(…)”
World.render(world : Any, camera : Any, target_path : Any, target_resource : Any, target_region : Any, settings : Any) : unknown

no docs found

World.render(..)

Section titled “World.render(..)”
World.render(world : Any, desc : Any) : unknown

no docs found

World.render_fn(…)

Section titled “World.render_fn(…)”
World.render_fn(world : Any, camera : Any, target_resource : Any, target_region : Any, settings : Any, fn : Any) : unknown

no docs found

World.get_phases(.)

Section titled “World.get_phases(.)”
World.get_phases(world : World) : Set

Return the set of phases in the world, in order

World.get_phase_modifiers(…)

Section titled “World.get_phase_modifiers(…)”
World.get_phase_modifiers(world : World, phase : Num, stage : Num) : Set

Return a set of modifier ids in the phase/stage

World.get_modifier_block(..)

Section titled “World.get_modifier_block(..)”
World.get_modifier_block(world : World, modifier_id : String) : Block

Get the block for the given modifier modifier_id in world

World.get_sorted_modifiers(.)

Section titled “World.get_sorted_modifiers(.)”
World.get_sorted_modifiers(world : World) : Set

Get the list of modifiers in world (sorted by their order)

World.get_rate(.)

Section titled “World.get_rate(.)”
World.get_rate(world : Any) : unknown

no docs found

World.set_rate(..)

Section titled “World.set_rate(..)”
World.set_rate(world : Any, rate : Any) : unknown

no docs found

World.set_time(..)

Section titled “World.set_time(..)”
World.set_time(world : Any, time : Any) : unknown

no docs found

World.time(.)

Section titled “World.time(.)”
World.time(world : Any) : unknown

no docs found

World.render_get_visible(..)

Section titled “World.render_get_visible(..)”
World.render_get_visible(entity : Any, tag : Any) : unknown

no docs found

World.render_get_visible(.)

Section titled “World.render_get_visible(.)”
World.render_get_visible(entity : Any) : unknown

no docs found

World.render_set_visible(…)

Section titled “World.render_set_visible(…)”
World.render_set_visible(entity : Any, state : Any, tag : Any) : unknown

no docs found

World.render_set_visible(..)

Section titled “World.render_set_visible(..)”
World.render_set_visible(entity : Any, state : Any) : unknown

no docs found

World.render_set(.)

Section titled “World.render_set(.)”
World.render_set(world : Any) : unknown

no docs found

World.render_set_add(..)

Section titled “World.render_set_add(..)”
World.render_set_add(world : Any, geometry : Any) : unknown

no docs found

World.render_set_add(…)

Section titled “World.render_set_add(…)”
World.render_set_add(world : Any, geometry : Any, entity : Any) : unknown

no docs found

World.render_set_remove(..)

Section titled “World.render_set_remove(..)”
World.render_set_remove(world : Any, geometry : Any) : unknown

no docs found

World.render_set_remove(…)

Section titled “World.render_set_remove(…)”
World.render_set_remove(world : Any, geometry : Any, entity : Any) : unknown

no docs found

World.render_get_entity(..)

Section titled “World.render_get_entity(..)”
World.render_get_entity(world : Any, geometry : Any) : unknown

no docs found

World.render_get_entity_set(.)

Section titled “World.render_get_entity_set(.)”
World.render_get_entity_set(entity : Any) : unknown

no docs found

World.create(.)

Section titled “World.create(.)”
World.create() : World

no docs found

World.create(.)

Section titled “World.create(.)”
World.create(id : Any) : World

no docs found

World.destroy(.)

Section titled “World.destroy(.)”
World.destroy(world : World) : unknown

no docs found

World.on_register_system(..)

Section titled “World.on_register_system(..)”
World.on_register_system(world : World, fn : Fn) : Handle

Add a function to be called when a new modifier system is added to a world.

World.off_register_system(..)

Section titled “World.off_register_system(..)”
World.off_register_system(world : World, listener : Handle) : None

Unsubscribe a listener from the creation of new modifier systems.

World.tick_now(..)

Section titled “World.tick_now(..)”
World.tick_now(world : Any, delta : Any) : unknown

no docs found

World.live_worlds

Section titled “World.live_worlds”
World.live_worlds : unknown

no docs found