https://github.com/miner28/networkedeventcaller

https://github.com/miner28/networkedeventcaller

Last synced: 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/miner28/networkedeventcaller
• Owner: Miner28
• License: mit
• Created: 2022-05-03T00:35:48.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-09-05T10:42:58.000Z (4 months ago)
• Last Synced: 2024-10-10T21:13:16.547Z (3 months ago)
• Language: C#
• Size: 361 KB
• Stars: 26
• Watchers: 3
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Networked Event Caller

## Description

Allows you to call events/methods over the network with ease and support for sending parameters over the network.

## Installation

Use the [VCC Listing](https://miner28.github.io/NetworkedEventCaller/) to install the package via the VPM.

[![VPM Package Version](https://img.shields.io/vpm/v/com.miner28.networked-event-caller?repository_url=https%3A%2F%2Fminer28.github.io%2FNetworkedEventCaller%2Findex.json)](https://miner28.github.io/NetworkedEventCaller)

# How to use

## Scene Setup

1. Add the `NetworkManager` component to a `GameObject`. It is recommended that this is put into root of the scene. And must be only one in the scene.

2. On `NetworkManager` set the amount of `NetworkedEventCaller`s you wish to generate and press "Setup NetworkManager". This number should be at least the max occupancy of your instance * 2 + 2. This will generate the `NetworkedEventCaller` instances and set them up.

## Your code setup

### 1. Inherit from NetworkInterface on the class you wish to call and receive events/methods on.

### 2. Use `SendNetworkedMethod` to send a method/event over the network. The parameters you send must match 1:1 in type and order to the parameters of the method/event you are calling. Otherwise this will crash the UdonBehaviour.

# Examples

## Sending a method/event

```csharp

    public override void Interact()

    {

        SendMethodNetworked(nameof(CoolMethod), SyncTarget.All, Time.time, new DataToken(transform.position), new DataToken(transform.rotation), new DataToken(Networking.LocalPlayer));

    }

```

## Sending method to another UdonBehaviour

```csharp

    public override void Interact()

    {

        otherBehaviour.SendMethodNetworked(nameof(OtherBehaviourClass.CoolMethod), SyncTarget.All, Time.time, new DataToken(transform.position), new DataToken(transform.rotation), new DataToken(Networking.LocalPlayer));

    }

```

## To receive we can declare regular C#/U# method and add `[NetworkedMethod]` to mark it as networked.

```csharp

    [NetworkedMethod]

    public void CoolMethod(float time, Vector3 position, Quaternion rotation, VRCPlayerApi player)

    {

        Debug.Log($"{time} - {position} - {rotation} - {player.displayName}");

    }

```

# Special thanks

## Merlin - UdonSharp

## Phasedragon - General help