Show / Hide Table of Contents

Enum OptionCapabilities

Enum indicating the capabilities of the Option.

Namespace: sttz.Trimmer
Assembly: Trimmer.dll
Syntax
[Flags]
public enum OptionCapabilities
Remarks

The enum contains specific flags that represent different capabilities and also a set of default masks that represent common combinations of flags.

The capabilities control where an Option is visible:

  • If neither HasAssociatedFeature, CanIncludeOption or ConfiguresBuild is set, the Option will not be shown in Build Profiles.
  • If neither CanPlayInEditor or ExecuteInEditMode is set, the Option will not be shown in the Editor Profile.
Note

Capabilities are only valid on the main Option, all child and variant Options will inherit the capabilities from the main Option.

Fields

Name Description
CanIncludeOption

Flag indicating the Option can be included in builds. If not set, the Option will always be removed from builds.

CanPlayInEditor

Flag indicating the Option can be used when playing in the editor. If not set, the Option will not be loaded when playing the project in the editor.

ConfiguresBuild

Flag indicating the Option integrates into the build process, configuring the build options or pre-/post-processes scenes and the build.

ExecuteInEditMode

Flag indicating the Option should be loaded in edit mode. If set, the Option will be loaded when not playing in the editor.

HasAssociatedFeature

Flag indicating the option has an associated feature that can be included/excluded from the build using Build Profiles.

None
PresetDefault

Default preset mask. The Option can be included in the build, its build configuration callbacks are called and it is loaded when playing in the editor.

PresetOptionOnly

Preset mask. A simple Option that can be included in the build and gets loaded in the editor but doesn't process the build and has no associated feature.

PresetWithFeature

Preset mask. Like PresetDefault but also has an associated feature that can be included/excluded from the build.

  • Improve this Doc
  • View Source
Back to top © 2017 Adrian Stutz