timer_device class | Unreal Editor for Fortnite Documentation

Provides a way to keep track of the time something has taken, either for scoreboard purposes, or to trigger actions. It can be configured in several ways, either acting as a countdown to an event that is triggered at the end, or as a stopwatch for an action that needs to be completed before a set time runs out.


Verse `using` statement	`using { /Fortnite.com/Devices }`

Inheritance Hierarchy

This class is derived from the following hierarchy, starting with creative_object:

Name	Description
`creative_object`	Base class for creative devices and props.
`creative_device_base`	Base class for creative_device.

Members

This class has both data members and functions.

Data

Data Member Name	Type	Description
`FailureEvent`	`listenable(payload)`	Signaled when the timer completes or ends with failure. Sends the `agent` that activated the timer, if any.
`StartUrgencyModeEvent`	`listenable(payload)`	Signaled when the timer enters Urgency Mode. Sends the `agent` that activated the timer, if any.
`SuccessEvent`	`listenable(payload)`	Signaled when the timer completes or ends with success. Sends the `agent` that activated the timer, if any.

Functions

Function Name	Description
`ClearPersistenceData`	Clears this device's saved data for `Agent`.
`ClearPersistenceDataForAll`	Clears this device's saved data for all `agent`s.
`ClearPersistenceDataForAll`	Clears this device's saved data for all `agent`s.
`Complete`	Completes the timer for `Agent`.
`Complete`	Completes the timer.
`CompleteForAll`	Completes the timer for all `agent`s.
`CompleteForAll`	Completes the timer for all `agent`s.
`Disable`	Disables this device for `Agent`. While disabled this device will not receive signals.
`Disable`	Disables this device. While disabled this device will not receive signals.
`Enable`	Enables this device for `Agent`.
`Enable`	Enables this device.
`GetActiveDuration`	Returns the remaining time (in seconds) on the timer for `Agent`.
`GetActiveDuration`	Returns the remaining time (in seconds) on the timer if it is set to be global.
`GetMaxDuration`	Returns the maximum duration of the timer (in seconds).
`GetTransform`	Returns the transform of the `creative_object` with units in cm. You must check `creative_object.IsValid` before calling this if there is a possibility the object has been disposed or destroyed by gameplay. Otherwise a runtime error will result.
`IsStatePerAgent`	Succeeds if this device is tracking timer state for each individual `agent` independently. Fails if state is being tracked globally for all `agent`'s.
`Load`	Loads this device's saved data for `Agent`.
`MoveTo`	Moves the `creative_object` to the specified `Position` and `Rotation` over the specified time, in seconds. If an animation is currently playing on the `creative_object` it will be stopped and put into the `AnimationNotSet` state.
`MoveTo`	Moves the `creative_object` to the specified `Transform` over the specified time, in seconds. If an animation is currently playing on the `creative_object` it will be stopped and put into the `AnimationNotSet` state.
`Pause`	Pauses the timer for `Agent`.
`Pause`	Pauses the timer.
`PauseForAll`	Pauses the timer for all `agent`s.
`PauseForAll`	Pauses the timer for all `agent`s.
`Reset`	Resets the timer back to its base time and stops it for `Agent`.
`Reset`	Resets the timer back to its base time and stops it.
`ResetForAll`	Resets the timer back to its base time and stops it for all `agent`s.
`ResetForAll`	Resets the timer back to its base time and stops it for all `agent`s.
`Resume`	Resumes the timer for `Agent`.
`Resume`	Resumes the timer.
`ResumeForAll`	Resumes the timer for all `agent`s.
`ResumeForAll`	Resumes the timer for all `agent`s.
`Save`	Saves this device's data for `Agent`.
`SetActiveDuration`	Sets the remaining time (in seconds) on the timer, if active, on `Agent`.
`SetActiveDuration`	Sets the remaining time (in seconds) on the timer, if active. Use this function if the timer is set to use the same time for all `agent`'s.
`SetLapTime`	Sets the lap time indicator for `Agent`.
`SetLapTimeForAll`	Sets the lap time indicator for all `agent`s.
`SetLapTimeForAll`	Sets the lap time indicator for all `agent`s.
`SetMaxDuration`	Sets the maximum duration of the timer (in seconds).
`Start`	Starts the timer for `Agent`.
`Start`	Starts the timer.
`StartForAll`	Starts the timer for all `agent`s.
`StartForAll`	Starts the timer for all `agent`s.
`TeleportTo`	Teleports the `creative_object` to the specified `Position` and `Rotation`.
`TeleportTo`	Teleports the `creative_object` to the specified location defined by `Transform`, also applies rotation and scale accordingly.