Skip to content
Nick Olenz edited this page Nov 6, 2020 · 1 revision

CustomScene

Gamemode Minimum Instances Maximum Instances
Sandbox 1 1
Take and Hold 1 1

Description

CustomScene is the top-level GameObject of all custom scenes. It holds all of the data WurstMod needs about a level.

Field Breakdown

  • SceneName: The in-game name of your scene, which will be visible when selecting the scene.
  • Author: Who is responsible for creating this scene.
  • Gamemode: The gamemode of your scene. There are two options, though others may be added by gamemode developers: h3vr.sandbox and h3vr.take_and_hold.
  • Description: A short description of your scene. If you make this too long, it won't fit in the textboxes in-game, so keep it brief. A few sentences maybe.
  • MaxProjectileRange: How far projectiles can travel before they are deleted, in meters. Potential performance concerns if set too high in an open scene.

Usage

CustomScene must be a component on a GameObject called [LEVEL]. [LEVEL] must be the only GameObject at the root of your scene, all other objects should be children.

Certain Unity plugins may create invisible root objects that prevent export. If you run into this issue, you can find more info here.