PropertyUsageFlags

Conformances

• protocol CustomDebugStringConvertible

  A type with a customized textual representation suitable for debugging purposes.

• protocol Equatable

  A type that can be compared for value equality.

• protocol ExpressibleByArrayLiteral

  A type that can be initialized using an array literal.

• protocol OptionSet

  A type that presents a mathematical set interface to a bit set.

• protocol RawRepresentable<RawValue>

  A type that can be converted to and from an associated raw value.

• protocol SetAlgebra<Element>

  A type that provides mathematical set operations.

Type members

• init(rawValue: Int)
• static let alwaysDuplicate: PropertyUsageFlags

  When duplicating a resource with duplicate(subresources:), and this flag is set on a property of that resource, the property should always be duplicated, regardless of the subresources bool parameter.

• static let array: PropertyUsageFlags

  The property is an array.

• static let category: PropertyUsageFlags

  Used to categorize properties together in the editor.

• static let checkable: PropertyUsageFlags

  The property can be checked in the EditorInspector.

• static let checked: PropertyUsageFlags

  The property is checked in the EditorInspector.

• static let classIsBitfield: PropertyUsageFlags

  The property is a bitfield, i.e. it contains multiple flags represented as bits.

• static let classIsEnum: PropertyUsageFlags

  The property is an enum, i.e. it only takes named integer constants from its associated enumeration.

• static let `default`: PropertyUsageFlags

  Default usage (storage and editor).

• static let deferredSetResource: PropertyUsageFlags

  When loading, the resource for this property can be set at the end of loading.

• static let editor: PropertyUsageFlags

  The property is shown in the EditorInspector (default).

• static let editorBasicSetting: PropertyUsageFlags

  The property is considered a basic setting and will appear even when advanced mode is disabled. Used for project settings.

• static let editorInstantiateObject: PropertyUsageFlags

  When this property is a Resource and base object is a Node, a resource instance will be automatically created whenever the node is created in the editor.

• static let group: PropertyUsageFlags

  Used to group properties together in the editor. See EditorInspector.

• static let highEndGfx: PropertyUsageFlags

  The property is only shown in the editor if modern renderers are supported (the Compatibility rendering method is excluded).

• static let `internal`: PropertyUsageFlags

  The property is excluded from the class reference.

• static let keyingIncrements: PropertyUsageFlags

  Inserting an animation key frame of this property will automatically increment the value, allowing to easily keyframe multiple values in a row.

• static let neverDuplicate: PropertyUsageFlags

  When duplicating a resource with duplicate(subresources:), and this flag is set on a property of that resource, the property should never be duplicated, regardless of the subresources bool parameter.

• static let nilIsVariant: PropertyUsageFlags

  If property has nil as default value, its type will be Variant.

• static let noEditor: PropertyUsageFlags

  Default usage but without showing the property in the editor (storage).

• static let noInstanceState: PropertyUsageFlags

  The property does not save its state in PackedScene.

• static let nodePathFromSceneRoot: PropertyUsageFlags

  The NodePath property will always be relative to the scene’s root. Mostly useful for local resources.

• static let readOnly: PropertyUsageFlags

  The property is read-only in the EditorInspector.

• static let resourceNotPersistent: PropertyUsageFlags

  Use when a resource is created on the fly, i.e. the getter will always return a different instance. ResourceSaver needs this information to properly save such resources.

• static let restartIfChanged: PropertyUsageFlags

  Editing the property prompts the user for restarting the editor.

• static let scriptDefaultValue: PropertyUsageFlags

  Signifies a default value from a placeholder script instance.

• static let scriptVariable: PropertyUsageFlags

  The property is a script variable which should be serialized and saved in the scene file.

• static let secret: PropertyUsageFlags

  An export preset property with this flag contains confidential information and is stored separately from the rest of the export preset configuration.

• static let storage: PropertyUsageFlags

  The property is serialized and saved in the scene file (default).

• static let storeIfNull: PropertyUsageFlags

  The property value of type Object will be stored even if its value is null.

• static let subgroup: PropertyUsageFlags

  Used to group properties together in the editor in a subgroup (under a group). See EditorInspector.

• static let updateAllIfModified: PropertyUsageFlags

  If this property is modified, all inspector fields will be refreshed.

Instance members

• var debugDescription: String

  A textual representation of this instance, suitable for debugging

• let rawValue: Int

Type features

• init()

  Creates an empty option set.

• init<S>(S)

  Creates a new set from a finite sequence of items.

• init(arrayLiteral: Self.Element...)

  Creates a set containing the elements of the given array literal.

• static func != (lhs: Self, rhs: Self) -> Bool

  Returns a Boolean value indicating whether two values are not equal.

Instance features

• var isEmpty: Bool

  A Boolean value that indicates whether the set has no elements.

• func contains(Self) -> Bool

  Returns a Boolean value that indicates whether a given element is a member of the option set.

• func formIntersection(Self)

  Removes all elements of this option set that are not also present in the given set.

• func formSymmetricDifference(Self)

  Replaces this set with a new set containing all elements contained in either this set or the given set, but not in both.

• func formUnion(Self)

  Inserts the elements of another set into this option set.

• func insert(Self.Element) -> (inserted: Bool, memberAfterInsert: Self.Element)

  Adds the given element to the option set if it is not already a member.

• func intersection(Self) -> Self

  Returns a new option set with only the elements contained in both this set and the given set.

• func isDisjoint(with: Self) -> Bool

  Returns a Boolean value that indicates whether the set has no members in common with the given set.

• func isStrictSubset(of: Self) -> Bool

  Returns a Boolean value that indicates whether this set is a strict subset of the given set.

• func isStrictSuperset(of: Self) -> Bool

  Returns a Boolean value that indicates whether this set is a strict superset of the given set.

• func isSubset(of: Self) -> Bool

  Returns a Boolean value that indicates whether the set is a subset of another set.

• func isSuperset(of: Self) -> Bool

  Returns a Boolean value that indicates whether the set is a superset of the given set.

• func remove(Self.Element) -> Self.Element?

  Removes the given element and all elements subsumed by it.

• func subtract(Self)

  Removes the elements of the given set from this set.

• func subtracting(Self) -> Self

  Returns a new set containing the elements of this set that do not occur in the given set.

• func symmetricDifference(Self) -> Self

  Returns a new option set with the elements contained in this set or in the given set, but not in both.

• func union(Self) -> Self

  Returns a new option set of the elements contained in this set, in the given set, or in both.

• func update(with: Self.Element) -> Self.Element?

  Inserts the given element into the set.