Legacy Documentation: Version 4.5.0

Script language:

  • JS
  • C#
  • Boo
Script language

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

Network.SetReceivingEnabled

static function SetReceivingEnabled(player: NetworkPlayer, group: int, enabled: bool): void;
static void SetReceivingEnabled(NetworkPlayer player, int group, bool enabled);
static def SetReceivingEnabled(player as NetworkPlayer, group as int, enabled as bool) as void

Description

Enable or disables the reception of messages in a specific group number from a specific player.

You can use the when you do not want any network messages coming in for processing at the moment, and then enable it later when you are ready. This is useful to stop network messages until a level is loaded, for example.

	// Stop receiving messages in group 0 from all players (clients)
	for (var player : NetworkPlayer in Network.connections)
		Network.SetReceivingEnabled(player, 0, false);
using UnityEngine;
using System.Collections;

public class ExampleClass : MonoBehaviour {
    void Example() {
        foreach (NetworkPlayer player in Network.connections) {
            Network.SetReceivingEnabled(player, 0, false);
        }
    }
}
import UnityEngine
import System.Collections

public class ExampleClass(MonoBehaviour):

	def Example() as void:
		for player as NetworkPlayer in Network.connections:
			Network.SetReceivingEnabled(player, 0, false)