Version: 2018.4
LanguageEnglish
  • C#
Method group is Obsolete

ServerAttribute

class in UnityEngine.Networking

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

Obsolete

Description

A Custom Attribute that can be added to member functions of NetworkBehaviour scripts, to make them only run on servers.

A [Server] method returns immediately if NetworkServer.active is not true, and generates a warning on the console. This attribute can be put on member functions that are meant to be only called on server. This would be redundant for Command functions, as being server-only is already enforced for them.

using UnityEngine;
using UnityEngine.Networking;

public class Example : NetworkBehaviour { [Server] public void Explode() { NetworkServer.Destroy(gameObject); } }

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