luxe API (2025.1.2)

---

luxe: world/modifier module

• Modifier
• ModifierChange

---

Modifier

import "luxe: world/modifier" for Modifier

no docs found

• create(modifier_id: String, entity: Entity)
• destroy(modifier_id: String, entity: Entity)
• has(modifier_id: String, entity: Entity, ignore_removed_flag: Bool)
• has(modifier_id: String, entity: Entity)
• get_missing_expected(modifier_meta: ModifierMeta, entity: Entity)
• has_expected(modifier_meta: ModifierMeta, entity: Entity)
• set_transient(entity: Entity, modifier_id: String, state: Bool)
• set_transient(entity: Entity, modifier_id: String, state: Bool, commit: Bool)
• get_transient(entity: Entity, modifier_id: String)
• get(entity: String, modifier_id: String)
• get_attached_to(world: World, modifier_id: String)
• get_meta(modifier_id: String)
• connect(world: World, modifier_id: String, wire: Num, fn: Fn)
• send(modifier_id: String, wire: Num, entity: Entity, data: Any)
• get_attached(entity: Entity)
• get_modifier_id(world: World, block: Block)

---

Modifier.create(modifier_id: String, entity: Entity) returns None

no docs found

Modifier.destroy(modifier_id: String, entity: Entity) returns None

no docs found

Modifier.has(modifier_id: String, entity: Entity, ignore_removed_flag: Bool) returns Bool

no docs found

Modifier.has(modifier_id: String, entity: Entity) returns Bool

no docs found

Modifier.get_missing_expected(modifier_meta: ModifierMeta, entity: Entity) returns unknown

no docs found

Modifier.has_expected(modifier_meta: ModifierMeta, entity: Entity) returns unknown

no docs found

Modifier.set_transient(entity: Entity, modifier_id: String, state: Bool) returns None

no docs found

Modifier.set_transient(entity: Entity, modifier_id: String, state: Bool, commit: Bool) returns None

no docs found

Modifier.get_transient(entity: Entity, modifier_id: String) returns Bool

no docs found

Modifier.get(entity: String, modifier_id: String) returns unknown

no docs found

Modifier.get_attached_to(world: World, modifier_id: String) returns unknown

no docs found

Modifier.get_meta(modifier_id: String) returns ModifierMeta

no docs found

Modifier.connect(world: World, modifier_id: String, wire: Num, fn: Fn) returns unknown

no docs found

Modifier.send(modifier_id: String, wire: Num, entity: Entity, data: Any) returns unknown

no docs found

Modifier.get_attached(entity: Entity) returns Set

Returns a set of attached modifier IDs for the given entity

Modifier.get_modifier_id(world: World, block: Block) returns String

Returns a modifier id (or null if not found) for the given data block

ModifierChange

import "luxe: world/modifier" for ModifierChange

no docs found

• var world : World = 0
• var block : Block = 0
• var instance : BlockInstance = 0
• var field_path : String = null
• var field_id : String = null
• new()
• update(in_world: World, in_block: Block, in_instance: BlockInstance, in_field_path: String)
• array_count(field: String)
• value
• value_for(field: String)
• value_for(field: String, array_index: Num)

---

ModifierChange.new() returns ModifierChange

no docs found

ModifierChange.update(in_world: World, in_block: Block, in_instance: BlockInstance, in_field_path: String) returns unknown

no docs found

ModifierChange.array_count(field: String) returns unknown

no docs found

ModifierChange.value returns unknown

no docs found

ModifierChange.value_for(field: String) returns unknown

no docs found

ModifierChange.value_for(field: String, array_index: Num) returns unknown

no docs found