Interactable class

Represents an in-game displayed object that is interactable.

Mixed in types
Implementers

Constructors

Interactable({required String id, InteractableRenderSettings? renderSettings, Action onTap = _defaultOnTap, Action<InteractableTooltip> onHover = _defaultOnHover})
Creates a new Interactable instance.

Properties

hashCode int
The hash code for this object.
no setterinherited
hasListeners bool
Whether any listeners are currently registered.
no setterinherited
id String
The interactable identifier.
final
isDestroyed bool
Returns whether this instance has been destroyed.
no setter
props List<Object?>
The properties list.
no setter
renderSettings InteractableRenderSettings?
Returns this instance render settings.
no setter
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

addListener(VoidCallback listener) → void
Register a closure to be called when the object changes.
inherited
changeRenderSettings(InteractableRenderSettings? renderSettings, {bool notify = true}) → void
Changes this instance render settings.
destroy({bool notify = true}) → void
Destroys this instance.
dispose() → void
Discards any resources used by the object. After this is called, the object is not in a usable state and should be discarded (calls to addListener will throw after the object is disposed).
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
notifyListeners() → void
Call all the registered listeners.
inherited
onHover(EscapeGame escapeGame) ActionResult<InteractableTooltip>
Should be called when the user hovers this interactable.
onTap(EscapeGame escapeGame) ActionResult
Should be called when the user taps on this interactable.
removeListener(VoidCallback listener) → void
Remove a previously registered closure from the list of closures that are notified when the object changes.
inherited
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited