Vixen
02b45cc4
csharp
public sealed class SceneAsset

A level, compiled. What a content build writes and a player loads.

No guide page documents this yet — the page shows what the code says about itself.

Remarks

The runtime end of the scene pipeline, and the reason the authoring format can afford to be unhurried. A .vxscene is YAML because a person merges it; this is a chunk in the object database because a player loads it on a frame budget. Nothing reads the authored form at run time and nothing edits this one — SceneCompiler is the only thing that has ever seen both.

The version is read, unlike the authoring format's. A scene in a shipped build is loaded by a binary that may be older than the content — a downloaded update against an app nobody reinstalled — so the check is not theoretical here. The member layout is handled by the serializer's own two varints; this number is for a change the layout cannot express.

Fields and properties (4)

  • public const int Current

    The version this build writes and reads.

  • public int Version

    Which version of the compiled form this is.

  • public string Name

    What the scene is called, for diagnostics and for the editor's scene list.

  • public SceneContent Content

    Its entities.

Methods (2)

  • public SceneHandle Load(SceneManager scenes, Span<Entity> created = default(Span<Entity>))

    Loads it into a world as a scene of its own, additively.

  • public IReadOnlyList<Entity> Instantiate(World world, Span<Entity> created = default(Span<Entity>))

    Creates its entities in a world, without a scene to tag them with.

Used by (11)

  • ArenaThirdPersonShooter
  • SceneAssetTestsVixen.Engine.Tests
  • TypeRegistrationVixen.Engine
  • VixenApplicationVixen.App.Hosting
  • Vixen_Engine_Scenes_SceneAssetSerializerVixen.Engine
  • CompiledSceneViewVixen.Editor.AssetEditors
  • SceneCompilerVixen.Editor.Assets
  • SceneImporterVixen.Editor.Assets
  • SceneImporterTestsVixen.Editor.Assets.Tests
  • SceneManifestTestsVixen.Editor.Assets.Tests
  • StartupSceneTestsVixen.App.Tests