Lua API
On this page

ubnet Module

module

Access to ubnet. This allows you to talk to clients on the same computer / ubnet instance.

Not all types are directly as module fields. Some types are only returned by calling functions, or accessing class fields. For example, EventArg type classes are generally not ever directly exposed, because you'll never need to directly create them, they will always be provided to you as needed. Types that are not globally exposed won't be listed below, use the site navigation on the left to browser all defined types.

Tip

In most cases the name that a type is exposed as will match the type name, but there are some cases where the name has been changed to prevent conflicts.

In the tables below, you can see the types that are exposed directly, and the names they are expose as.

Instances:

Type
Description

UBNetModule

v2.0.21
UBNetModule
Access to UBNet. This allows you to talk to clients on the same computer / ubnet instance.

Actions:

Type
Description

UBNetRemoteExecAction

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

Classes:

Type
Description

ClientFilter

v2.0.0
ClientFilter
A client filter, used for sending messages to a filtered set of clients. If a rule is not specified (like not setting a tag list), the rule is ignored.

Enums:

Type
Description

ClientFilterType

v2.0.0
ClientFilterType
When specifying multiple checks (like client type and tags), this selects the behavior to use.