Version: 2017.3 (switch to 2017.4)
LanguageEnglish
  • C#
  • JS

Script language

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

Network.SetReceivingEnabled

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

public static method SetReceivingEnabled(player: NetworkPlayer, group: int, enabled: bool): void;
public static void SetReceivingEnabled(NetworkPlayer player, int group, bool enabled);

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); } } }

Did you find this page useful? Please give it a rating: