Skip to main content

Interface: ScenePresentEvent

Base interface for all m2c2kit events.

Remarks​

I would have named it Event, but that would collide with the existing DOM Event

Extends​

Properties​

direction?​

optional direction: TransitionDirection

Defined in​

m2c2kit/packages/core/src/M2Event.ts:93

duration?​

optional duration: number

Defined in​

m2c2kit/packages/core/src/M2Event.ts:94

easingType?​

optional easingType: string

Defined in​

m2c2kit/packages/core/src/M2Event.ts:95

handled?​

optional handled: boolean

Has the event been taken care of by the listener and not be dispatched to other targets?

Inherited from​

M2Event.handled

Defined in​

m2c2kit/packages/core/src/M2Event.ts:26

iso8601Timestamp​

iso8601Timestamp: string

Timestamp of th event, from new Date().toISOString()

Inherited from​

M2Event.iso8601Timestamp

Defined in​

m2c2kit/packages/core/src/M2Event.ts:30

sequence?​

optional sequence: number

Sequence number of event.

Remarks​

Sequence number is guaranteed to reflect order of events, but not necessarily contiguous, e.g., could be 1, 2, 5, 10, 11, 24.

Inherited from​

M2Event.sequence

Defined in​

m2c2kit/packages/core/src/M2Event.ts:35

target​

target: Scene

The object on which the event occurred. If the event has gone through serialization, the string will be the object's UUID (if an M2Node) or class name.

Overrides​

M2Event.target

Defined in​

m2c2kit/packages/core/src/M2Event.ts:88

timestamp​

timestamp: number

Timestamp of the event, from performance.now()

Inherited from​

M2Event.timestamp

Defined in​

m2c2kit/packages/core/src/M2Event.ts:28

transitionType​

transitionType: TransitionType

Transition type of the presented scene.

Defined in​

m2c2kit/packages/core/src/M2Event.ts:92

type​

type: "ScenePresent"

Type of event.

Overrides​

M2Event.type

Defined in​

m2c2kit/packages/core/src/M2Event.ts:87

uuid​

uuid: string

The node's unique identifier (UUID).

Defined in​

m2c2kit/packages/core/src/M2Event.ts:90