With the CSC plugin enabled, there are two ways to setup your scene.
Insert the CavrnusSpatialConnector actor in the level.
Manually implement calls to the Cavrnus API Functions.
CavrnusSpatialConnector class
The CavrnusSpatialConnector is a specialized actor class that collects all of the required configuration elements into one convenient location.
...
From the Details panel, configure all of your connection settings for this project:
...
CSC Configuration
| Table of Contents | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
My Server:
This is the domain you registered with Cavrnus when you configured your account. Enter your company’s URL in this field. (e.g. “CompanyName.cavrn.us” )
Authentication Method:
Specify whether Guests can join a space anonymously using a hyperlink, or if a login is required by a an authorized team member in your domain.
...
Select “Prompt to Enter Name” to trigger a prompt when the Guest first enters the space. Note that this requires a Blueprint Widget to be selected as the prompt that will display. A default widget is provided with the Cavrnus Plugin files, but you can also create your own custom design.
...
| Note |
|---|
Guest Logic is only available on the Cavrnus Dev Servers at the moment. It is coming to production shortly as described above. |
Members are authorized users who have login credential on your domain. This method is recommended for controlling access to private or sensitive information.
...
| Note |
|---|
Be mindful when committing project with login credentials to a public Git repo! |
Space Join Method:
If you have not yet created a Space for your users to join, you can find the steps to do so here: /wiki/spaces/IKB/pages/815269529
...
| Info |
|---|
Note: A Cavrnus Space will often be filled with Properties pointing to specific paths within your application. Therefore, allowing users to just open any Space could result in them bringing down a Journal that is meant to be for a different application. Example: One of your users has access to a Car Configurator Application which connects to the “Car Config” Space. They also have access to a Conference Room Application. Allowing them to join the “Car Config” Space from the Conference Room Application would give them a bunch of car-related Properties which their Application wouldn’t know what to do with. |
Avatars and Co-Presence:
Avatar properties are synchronized the same way in a Cavrnus Space as any other asset. Therefor a pawn or character must, at a minimum, have a SyncTransform component on it to synchronize the User’s movement. The Unique Container Name can be left blank because it will be automatically filled in by the Cavrnus system for each individual user when spawned. In addition to position, avatars can also send & receive other custom properties:
...
The Remote Avatar Class is assigned in the CavrnusSpatialConnector instance placed in the level. This can use the same Character blueprint as the local user, or use a custom pawn.
...
Space UI
The Cavrnus Spatial Connector gives you complete control to customize the UI, both while the Space is Loading and once it is ready. The CSC plugin files include several default widgets to get you started, either to use directly or as a template to create your own:
...
| Info |
|---|
Spawned menus, such as Loading Screens, will spawn at startup and will then be destroyed once the Space is connected. |
...
Spawnable Objects
Blueprints can be spawned into the Scene at runtime to further customize the Cavrnus experience. These can be added to the Spawnable Objects list at the bottom of the CavrnusSpatialConnector instance.
...
The Unique Id is what is stored in the Journal as the thing being spawned. The use-case is that objects placed in the scene with this unique identifier can be swapped out with new, modified blueprints. The properties stored in the Journal would then be applied to this new blueprint as though it were the original.
...
Next Steps
At this point, hitting Play-In-Editor will Authenticate the user and place them in a Space, with all of the relevant UI and spawned object references in place!
...
You can do this by adding our No-Code Collaboration Components to automatically synchronize an object's Properties.
...