ObjectNet

https://onlineobject.net/objectnet/docs/manual/
Admin
ObjectNet is a powerful, flexible, and easy-to-use multiplayer solution available on the Unity Asset...
Tokens:6,864
Snippets:95
Trust Score:5.6
Update:11 months ago
Show doc for...
Tokens:
Raw
### Implement Custom Network Behavior in ObjectNet

Source: https://onlineobject.net/objectnet/docs/manual/CustomBehaviour1

Complete example showing how to implement custom network behavior in ObjectNet, including data structure definition, behavior class implementation with sync methods, and registration. The example synchronizes GameObject position and color data between network clients.

```csharp
// Data structure for synchronization
public struct DataToSync {   
public Vector3 positionValue;  
public Color color;  
}

// Custom behavior implementation
public class BehaviourExample : NetworkEntity<DataToSync, IDataStream> {
  
private DataToSync currentValue;  
  
public BehaviourExample() : base() {  

}
  
public BehaviourExample(INetworkElement networkObject) : base(networkObject) {  
}
  
public override void ComputeActive() {  
this.currentValue.positionValue = this.GetNetworkObject().GetGameObject().transform.position;  
this.currentValue.color = this.GetNetworkObject().GetGameObject().GetComponent<Renderer>().materials[0].color;  
}
  
public override void ComputePassive() {  
this.GetNetworkObject().GetGameObject().transform.position = this.currentValue.positionValue;  
this.GetNetworkObject().GetGameObject().GetComponent<Renderer>().materials[0].color = this.currentValue.color;  
}
  
public override DataToSync GetPassiveArguments() {  
return this.currentValue;  
}
  
public override void SynchonizePassive(DataToSync data) {  
this.currentValue.color = data.color;  
this.currentValue.positionValue = data.positionValue;  
}
  
public override void SynchonizeActive(IDataStream writer) {  
writer.Write(this.currentValue.positionValue);  
writer.Write(this.currentValue.color);   
}
  
public override void Extract(IDataStream reader) {  
this.currentValue.positionValue = reader.Read<Vector3>();  
this.currentValue.color = reader.Read<Color>();  
}  
}

// Registration in game object
public void Awake() {  
this.GetNetworkElement().RegisterBehavior(new BehaviourExample());  
}
```

--------------------------------

### Setup NetworkObject and Use GetInput in C#

Source: https://onlineobject.net/objectnet/docs/manual/RemoteControls

This C# code shows how to obtain a NetworkObject instance and retrieve input states using ObjectNet's GetInput method instead of direct Unity inputs. It requires a NetworkObject component attached; inputs are registered aliases like "MoveLeft"; outputs are typed input values. Useful in NetworkBehaviour scripts.

```csharp
this.network = this.GetComponent<NetworkObject>();
  
  
thiss.network.GetInput<bool>("MoveLeft");
this.network.GetInput<bool>("MoveRight");
this.network.GetInput<bool>("Jump");
```

--------------------------------

### NetworkBehaviour Event: ActiveStart (C#)

Source: https://onlineobject.net/objectnet/docs/manual/NetworkBehaviour

Describes the ActiveStart event, which is executed when the object is in Active mode at the Start stage.

```csharp
public void ActiveStart() {\n}
```

--------------------------------

### Execute Network Method with Parameters in C#

Source: https://onlineobject.net/objectnet/docs/manual/NetworkMethods

Provides an example of executing a C# method with parameters over the network using ObjectNet. The `NetworkExecute<T1, T2>` generic method allows specifying parameter types and passing values. Supports up to 10 arguments.

```csharp
void MethodName(int life, string name) {
  // Do something
}

// And in any part of you code at same class you can have
this.NetworkExecute<Int32, String>(this.MethodName, 10, "MyName");
```

--------------------------------

### NetworkBehaviour Event: PassiveStart (C#)

Source: https://onlineobject.net/objectnet/docs/manual/NetworkBehaviour

Describes the PassiveStart event, which is executed when the object is in Passive mode at the Start stage.

```csharp
public void PassiveStart() {\n}
```

--------------------------------

### NetworkInstantiate for Cross-Network Spawning (C#)

Source: https://onlineobject.net/objectnet/docs/manual/SpawningObjects

Invokes NetworkGameObject.NetworkInstantiate to broadcast spawn events to all network peers, ensuring objects appear consistently. Purpose: Enables spawning from any client, including passive ones. Dependencies: Active network connection and prefab registration. Inputs: Prefab, position, rotation. Outputs: Optional return of spawned GameObject on server/host. Limitations: Server-side calls recommended for authority; may require additional setup for complex hierarchies.

```csharp
// Send event to spawn this prefab on server
NetworkGameObject.NetworkInstantiate(this.projectile, this.spawnPosition.position, rocketRotation);
```

