PortalTypes
Asset path: Server/PortalTypes/*.json
Parent
When set this asset will inherit properties from the named asset.
When inheriting from another PortalType most properties will simply be copied from the parent asset to this asset. In the case where both child and parent provide a field the child field will simply replace the value provided by the parent, in the case of nested structures this will apply to the fields within the structure. In some cases the field may decide to act differently, for example: by merging the parent and child fields together.
Type information: String
Tags
Tags are a general way to describe an asset that can be interpreted by other systems in a way they see fit.
For example you could tag something with a Material tag with the values Solid and Stone, And another single tag Ore.
Tags will be expanded into a single list of tags automatically. Using the above example with Material and Ore the end result would be the following list of tags: Ore, Material, Solid, Stone, Material=Solid and Material=Stone.
Type information:
(Nullable) Map of the following:
| Key | Type |
|---|---|
any String | Array of String |
InstanceId
The instance id (folder name in Assets/Server/Instances) that this instance loads.
Type information: (Nullable) String
Description
The qualitative description of the portal.
Type information:
(Nullable)
PortalDescription with the following properties:
| Key | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| DisplayName | (Nullable) String | The translation key for the name of this portal. | |||||||||
| FlavorText | (Nullable) String | The translation key for the description of this portal. | |||||||||
| ThemeColor | (Nullable) A color in the form:
| What color do you associate with this portal? May be used in many places. | |||||||||
| DescriptionTags | (Nullable) Array of the type:
PillTag
| Purely cosmetic list of tags for the UI. | |||||||||
| Objectives | (Nullable) Array of String | List of translation keys for the objectives in this portal. | |||||||||
| Tips | (Nullable) Array of String | List of translation keys for the tips/wisdom offered for this portal. | |||||||||
| SplashImage | (Nullable) String | The filename of the splash image for this portal. Your best bet to find the folder is to search for an existing portal's image in assets. Screenshots taken 60 fov. |
EphemeralItems
The list of items that are considered ephemeral and can't be extracted from the portal instance.
Type information: (Nullable) Array of String
VoidInvasionEnabled
Whether the void invasion is enabled for this portal.
Type information: Boolean defaults to: false
GameplayConfig
The ID of the GameplayConfig asset for worlds spawned with this portal type.
Type information: (Nullable) String defaults to: Portal
Spawn
Configs related to spawning into the portal fragment's instance.
Type information:
(Nullable)
PortalSpawnConfig with the following properties:
| Key | Type | Description |
|---|---|---|
| SpawnReturnPortal | Boolean defaults to: true | Whether to spawn the return (usually a portal block) on the spawn location within the fragment instance. |
| SpawnProviderOverride | (Nullable) Type Selector | Set a spawn provider which will override the world's spawn provider. The spawn returned from this spawn provider will be the exact spawn location for the fragment. |
| ReturnBlock | (Nullable) String | Overrides the block to use as a return portal for this portal type. |
CloseWhenEmpty
Whether the portal and the world should be closed when empty.
Type information: Boolean defaults to: true
TimeLimitSeconds
How long the portal world stays open, in seconds. 0 or less means no time limit. A PortalKey can override this.
Type information: Integer defaults to: -1
AllowedEntryCount
How many times a player can join the portal world before the world locks them out. 0 allows unlimited entries. A PortalKey can override this.
Type information: Integer defaults to: 1
AllowPlayersToLeaveViaMap
Whether players can leave the portal world via the map.
Type information: Boolean defaults to: false
Notes:
Types referenced by this type
Type Selector
Any of these:
Key: Id | Type | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| FitToHeightMap | A spawn provider that takes a spawn point from another provider and, when its Y is the no-height sentinel, places it one block above the heightmap of the world.
FitToHeightMapSpawnProvider
| |||||||||
default case: Global | A spawn provider that provides a single static spawn point for all players.
GlobalSpawnProvider
| |||||||||
| Individual | A spawn provider that selects a spawn point from a list based on the player being spawned in. This gives random but consistent spawn points for players.
IndividualSpawnProvider
|