Search Results for

    Show / Hide Table of Contents

    Class NetworkConfig

    Inheritance
    Object
    NetworkConfig
    Namespace: FNNLib.Config
    Assembly: FNNLib.dll
    Syntax
    [Serializable]
    public class NetworkConfig

    Fields

    | Improve this Doc View Source

    channels

    Declaration
    public List<NetworkChannel> channels
    Field Value
    Type Description
    List<NetworkChannel>
    | Improve this Doc View Source

    clientMaxReceivesPerUpdate

    Maximum number of updates to process per tick as the client.

    Declaration
    public int clientMaxReceivesPerUpdate
    Field Value
    Type Description
    Int32
    | Improve this Doc View Source

    connectionRequestTimeout

    The number of seconds to wait for a client to request connection before dropping them.

    Declaration
    public int connectionRequestTimeout
    Field Value
    Type Description
    Int32
    | Improve this Doc View Source

    disconnectRequestTimeout

    The number of seconds to wait for a client to acknowledge a disconnection request before dropping them.

    Declaration
    public int disconnectRequestTimeout
    Field Value
    Type Description
    Int32
    | Improve this Doc View Source

    enableHybridScenes

    Whether or not hybrid scenes are enabled. This will enable the use of scenes that are additively loaded (and packed) on the server and single loaded on clients.

    Declaration
    public bool enableHybridScenes
    Field Value
    Type Description
    Boolean
    | Improve this Doc View Source

    initialScene

    The initial starting scene. If left blank, it will use the scene when StartServer/StartHost is called.

    Declaration
    public string initialScene
    Field Value
    Type Description
    String
    | Improve this Doc View Source

    maxBufferedPacketAge

    The maximum age of a buffered packet before it is ignored.

    Declaration
    public float maxBufferedPacketAge
    Field Value
    Type Description
    Single
    | Improve this Doc View Source

    networkableScenes

    The list of scenes that the server is permitted to send the client to. Used to prevent rogue servers sending clients to invalid scenes.

    Declaration
    public List<NetworkableScene> networkableScenes
    Field Value
    Type Description
    List<NetworkableScene>
    | Improve this Doc View Source

    networkedPrefabs

    List of all networked prefabs.

    Declaration
    public List<NetworkPrefab> networkedPrefabs
    Field Value
    Type Description
    List<NetworkPrefab>
    | Improve this Doc View Source

    packetBufferPurgesPerSecond

    The number of buffer purges to perform per second.

    Declaration
    public int packetBufferPurgesPerSecond
    Field Value
    Type Description
    Int32
    | Improve this Doc View Source

    protocolVersion

    The protocol version. This prevents cross-version communication. You can however keep the protocol version the same if a minor bugfix or change is done that doesn't affect gameplay.

    Declaration
    public ushort protocolVersion
    Field Value
    Type Description
    UInt16
    | Improve this Doc View Source

    rpcHashSize

    The hash size for RPC method names/signatures. Only change if you are having collision problems.

    Declaration
    public HashSize rpcHashSize
    Field Value
    Type Description
    HashSize
    | Improve this Doc View Source

    serverMaxReceivesPerUpdate

    Maximum number of updates to process per tick as the server.

    Declaration
    public int serverMaxReceivesPerUpdate
    Field Value
    Type Description
    Int32
    | Improve this Doc View Source

    serverTickRate

    (Dedicated) server update frequency.

    Declaration
    public int serverTickRate
    Field Value
    Type Description
    Int32
    | Improve this Doc View Source

    transport

    The transport to use for networking.

    Declaration
    public Transport transport
    Field Value
    Type Description
    Transport

    Methods

    | Improve this Doc View Source

    EnsureDefaultChannels()

    Declaration
    public void EnsureDefaultChannels()
    | Improve this Doc View Source

    GetHash(Boolean)

    Get the config hash. This is used to compare the validity of a connection.

    Declaration
    public ulong GetHash(bool cache = true)
    Parameters
    Type Name Description
    Boolean cache
    Returns
    Type Description
    UInt64
    • Improve this Doc
    • View Source
    In This Article
    Back to top (C) 2020 Reece Mackie. Released under the MIT License.