```csharp
// Send event to spawn this prefab on server
GameObject spawned = NetworkGameObject.NetworkInstantiate(this.projectile, this.spawnPosition.position, rocketRotation);
```

--------------------------------

### Implement IInputProvider Interface in C#

Source: https://onlineobject.net/objectnet/docs/manual/RemoteControls

This C# code snippet demonstrates implementing the IInputProvider interface to capture various input states like jumps and movements. It uses Unity's Input class for detection and must return types like bool, float, or Vector2. Dependencies include UnityEngine; inputs are Unity key codes, outputs are input states.

```csharp
public bool IsJumpPressed() {
return Input.GetKey(KeyCode.Space);
}
  
public bool IsFrontPressed() {
return Input.GetKey(KeyCode.UpArrow);
}
  
public bool IsBackPressed() {
return Input.GetKey(KeyCode.DownArrow);
}
  
public bool IsLeftPressed() {
return Input.GetKey(KeyCode.LeftArrow);
}
  
public bool IsRightPressed() {
return Input.GetKey(KeyCode.RightArrow);
}
  
public Vector2 GetMovement() {
return new Vector2(Input.GetAxis("Horizontal"), Input.GetAxis("Vertical"));
}
```

--------------------------------

### Standard Unity Instantiate for Networked Spawning (C#)

Source: https://onlineobject.net/objectnet/docs/manual/SpawningObjects

Executes Unity's Instantiate on the server or host to spawn objects locally, triggering automatic network replication if the prefab is registered in NetworkPrefabs. Purpose: Simplifies spawning with built-in synchronization. Dependencies: NetworkPrefabs registration and server/host execution. Inputs: Prefab, position, rotation. Outputs: Local GameObject. Limitations: Fails on passive clients without network replication.

```csharp
GameObject.Instantiate(this.prefabToSpawn, this.positionToSpwan, Quaternion.identity);
```

--------------------------------

### Register Network Inputs by Code in C#

Source: https://onlineobject.net/objectnet/docs/manual/RemoteControls

This C# snippet illustrates registering and mapping inputs programmatically in Awake for procedural or rebinding purposes. It uses RegisterInput with generic types and lambda evaluators. Dependencies include ObjectNet networking; inputs are key codes or axes; limitations include server-side processing only.

```csharp
public void Awake() {
// To map controls
this.RegisterInput<bool>("jump").OnEvaluate(() => { return Input.GetKeyDown("space"); });
this.RegisterInput<float>("lados").OnEvaluate(() => { return Input.GetAxis("horizontal"); });
}
```

--------------------------------

### Define and Execute a Network Method in C#

Source: https://onlineobject.net/objectnet/docs/manual/NetworkMethods

Demonstrates how to define a C# method and execute it over the network using ObjectNet's `NetworkExecute` function. ObjectNet automatically determines the optimal execution location (server, client, or both).

```csharp
void MethodName() {
  // ... Do something
}

// And in any part of you code at same class you can have
this.NetworkExecute(this.MethodName);
```

--------------------------------

### Extend MonoBehaviour with NetworkBehaviour (C#)

Source: https://onlineobject.net/objectnet/docs/manual/NetworkBehaviour

Demonstrates how to inherit from NetworkBehaviour instead of MonoBehaviour. This allows the use of additional events and methods provided by ObjectNet.

```csharp
public class MyGameScript : NetworkBehaviour {
  \n  // Your class code\n  \n}
```

--------------------------------

### Implement Custom DataStream for Serialization/Deserialization (C#)

Source: https://onlineobject.net/objectnet/docs/manual/CustomDataStream

Implements a custom DataStream 'DataStreamExample' for the 'DataToSync' class. It overrides the Write and Read methods to handle the serialization and deserialization of Vector3 and Color objects.

```csharp
public class DataStreamExample : DataHandler<DataToSync> {

public override int Write(DataToSync data, ref byte[] buffer, ref int offset) {
int result = base.Write(data.positionValue, ref buffer, ref offset, typeof(Vector3));
result += base.Write(data.color, ref buffer, ref offset, typeof(Color));
return result;
}

public override DataToSync Read(byte[] buffer, ref int offset) {
return new DataToSync(this.Read<Vector3>(buffer, ref offset),
this.Read<Color>(buffer, ref offset));
}
}
```

--------------------------------

### Execute Network Method on Server Only in C#

Source: https://onlineobject.net/objectnet/docs/manual/NetworkMethods

Shows how to specifically execute a C# method on the server only using ObjectNet's `NetworkExecuteOnServer`. This is useful for server-authoritative game logic.

```csharp
// Execute method on server only
this.NetworkExecuteOnServer(this.MethodName);
```

--------------------------------

### NetworkBehaviour Event: OnNetworkStarted (C#)

Source: https://onlineobject.net/objectnet/docs/manual/NetworkBehaviour

Shows the implementation of the OnNetworkStarted event, which is called when the network is available to the object.  Use this method for initialization tasks after network initialization.

```csharp
public override void OnNetworkStarted() {\n  // Here you can do any that you need after ensure that Network is initialized\n}
```

--------------------------------

### Execute Network Method on Clients Only in C#

Source: https://onlineobject.net/objectnet/docs/manual/NetworkMethods

Illustrates how to execute a C# method on all clients (including the local client if it's running as a client) using ObjectNet's `NetworkExecuteOnClient`. This is useful for client-side effects or UI updates.

```csharp
// Execute method on all clients ( including me if I'm a client )
this.NetworkExecuteOnClient(this.MethodName);
```

--------------------------------

### Send Network Event with Data (C#)

Source: https://onlineobject.net/objectnet/docs/manual/SendingEvents

Illustrates sending a network event with associated data using ObjectNet. It utilizes a `DataStream` writer to serialize various data types (e.g., Vector3, float, int) before sending the event via `NetworkManager.Instance().Send()` with reliable delivery mode.

```csharp
using (DataStream writer = new DataStream()) {
  writer.Write(this.targetPosition); // Vector3
  writer.Write(this.remaingLife); // float
  writer.Write(this.money); // int
  // Send event
  NetworkManager.Instance().Send(CUSTOM_EVENT, writer, DeliveryMode.Reliable);
}
```

--------------------------------

### Register Network Event Listener (C# | ObjectNet)

Source: https://onlineobject.net/objectnet/docs/manual/ListeningEvents

Defines a unique event ID and registers a listener callback that deserializes a Vector3, a float, and an int from an IDataStream. Relies on ObjectNet's NetworkManager.Events API and IDataStream for reading values.

```csharp
const int CUSTOM_EVENT = 10000;

public void Start()
{
    NetworkManager.Events.RegisterEvent(CUSTOM_EVENT, this.OnCustomEventReceived);
}

private void OnCustomEventReceived(IDataStream reader)
{
    Vector3 receivedTargetPosition = reader.Read<Vector3>();
    float remaningLife = reader.Read<float>();
    int money = reader.Read<int>();
    // Update player with received information
    this.UpdatePlayer(receivedPosition, remaningLife, money);
}
```

--------------------------------

### Register and Handle Network Event in C#

Source: https://onlineobject.net/objectnet/docs/manual/ListeningEvents1

Registers a custom event to a handler method and processes the received data. The handler method reads data from the event and performs actions based on the received information.

```csharp
public void Start() {
	this.RegisterEvent(LOCAL_CUSTOM_EVENT, this.OnCustomEventReceivedOnObject);
}

private void OnCustomEventReceivedOnObject(IDataStream reader) {
	Vector3 receivedPosition = reader.Read<Vector3>();
	float receivedStatus = reader.Read<float>();
	int receivedErrorCode = reader.Read<ushort>();
	// Update player with received information
	this.RaiseObjectError(receivedPosition, receivedStatus, receivedErrorCode);
}
```

--------------------------------

### Register Custom DataStream with ObjectNet Factory (C#)

Source: https://onlineobject.net/objectnet/docs/manual/CustomDataStream

Registers the custom 'DataStreamExample' with the ObjectNet factory for the 'DataToSync' data type. This allows the ObjectNet engine to use the custom DataStream for sending and receiving 'DataToSync' objects.

```csharp
DataStream.RegisterGlobalStream<DataToSync, DataStreamExample>();
```

--------------------------------

### NetworkBehaviour Event: ActiveLateUpdate (C#)

Source: https://onlineobject.net/objectnet/docs/manual/NetworkBehaviour

Describes the ActiveLateUpdate event, which is executed every frame after Update when the object is in Active mode.

```csharp
public void ActiveLateUpdate() {\n}
```

--------------------------------

### NetworkBehaviour Event: ActiveFixedUpdate (C#)

Source: https://onlineobject.net/objectnet/docs/manual/NetworkBehaviour

Describes the ActiveFixedUpdate event, which is executed every physics frame when the object is in Active mode.

```csharp
public void ActiveFixedUpdate() {\n}
```

--------------------------------

### Send Network Event with Data (C#)

Source: https://onlineobject.net/objectnet/docs/manual/SendingEvents1

Demonstrates sending a network event with custom data from a NetworkObject. It uses a DataStream to write data like position, status, and error code before sending the event using the 'Send' method. The 'this' keyword ensures object-specific information is included.

```csharp
using (DataStream writer = new DataStream()) {
writer.Write(this.transform.position); // Vector3
writer.Write(this.objectStatus); // int
writer.Write(this.errorCode); // uint
// Send event
// Is important to send using "this" because system will include object information's during event send
this.Send(LOCAL_CUSTOM_EVENT, writer, DeliveryMode.Reliable);
}
```

