Verse API reference page for the playable interface | Fortnite Documentation | Epic Developer Community

This interface describes any abstract playable object in Verse that has Play/Pause/Resume/Stop semantics


Verse `using` statement	`using { /Verse.org/Verse }`

Members

This interface has both data members and functions.

Data

Data Member Name	Type	Description
`IsPlaying`	`?logic`	Indicates whether this playable is currently playing.
`IsPaused`	`?logic`	Indicates whether this playable is currently paused.
`SignalablePlayEvent`	`event(t)`	Internal event used to signal when this playable has begun playing
`SignalablePauseEvent`	`event(t)`	Internal event used to signal when this playable has been paused
`SignalableResumeEvent`	`event(t)`	Internal event used to signal when this playable has been resumed
`SignalableStopEvent`	`event(t)`	Internal event used to signal when this playable has been stopped
`PlayEvent`	`listenable(payload)`	Called after the playable transitions from `not IsPlaying` to `IsPlaying`.
`PauseEvent`	`listenable(payload)`	Called after the playable transitions from `not IsPaused` to `IsPaused`.
`ResumeEvent`	`listenable(payload)`	Called after the playable transitions from `IsPaused` to `not IsPaused`.
`StopEvent`	`listenable(payload)`	Called when updating when the playable has finished or `Stop` has been called. Supplies a reason for stopping, such as "finished" or "stopped explicitly".

Functions

Function Name	Description
`Play`	Begin updating from the starting state. Subsequent calls to Play() should restart.
`Pause`	Pause updating. Calling Pause() when IsPaused = true should do nothing.
`Resume`	Resume updating. Calling Resume() when IsPaused = false should do nothing.
`Stop`	Pause, and reset to the initial state. Should pass the `Explicit` reason to the `StopEvent`. Should do nothing if `not IsPlaying`.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library