Enumeration SceneObjectFlag

The SceneObjectFlag enum represents modifiers that can be applied to a SceneObject.

Constructors

constructor

Values

HideInOutliner Internal IsInternalTemplateRoot None NoSaveOrSync Protected Readonly RuntimePersistent ScenePersistent TemplateInstanceRoot

Methods

addFlag combineFlags getEnumName getEnumNames getEnumValue getEnumValues getNameForValue getNames getValueAtIndex getValues hasFlag hasFlagChanged iterateNames iterateValues removeFlag splitFlags

Constructors

Protectedconstructor

  • new SceneObjectFlag(do_not_, construct_, this_, type_): SceneObjectFlag

  • Parameters

    • do_not_: undefined
    • construct_: undefined
    • this_: undefined
    • type_: undefined

    Returns SceneObjectFlag

Values

Static ReadonlyHideInOutliner

HideInOutliner = 32

Object will not be displayed in the outliner, except when in Debug mode and Outliner debug mode is enabled.

Static ReadonlyInternal

Internal = 8

Provides a hint to external systems that his object is used by engine internals.

Static ReadonlyIsInternalTemplateRoot

IsInternalTemplateRoot = 256

Set on the object that's a root template instance that also contains template internals (e.g. template instance in the template editor or scene object in the Template resource itself).

Static ReadonlyNone

None = 0

Special case for empty flags check.

Static ReadonlyNoSaveOrSync

NoSaveOrSync = 2

Object will be skipped when saving or synchronizing the scene hierarchy or a template.

Static ReadonlyProtected

Protected = 64

Object is protected and cannot be deleted by the user.

Static ReadonlyReadonly

Readonly = 128

Object properties are read-only and cannot be modified by the user.

Note

This does not apply to child-objects.

Static ReadonlyRuntimePersistent

RuntimePersistent = 4

Object will remain in the scene even after scene clear, unless destroyed directly. Such objects cannot be saved.

Static ReadonlyScenePersistent

ScenePersistent = 16

Object will remain in the scene during scene reset operations (e.g. when entering play mode), but will be destroyed when unloading or changing scene.

Static ReadonlyTemplateInstanceRoot

TemplateInstanceRoot = 512

Determines whether the scene object is the root of a template instance.

Methods

StaticaddFlag

StaticcombineFlags

  • combineFlags<T>(values): EnumValueTyped<T, number>

  • Takes an array of enum values and combines them as a single enum flag value. This assumes that the target enum is a flag enum that can have their values combined using bitwise operators.

    Type Parameters

    Parameters

    Returns EnumValueTyped<T, number>

    The combined enum value.

StaticgetEnumName

  • getEnumName<T>(index): string

  • Type Parameters

    • T

    Parameters

    Returns string

    Obsolete

    Compatibility

StaticgetEnumNames

  • getEnumNames(): string[]

  • Returns string[]

    Obsolete

    Compatibility

StaticgetEnumValue

  • getEnumValue(index): number

  • Parameters

    • index: number

    Returns number

    Obsolete

    Compatibility

StaticgetEnumValues

  • getEnumValues(): number[]

  • Returns number[]

    Obsolete

    Compatibility

StaticgetNameForValue

  • getNameForValue<T>(enumValue): string

  • Gets the name for the enumeration value that matches the specified enumValue.

    Type Parameters

    • T

    Parameters

    Returns string

    The enumeration value or undefined if not found.

StaticgetNames

  • getNames(): string[]

  • Gets the enumeration names

    Returns string[]

    The enumeration names.

StaticgetValueAtIndex

  • getValueAtIndex<T>(index): EnumValueTyped<T, number>

  • Gets the enumeration value at the specified index.

    Type Parameters

    • T = number

    Parameters

    • index: number

      The index.

    Returns EnumValueTyped<T, number>

    The enumeration value or undefined if not found.

StaticgetValues

StatichasFlag

  • hasFlag<T, K>(value, bits): boolean

  • Determines if the enum value has the flags set.

    Type Parameters

    Parameters

    Returns boolean

StatichasFlagChanged

  • hasFlagChanged<T, K>(previousValue, newValue, bits): boolean

  • Determines if the enum bits were changed from previousValue to currentValue.

    Type Parameters

    Parameters

    Returns boolean

StaticiterateNames

  • iterateNames(): Generator<string, any, any>

  • Iterates the enumeration names

    Returns Generator<string, any, any>

    The enumeration names.

StaticiterateValues

  • iterateValues<T>(): Generator<EnumValueTyped<T, number>, any, any>

  • Iterates the enumeration values

    Type Parameters

    • T = any

    Returns Generator<EnumValueTyped<T, number>, any, any>

    The enumeration values.

StaticremoveFlag

StaticsplitFlags

  • splitFlags<T>(value): EnumValueTyped<T, number>[]

  • Takes a single enum value and splits it into separated flag values set on the value. This assumes that the target enum is a flag enum that can have their values combined using bitwise operators.

    Type Parameters

    Parameters

    • value: number | BrandedType<number, "enum"> | BrandedType<T, "enum">

      The enum value to have it's value split using bitwise-and operator.

    Returns EnumValueTyped<T, number>[]

    An array of each "bit flag" set in the enum.

Settings

Member Visibility

On This Page

Constructors
Values
Methods