CNetChan

Provides a way to interface with a Network Channel's class.

GetAddress

Method

If the current channel is null, this function will return nil instead.

Returns address string of the remote machine.

Arguments

None.

Returns

Type	Description
string?	IP-address or Steam Server Address.

Example

local chan = game.engine:GetNetChan();
if chan and not chan:IsNull() then
    print(chan:GetAddress());
end

---

IsLoopback

Method

If the current channel is null, this function will return nil instead.

Returns whether the current channel is connected to the local machine (loopback address).

Arguments

None.

Returns

Type	Description
bool?	true if connected to the local machine.

Example

local chan = game.engine:GetNetChan();
if chan and not chan:IsNull() and chan:IsLoopback() then
    print('Connected to localhost!');
end

---

IsNull

Method

Returns whether the channel is stubbed.

Arguments

None.

Returns

Type	Description
bool	true if current channel is a dummy channel.

Example

local chan = game.engine:GetNetChan();
if not chan or chan:IsNull() then
    print('Not connected!');
end

---

GetLatency

Method

If the current channel is null, this function will return nil instead.

Returns current latency to the remote server (in seconds).

Arguments

None.

Returns

Type	Description
float?	Latency (in seconds).

Example

local chan = game.engine:GetNetChan();
if chan and not chan:IsNull() then
    print('Current latency: ' .. tostring(math.round(chan:GetLatency() * 1000.0)) .. 'ms');
end