Verse API reference page for the progress_objective class | Fortnite Documentation

Tracks numeric progress toward a required threshold; complete when Progress >= RequiredProgress. A commanded Complete() succeeds at any progress and does not advance it.


Verse `using` statement	`using { /UnrealEngine.com/Progression }`

Inheritance Hierarchy

This class is derived from objective.

Name Description

Name	Description
`objective`	A unit of trackable work with an `Inactive`, `Active` and `Complete` lifecycle. Use it for anything from an objective that simply tracks a number to a complex nested objective made of other objectives. Eliminate 10 enemies: one counter that completes at its target. Hold the point for 60 seconds: time accumulated while a condition holds. Clear the dungeon: nested objectives that complete in sequence or together.

objective

A unit of trackable work with an Inactive, Active and Complete lifecycle. Use it for anything from an objective that simply tracks a number to a complex nested objective made of other objectives.

Eliminate 10 enemies: one counter that completes at its target.
Hold the point for 60 seconds: time accumulated while a condition holds.
Clear the dungeon: nested objectives that complete in sequence or together.

Members

This class has both data members and functions.

Data

Data Member Name	Type	Description
`ActivateEvent`	`unknown`	Signaled when this objective is activated.
`CompleteEvent`	`unknown`	Signaled when this objective completes.
`DeactivateEvent`	`unknown`	Signaled when this objective is deactivated.
`Progress`	`?float`	Current progress toward `RequiredProgress`; an authored value is clamped to `[0, RequiredProgress]` at activation. Write it with `SetProgress`.
`ProgressEvent`	`unknown`	Signaled when this objective's progress changes.
`RequiredProgress`	`?float`	Target progress for completion; an authored value is not clamped, and `0` reads complete from activation. Write it with `SetRequiredProgress`.
`State`	`?objective_state`	This objective's lifecycle state.

Functions

Function Name	Description
`Activate`	Starts this objective; returns an error when it is already running or its type refuses to start it, otherwise the errors `CanActivate` returned.
`CanActivate`	Succeeds if this objective may be activated; the default succeeds. Veto by returning errors.
`CanComplete`	Succeeds if this objective may be completed for `Reason`; the default succeeds. Veto by returning errors.
`CanDeactivate`	Succeeds if this objective may be deactivated; the default succeeds. Veto by returning errors.
`Complete`	Reports this objective as complete for `Reason`; returns an error when its type refuses the report, otherwise the errors `CanComplete` returned.
`Deactivate`	Stops this objective; returns an error when it is not running, otherwise the errors `CanDeactivate` returned.
`GetProgress`	Returns progress in `"X / Y"` format.
`GetProgress`	Returns a `message` describing progress, for example `"3 / 10"`.
`OnActivate`	Called when this objective starts.
`OnComplete`	Called after this objective is complete, possibly more than once.
`OnDeactivate`	Called when this objective stops.
`SetProgress`	Sets current progress, clamped to `[0, RequiredProgress]`.
`SetRequiredProgress`	Sets the target progress; a negative or NaN value becomes `0`. Lowering it below `Progress` re-clamps `Progress` to the new target and fires `ProgressEvent`.
`SignalProgressEvent`	Signals `ProgressEvent`.