Vixen
caa30e12
csharp
public sealed class WaterModule

Doc 35's toolset, registering itself through the door a third party comes through.

Read the guide page for this →

Remarks

One mode, two panels, and the thing that turns a drawn curve into a scene entity. TerrainModule's shape, one document on — see doc 36 § F2 for why a toolset that was a partial of the editor's application could only exist in an editor compiled with it.

⚠ The gesture ends at a curve and the module is what makes it a body. Drawn hands over a Spline; writing it beside the scene as a .vxspline and creating the entity that names it needs a project and a world, which is exactly what a mode must not need to be testable.

⚠ What it takes from the host, it asks for. The project and the scene, through PluginServices.Require. A host without one refuses the module by name rather than throwing a null reference from inside Activate.

Fields and properties (8)

  • public const string ModuleId

    What the host activates it under, and what a plugin depending on it names.

  • public const string ModuleName

    What a plugin-management panel calls it.

  • public const string CreateWavesCommand

    What the Create ▸ entry for a sea state is registered as.

  • public WaterMode Mode

    The mode, so a host or a test can drive it.

  • public int BodiesCreated

    How many bodies the module has created this session.

  • public const string ZonePanel

    What the zone panel is registered as.

  • public const string BodyPanel

    And the mode's own, which is the body inspector and the draw settings.

  • public const string SplineExtension

    What a drawn curve is written as, and therefore what one is looked for as.

Methods (1)

  • public void Activate(PluginContext context)

    Adds everything the plugin contributes.

Used by (2)

  • EditorModulesVixen.Editor.Host
  • WaterSceneSourceVixen.Editor.Water