PortalType

← Back to Asset Types

Documentation for the PortalType asset type.

Location

PortalTypes

Use in Your Files

Add this to your JSON files for IDE autocompletion and validation:

"$schema": "https://hytaledb.ginco.gg/schemas/PortalType.schema.json" Copy

Schema

Tree

InstanceId stringnull

The instance id (folder name in Assets/Server/Instances) that this instance loads.

Description unknown

The qualitative description of the portal.

Any of

PortalDescription

null

PlayerSpawn unknown

If set, overrides the Instance's SpawnProvider with the portal's spawning system.

Any of

PortalSpawn

null

CursedItems arraynull

Which item drops are cursed when spawned in this portal.

Array items: string

VoidInvasionEnabled boolean

Whether the void invasion is enabled for this portal.

Default:false

GameplayConfig stringnull

The ID of the GameplayConfig asset for worlds spawned with this portal type.

Default:"Portal"

All of

base

Raw JSON

Copy

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "PortalType.json",
  "title": "PortalType",
  "description": "PortalType asset type",
  "type": "object",
  "allOf": [
    {
      "$ref": "base.schema.json"
    }
  ],
  "properties": {
    "InstanceId": {
      "type": [
        "string",
        "null"
      ],
      "description": "The instance id (folder name in Assets/Server/Instances) that this instance loads."
    },
    "Description": {
      "description": "The qualitative description of the portal.",
      "anyOf": [
        {
          "$ref": "common.schema.json#/$defs/PortalDescription"
        },
        {
          "type": "null"
        }
      ]
    },
    "PlayerSpawn": {
      "description": "If set, overrides the Instance's SpawnProvider with the portal's spawning system.",
      "anyOf": [
        {
          "$ref": "common.schema.json#/$defs/PortalSpawn"
        },
        {
          "type": "null"
        }
      ]
    },
    "CursedItems": {
      "type": [
        "array",
        "null"
      ],
      "description": "Which item drops are cursed when spawned in this portal.",
      "items": {
        "type": "string"
      }
    },
    "VoidInvasionEnabled": {
      "type": "boolean",
      "description": "Whether the void invasion is enabled for this portal.",
      "default": false
    },
    "GameplayConfig": {
      "type": [
        "string",
        "null"
      ],
      "description": "The ID of the GameplayConfig asset for worlds spawned with this portal type.",
      "default": "Portal"
    }
  }
}