Legacy Documentation: Version 4.6(go to latest)
Language: English
  • C#
  • JS
  • Boo

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

MasterServer.dedicatedServer

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

Sumbission failed

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

Close

Cancel

public static var dedicatedServer: bool;
public static bool dedicatedServer;
public static dedicatedServer as bool

Description

Report this machine as a dedicated server.

If running as a server the connection count defines the player count and this is reported when registering on the master server. By default the master server assumes this instance is not a dedicated server and thus the player count is incremented by one (to account for the \"client\" running on the server). If this is not desired this variable can be set to false and then only the connection count is reported in the host data as the player count.

	function StartServer() {
		Network.InitializeServer(32, 25002);
		// Not running a client locally
		MasterServer.dedicatedServer = true;
		MasterServer.RegisterHost("MyUniqueGameType", 
			"JohnDoes game", "l33t game for all");
	}
using UnityEngine;
using System.Collections;

public class ExampleClass : MonoBehaviour {
    void StartServer() {
        Network.InitializeServer(32, 25002);
        MasterServer.dedicatedServer = true;
        MasterServer.RegisterHost("MyUniqueGameType", "JohnDoes game", "l33t game for all");
    }
}
import UnityEngine
import System.Collections

public class ExampleClass(MonoBehaviour):

	def StartServer() as void:
		Network.InitializeServer(32, 25002)
		MasterServer.dedicatedServer = true
		MasterServer.RegisterHost('MyUniqueGameType', 'JohnDoes game', 'l33t game for all')