opx_infinityloading

Client
Last updated on

The loading contract on the client — whether a native load is up and whether OPX covers it.

local loading = OPX.Api.Get('loading')

State

What the module last decided. To react to changes, listen to opx:on:loading:state instead of polling.

loading.State()

Returns

Result — value:
- available: boolean — false on a client without the reader (or after a refusal)
- mode: 'state' | 'flag' | nil — loadingState, isLoading only, or not read yet
- active: boolean — a native load is up
- hide: boolean — the HUD-like views are hidden
- cover: boolean — the OPX cover is drawn
- kind: 'unknown' | 'splash' | 'initial' | 'fastTravel'
- progressKnown: boolean
- progress?: number — 0..1

Example

local now = loading.State()
if now.ok and now.value.active then return end -- do not open a menu during a load

loading

Steps the HUD aside while the game's own loading screen is up, and draws the OPX cover over loads that happen in play.

Events

The local event and page channels of the loading module.

On this page