Interface: CreateToggleDefaultedOptions

Defined in: ui/utilities/create-toggle.ts:46

Fields of CreateToggleOptions with a sensible default; callers may omit these.

Properties

anchor

anchor: UiAnchorConfig

Defined in: ui/utilities/create-toggle.ts:52

The anchor to place the toggle with - see UiAnchor for common presets (e.g. UiAnchor.center({ x: 32, y: 32 })). Defaults to UiAnchor.center({ x: 32, y: 32 }).

---

anchoredPosition?

optional anchoredPosition?: Vector2

Defined in: ui/utilities/create-toggle.ts:55

Offset of the toggle's pivot from its anchor reference point, in reference pixels.

---

group?

optional group?: number

Defined in: ui/utilities/create-toggle.ts:68

The entity id of a UiToggleGroupEcsComponent this toggle belongs to - see addUiToggleGroupComponent. Omitted, this toggle is an independent checkbox.

---

interactable?

optional interactable?: Partial<UiInteractableDefaultedOptions>

Defined in: ui/utilities/create-toggle.ts:74

Overrides for the toggle's UiInteractableEcsComponent (e.g. to start it non-interactable).

---

isOn

isOn: boolean

Defined in: ui/utilities/create-toggle.ts:61

Whether the toggle starts on. Defaults to false.

---

slices?

optional slices?: NineSliceOptions

Defined in: ui/utilities/create-toggle.ts:58

Overrides sprite.slices for the toggle's box.

---

transition?

optional transition?: Partial<UiColorTransitionDefaultedOptions>

Defined in: ui/utilities/create-toggle.ts:80

Overrides for the toggle's UiColorTransitionEcsComponent (its hover/pressed/disabled tints, transition duration, and easing).