UITransition

UIScripts: UITransitionComponentFeature: UI Transitions (≈7 KB)

Optional feature

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

From a script

import { UITransitionComponent } from "mmpx";

const uITransition = this.entity.TryGetComponent(UITransitionComponent);

Full API: UITransitionComponent.

Fields

Field	Type	Default	Description
Show showEffect	"none" | "fade" | "pop" | "zoom" | "slide-up" | "slide-down" | "slide-left" | "slide-right" | "drop"	"pop"
Hide hideEffect	"none" | "fade" | "pop" | "zoom" | "slide-up" | "slide-down" | "slide-left" | "slide-right" | "drop"	"fade"
Duration duration	number (0 … ∞) (s)	0.3
Delay delay	number (0 … ∞) (s)	0
Ease ease	"auto" | "linear" | "ease-out" | "ease-in-out" | "back" | "bounce" | "elastic"	"auto"	auto: back for pop, bounce for drop, ease-out for the rest
Distance distance	number (0 … ∞) (px)	200	How far slides and drops travel
On Start onStart	"visible" | "hidden" | "show"	"visible"	When the game starts: shown, hidden, or play Show
When Hidden whenHidden	"deactivate" | "stay"	"deactivate"	deactivate: the entity goes inactive; stay: active, at its hidden pose

Idle

Field	Type	Default	Description
Effect idleEffect	"none" | "pulse" | "heartbeat" | "bob" | "float" | "wiggle" | "spin"	"none"	Loops while shown — draws the eye to a button
Speed idleSpeed	number (0 … ∞) (/s)	1
Amount idleAmount	number (0 … ∞)	1