--------------------------------

### Synchronize Local and Network Variables in C#

Source: https://onlineobject.net/objectnet/docs/manual/CodingNetworkVariables

Illustrates how to automatically synchronize a local C# variable with a Network Variable. Changes made to either the local or the network variable are reflected in the other, ensuring data consistency.

```csharp
string localVariable = "Start text";

this.variable.OnSynchonize(() => { return this.localVariable; },
(string value) => { this.localVariable = value; });

this.localVariable = "New value from local"; // In this case variable Network will also receive the new value "New value from local"
this.variable = "New value from Network variable"; // In this case local variable will also receive the new value "New value from Network Variable"
```

--------------------------------

### NetworkBehaviour Event: PassiveFixedUpdate (C#)

Source: https://onlineobject.net/objectnet/docs/manual/NetworkBehaviour

Describes the PassiveFixedUpdate event, which is executed every physics frame when the object is in Passive mode.

```csharp
public void PassiveFixedUpdate() {\n}
```

--------------------------------

### NetworkBehaviour Event: PassiveLateUpdate (C#)

Source: https://onlineobject.net/objectnet/docs/manual/NetworkBehaviour

Describes the PassiveLateUpdate event, which is executed every frame after Update when the object is in Passive mode.

```csharp
public void PassiveLateUpdate() {\n}
```

--------------------------------

### Declare and Use Network Variables in C#

Source: https://onlineobject.net/objectnet/docs/manual/CodingNetworkVariables

Demonstrates how to declare a Network Variable of type string and assign it an initial value. After definition, it can be used like any other script variable for reading and writing values.

```csharp
private NetworkVariable<string> variable = "";

this.variable = "This is a new string value";
string variableValue = this.variable;
```

--------------------------------

### NetworkBehaviour Event: ActiveUpdate (C#)

Source: https://onlineobject.net/objectnet/docs/manual/NetworkBehaviour

Describes the ActiveUpdate event, which is executed every frame when the object is in Active mode.

```csharp
public void ActiveUpdate() {\n}
```

--------------------------------

### NetworkBehaviour Event: ActiveAwake (C#)

Source: https://onlineobject.net/objectnet/docs/manual/NetworkBehaviour

Describes the ActiveAwake event, which is executed when the object is in Active mode at the Awake stage.

```csharp
public void ActiveAwake() {\n}
```

--------------------------------

### Define Local Custom Event Identifier (C#)

Source: https://onlineobject.net/objectnet/docs/manual/SendingEvents1

Defines a constant integer for a local custom event. It is recommended to group events to prevent code collisions. This identifier serves as a unique key for the event being sent.

```csharp
const int LOCAL_CUSTOM_EVENT = 20000;
```

--------------------------------

### NetworkBehaviour Event: PassiveUpdate (C#)

Source: https://onlineobject.net/objectnet/docs/manual/NetworkBehaviour

Describes the PassiveUpdate event, which is executed every frame when the object is in Passive mode.

```csharp
public void PassiveUpdate() {\n}
```

--------------------------------

### NetworkBehaviour Event: PassiveAwake (C#)

Source: https://onlineobject.net/objectnet/docs/manual/NetworkBehaviour

Describes the PassiveAwake event, which is executed when the object is in Passive mode at the Awake stage.

```csharp
public void PassiveAwake() {\n}
```

--------------------------------

### Detect Network Variable Value Changes in C#

Source: https://onlineobject.net/objectnet/docs/manual/CodingNetworkVariables

Shows how to subscribe to value change events for a Network Variable. This allows executing specific logic only when the variable's value is updated on a passive instance.

```csharp
this.variable.OnValueChange((string oldValue, string newValue) => {
  Debug.Log(string.Format("Value was updated from [ {0} ] to [ {1} ] ", oldValue, newValue));
});
```

--------------------------------

### Define Custom Data Structure for DataStream (C#)

Source: https://onlineobject.net/objectnet/docs/manual/CustomDataStream

Defines a custom data structure 'DataToSync' containing a Vector3 position and a Color. This structure will be serialized and deserialized by the custom DataStream.

```csharp
public class DataToSync {
public Vector3 positionValue;
public Color color;

public DataToSync(Vector3 position, Color color) {
this.positionValue = position;
this.color = color;
}
}
```

--------------------------------

### Define Custom Event Identifier (C#)

Source: https://onlineobject.net/objectnet/docs/manual/SendingEvents

Defines a custom integer identifier for a network event. It is recommended to group event codes to prevent collisions. This serves as the unique ID for events sent over the network.

```csharp
const int CUSTOM_EVENT = 10000;
```
Tokens:
Raw