Open Asterune
ComponentHandle

ComponentHandle

Reads and writes one component attached to an Instance.

Behavior

ComponentHandle reads and writes one component attached to an Instance.

Summary

Members3
Properties1
Methods2
  • Get(): table

    Returns a table containing the component's current field values.

  • Set(values: { [string]: any }): ()

    Validates and writes the supplied fields.

Properties

Instance

ComponentHandle.Instance: Instance

The Instance carrying this component. This property is read-only.

Methods

Get

ComponentHandle:Get(): table

Returns a table containing the component's current field values. Changing the returned table does not write the component.

Set

ComponentHandle:Set(values: { [string]: any }): ()

Validates and writes the supplied fields. Omitted fields retain their values. Unknown fields and invalid values cause an error before the writes are applied. During parallel execution, field writes are recorded for application at the serial barrier.

Operators

__type

Used by

63 classes declare a member of this type. See Classes for the class reference.