Avatar Descriptor

"PVR AvatarDescriptor" is the component used to upload your avatar to PoligonVR.

Upload

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.
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.

Face Tracking

You will need to create a face tracking file to assign the needed blendshapes by right clicking in the project folder "Create > PoligonVR > Face Tracking Settings"
Select the face mesh and select the face tracking settings.

NOTE: This feature is currently in development and is subject to change

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.
Select the face mesh and assign the given visemes.
Visemes can also be accessed in the animator using an int called "Viseme" ranging from 0 to 14 where 0 is silent.

Eye Look

Select the left and right eye bones.
Adjust the X Y and Z values of each eye looks direction: straight, up, down, left, and right.
If you also want to use blink or look up and look down animations, select the eyelid mesh and assign the needed blendshapes.

NOTE: This feature is currently in development and is subject to change

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

The Avatar Menu is a quick and easy way to change parameters used on your avatar. The avatar menu is located in the quick menu when pressing the default key "R"

You can add up to 255 items into your avatar menu (though we recommend against that for visibility purposes, but you certainly can). Included types are submenus, buttons, toggles, and sliders with the ability to upload your own custom icons.

World Descriptor

"PVR WorldDescriptor" is the component used to upload your world to PoligonVR.

Upload

Locomotion

PVR World Components

Various components that can be added when creating worlds in PVR

PVR Pickup

Fields

Prop Descriptor

"PVR PropDescriptor" is the component used to upload your prop to PoligonVR.

Upload

Pickup

Method Overrides

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

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

Here's 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

Here's 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);
        }
    }
}

PSharpWorld

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

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

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