Version: Unity 6.3 LTS (6000.3)
LanguageEnglish
  • C#

Arguments

class in UnityEngine.DedicatedServer

/

Implemented in:UnityEngine.CoreModule

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Description

DedicatedServer.Arguments provide accessors for common CLI options.

Use the Arguments class to read or override dedicated server settings that Unity parses from the process command line at startup. Each property maps to a command-line flag. When you launch a server without a command-line flag, Unity uses the value from Dedicated Server Player settings. If a value isn't set on the command line or in Player settings, the corresponding property returns null.

To list supported command-line flags, launch the server with -help.

Static Properties

Property Description
ErrorPolicyThe policy Unity uses when dedicated server command-line arguments are invalid.
LogLevelThe minimum log level the server uses for console and file output.
LogPathThe directory path where the dedicated server writes log files.
PortThe port on which the server listens for connections.
QueryPortThe port on which the server listens for status query requests.
QueryTypeThe query protocol the dedicated server uses to handle status requests.
TargetFramerateThe target frame rate for the dedicated server process. This is the rate at which the server processes frames.