Lua API
On this page

UBNetRemoteExecAction

actionubnet
Inherits from

Execute a function on the specified remote clients, and get the results.

Fields:

ActionType ActionType

read only

Arguments string

read only

A serialized table of arguments to be passed to the function

CurrentRetryCount number

read only

The current number of retries this action has needed.

Error ActionError

read only

The error this action currently has, if any

ErrorDetails string

read only

More details about the error, if available

Filter ClientFilter

read only

A filter to apply, that dictates which clients this is broadcast to. If left blank, this will be broadcast to all connected clients.

FinishedAt DateTime

read only

The datetime (utc) that this action was finished at. Check IsFinished first.

Function string

read only

The function to execute

IsFinished boolean

read only

True if this action is finished

IsRunning boolean

read only

True is this action is currently running

IsRunningPreconditions boolean

read only

True is this action is currently running preconditions

IsStarted boolean

read only

True is this action has been started

Name string

read only

Friendly name of this action. Used for debugging.

Options ActionOptions

read only

Options for this action

Priority number

The priority of this action. Higher number is higher priority

Results UBNetRemoteExecResponse[]

read only

The results from the remote clients.

ScriptName string

read only

The name of the script executing this action, if any

StartedAt DateTime

read only

The datetime (utc) that this action was started at. Note that this is not updated until preconditions have all ran.

Success boolean

read only

Wether or not this action was successful. Check IsFinished before checking this.

Timeout TimeSpan

read only

Timeout length of this action. Set this in Options.

Methods:

Await() : QueueAction

Returns:QueueAction

GetPropertyKeys() : string[]

Returns a list of strings of all public property / field names. Useful for reflection on UserData in lua scripts

Returns:string[]

ToString() : string

Returns a string that represents the current object.

Returns:string