Avatar Descriptor

Avatar Control

NOTE: The animator system is planned to receive a rework which will make use of Unitys playable layers in the future instead of PVR's animator merging system.

Avatars for PoligonVR runs on a hierarchy based animator system which allows for easy modifications to animators.

1. Locomotion - General movement animations like walking, running etc.
2. Additive - Used to expand the locomotion layer.
3. Emote - Used for playing emotes like waving for example.
4. Hands - Used for hand gestures.
5. FX - Used for generic toggles like clothing etc.

It's very important to correctly assign corresponding animators in the predefined hierarchy. We also allow for additional 'FX' animators to create more modular features for your avatar.

View / Voice Positioning

In order for your avatar to work correctly you must assign the view & voice position. For additional customizations, you can set the parent of the voice position. By default the voice position is always parented to the head.

Lipsync

PoligonVR uses Oculus Lipsync which allows for 15 different visemes.

Eye Look

NOTE: This feature is currently not implemented in-game but will be very soon

Avatar Parameters

Avatar parameters is a system to effortlessly sync animator parameters with other users.

Behind The Scenes

All parameters are synced every second with a "passive synchronizer". This ensures no noticeable de-sync can occur between players. When a parameters value is changed, it's added to the NetIK's package which is sent every 100ms. The NetIK can hold up to 10 parameters per package.

Parameter Types

You can currently only sync up to 256 bits of parameter memory

Avatar Menu

Coming soon

PVR_WorldDescriptor

Coming soon

PVR_Pickup

Fields

Important Information

There are some differences between Unity C# and P# that you must be aware of.

Doing GetComponent<PSharpBehaviour>() will not work due to current limitations regarding generic types.
Instead, you must do (PSharpBehaviour)gameObject.GetComponent(typeof(PSharpBehaviour))
Getting a non PSharpBehaviour such as GetComponent<PVR_Pickup>() will work just fine.

P# comes with its own Scripting Define Symbols which is called "PSHARP_RUNTIME". Other symbols such as "PVR_CCK_WORLDS" & "UNITY_EDITOR" works too!

Getting Started

Follow these steps to start creating amazing worlds.

1. Create a fresh Unity project using the correct Unity version (you can find the Unity download in the next step).
2. Download & import the latest CCK Worlds at our download page.
3. Once imported, right click in the project folder > Create > PoligonVR > P# Script.
4. Attach the script to a GameObject.
5. Start scripting!

Lets create a simple "Hello World" script.

using PVR.PSharp;
using UnityEngine;

public class HelloWorld : PSharpBehaviour
{
    void Start()
    {
        Debug.Log("Hello World!");
    }
}

Method Overrides

Method overrides allows your script to receive events, such as player join/leave.

Within the "PSharpBehaviour", we provide the following override methods:

Heres an example of receiving a players join/leave event

using PVR.PSharp;
using UnityEngine;

public class JoinLeaveExample : PSharpBehaviour
{
    public override void OnPlayerJoined(PSharpPlayer player)
    {
        Debug.Log($"{player.Username} has joined");
    }

    public override void OnPlayerLeft(PSharpPlayer player)
    {
        Debug.Log($"{player.Username} has left");
    }
}

PSharpPlayer

Instanced Properties

Instanced Methods

Static Properties

Static Methods

Heres an example of teleporting the player to the GameObject when pressing 'F'

using PVR.PSharp;
using UnityEngine;

public class TeleportExample : PSharpBehaviour
{
    void Update()
    {
        if (Input.GetKeyDown(KeyCode.F))
        {
            PSharpPlayer.Teleport(transform.position);
        }
    }
}

Prefs

PSharp Prefs is an easy way to save and preserve data on the users machine. This can range from settings to a users score for example.

NOTE: The "worldIdOverwrite" is used to write/load save data from others worlds.
Keep in mind that you as the world author can only access/write data from other worlds that you have uploaded.

Heres an example of retrieving & saving a score value

using PVR.PSharp;
using UnityEngine;

public class PrefsExample : PSharpBehaviour
{
    private void Awake()
    {
        // We need to load the prefs for this world first
        PSharpPrefs.Load();

        // We retrieve the saved score value.
        // If it has not been set, it will default to 0.
        int score = PSharpPrefs.GetInt("score", 0);
        Debug.Log($"We currently have a score of {score}");

        // We increasse the score by 1
        score++;

        // We set the new score value
        PSharpPrefs.SetInt("score", score);

        // Save the prefs for this world
        PSharpPrefs.Save();
    }
}

Web

PSharp Web is an easy & secure way to send GET requests or retreive a Texture2D from the web.

NOTE: Keep in mind that PSharpWeb uses PVR_SecureURL which is enabled by default on the client.
The client has to enable "allow untrusted URL's" in their settings or trust the URL you are trying to contact.

Heres an example on how to send a GET request

using PVR.PSharp;
using UnityEngine;

public class WebRequestExample : PSharpBehaviour
{
    private void Awake()
    {
        PSharpWeb.Get("https://example.com", (callback) =>
        {
            //Response in text form
            Debug.Log(callback.text);

            //Status code
            Debug.Log(callback.code);
        });
    }
}

Utils

PSharpUtils is a helper class to make your life a little bit easier

Networking

PSharps networking allows you to easily create script logic that is networked between players.

Most of the complex networking is automatically handled by P# itself. For example when a player leaves and they were the object owner, the master of the instance will automatically become the owner of that object. And if it was the master that left, a new master will be assigned and the object will be claimed by them.

// Automatic sync
[PSharpSynced]
public float automaticSyncedFloat1;
// Or
[PSharpSynced(SyncType.Automatic)]
public float automaticSyncedFloat2;

// Manual sync mode
[PSharpSynced(SyncType.Manual)]
public float manualSyncedFloat;

// Automatic sync with a "OnValueChanged" callback
[PSharpSynced(SyncType.Automatic, nameof(OnValueChangedCallback))]
public float syncedFloatWithCallback;

[PSharpSynced(SyncType.Automatic, nameof(OnScoreChanged))]
public int score;

// Executes when the score is changed
public void OnScoreChanged()
{
    Debug.Log($"New value: {score}");
}

Sync("myVariableName");

using PVR.PSharp;
using UnityEngine;

public class EventExample : PSharpBehaviour
{
    public override void OnInteract()
    {
        SendNetworkedEvent(NetworkEventTarget.All, nameof(DoSomething));
    }

    [PSharpEvent]
    public void DoSomething()
    {
        Debug.Log("Someone interacted with this object!");
    }
}

using PVR.PSharp;
using UnityEngine;

public class EventParametersExample : PSharpBehaviour
{
    public override void OnInteract()
    {
        SendNetworkedEvent(NetworkEventTarget.All, nameof(DoSomething), "This is parameter 1", true, 3.14f);
    }

    [PSharpEvent]
    public void DoSomething(string stringValue, bool boolValue, float floatValue)
    {
        Debug.Log($"String: {stringValue} - Bool: {boolValue} - Float: {floatValue}");
    }
}