docs.unity3d.com
    Show / Hide Table of Contents

    Interface INetworkSimulatorPreset

    Aggregates configuration values used as presets for the network simulator.

    Namespace: Unity.Multiplayer.Tools.NetworkSimulator.Runtime
    Syntax
    public interface INetworkSimulatorPreset

    Properties

    Description

    A description for the preset, usually explaining the real-world situation that the preset is attempting to re-create.

    Declaration
    string Description { get; set; }
    Property Value
    Type Description
    String

    Name

    The name of the preset.

    Declaration
    string Name { get; set; }
    Property Value
    Type Description
    String

    PacketDelayMs

    Fixed delay to apply to all packets which pass through.

    Declaration
    int PacketDelayMs { get; set; }
    Property Value
    Type Description
    Int32

    PacketJitterMs

    Variable delay to apply to all packets which pass through, adds or subtracts amount from fixed delay.

    Declaration
    int PacketJitterMs { get; set; }
    Property Value
    Type Description
    Int32

    PacketLossInterval

    Fixed interval to drop packets on. This is most suitable for tests where predictable behaviour is desired, every Xth packet will be dropped. E.g. If PacketLossInterval is 5 every 5th packet is dropped.

    Declaration
    int PacketLossInterval { get; set; }
    Property Value
    Type Description
    Int32

    PacketLossPercent

    0 - 100, denotes the percentage of packets that will be dropped. E.g. "5" means approximately every 20th packet will be dropped.

    Declaration
    int PacketLossPercent { get; set; }
    Property Value
    Type Description
    Int32
    Back to top Copyright © 2023 Unity Technologies — Terms of use
    Generated by DocFX
    on 26 October 2023