UgLib.Progress

Client Through ug-lib.

UgLib.Progress.Start(options) -> completed, reason
UgLib.Progress.Cancel() -> boolean
UgLib.Progress.IsActive() -> boolean

Start MUST run in a thread.

integer

required

100 to 600000 ms.

string

Up to 128 characters.

UgProgressStyle

default:"Bar"

UgPosition

Defaults to settings.progressPosition.

boolean

default:"true"

The cancel key (settings.cancelKey) cancels it.

boolean

default:"false"

Movement stays enabled, and pressing a direction cancels.

table

{ move, sprint, car, combat, mouse }. All but mouse default to true.

table

{ dict, name, flag? } (flag 49 by default) or { scenario }.

table[]

Up to 4 AttachProp options.

boolean

default:"false"

A dead player cancels unless set.

completed is true when the time ran out. Otherwise reason is Cancelled, Busy, Replaced or Closed.
One progress at a time across resources: a second start returns false, Busy.
The animation stops and props are deleted however it ends.
Cancel and IsActive act on your resource’s progress.

Example

client.lua

CreateThread(function()
    local completed = UgLib.Progress.Start({
        duration = 5000,
        label = 'Repairing the engine',
        animation = { dict = 'mini@repair', name = 'fixing_a_ped' },
        props = { { model = 'prop_tool_wrench' } },
    })

    if completed then
        UgCore.Network.TriggerServer('my-mechanic:Repaired')
    end
end)

Getting started

UI

Client utilities

Shared utilities

UgLib.Progress

Example

​Example

Example