Toggle

UIScripts: ToggleComponentFeature: UI Controls (≈35 KB)

Optional feature

Toggle is part of UI Controls. A build includes it only when a scene, prefab or script uses it — see Feature cropping.

From a script

import { ToggleComponent } from "mmpx";

const toggle = this.entity.TryGetComponent(ToggleComponent);

Full API: ToggleComponent.

Fields

Field	Type	Default	Description
Is On isOn	boolean	true
Interactable interactable	boolean	true
Checkmark checkmark	Entity	—	Shown while the toggle is on
Group group	Entity	—	An entity with a Toggle Group — its toggles are exclusive