VReeMonoBehaviour
The VReeMonoBehaviour script extends the standard Unity MonoBehaviour with useful features when developing with the VRee SDK. These scripts are automatically attached to a player when a player connects and has a reference to the player it is attached to.
Creation
The VReeMonoBehaviour can be created by right-clicking in the Project window and selecting Create > VRee > VReeMonoBehaviour Script. Alternatively, a script can extend VReeMonoBehaviour.
Utilization
The VReeMonoBehaviour is useful for placing logic on specific bones in the player body. For example, a script that logs the position of the hands can be created as follows.
- Create the script.
c#
public class HandPositionLogger : VReeMonoBehaviour { }
- If the placement of the script on the body is important, override the
AttachTo()method. This method returns which bone(s) the script should attached to. If the script should be placed on multiple bones the OR operator can be used: return SelectedBones.LeftHand | SelectedBones.RightHand;
c#
public override SelectedBones AttachTo()
{
// Attaches the script to the left and right hand bones.
return SelectedBones.LeftHand | SelectedBones.RightHand;
}
- Create an
Update()method to log the position.
c#
private void Update()
{
string attachedTo = GetAttachedBone() == BoneType.LeftHand ? "left" : "right";
Debug.Log($"[Player {Player.Id}] The position of the {attachedTo} hand is {transform.position}");
}