RakNet

RakNet.is_enabled

Boolean field on the RakNet table.

Syntax

RakNet.is_enabled(): boolean
Aliases raknet.is_enabled

Returns

NameTypeDescription
enabledbooleantrue when the RakNet API surface was registered for this session; false otherwise.

Description

Boolean field on the RakNet table. It is true only when RakNet support is enabled for the current Real session. When it is false, the RakNet table is still present, but the send, hook, signal, priority, and reliability fields are not registered.

Call it without parameters. The function reads the needed context from the current runtime state.

It returns enabled (boolean). Use the returns table to separate successful values from nil results and recoverable errors.

Example

Check whether the RakNet API surface is available before reading RakNet methods or enum tables.

if not RakNet.is_enabled then
    warn("RakNet is disabled")
    return
end

print(RakNet.is_enabled)