SuperBehaviour SuperBehaviour
SuperBehaviour SuperBehaviour
v0.1.2 [Beta]

Search Results for

    Class SuperSerializedProperty

    Namespace
    LoM.Super.Serialization
    Assembly
    LoM.Super.Editor.dll

    SuperSerializedProperty and SuperSerializedObject are classes for editing properties on objects in a completely generic way that automatically handles undo, multi-object editing and Prefab overrides.
    Unlike the SerializedObject and SerializedProperty classes provided by Unity, this class supports Properties and Fields

    public class SuperSerializedProperty
    Inheritance
    object
    SuperSerializedProperty

    Properties

    Attributes

    public SerializedAttributes Attributes { get; }

    Property Value

    SerializedAttributes

    Field

    public SerializedProperty Field { get; }

    Property Value

    SerializedProperty

    Info

    public MemberInfo Info { get; }

    Property Value

    MemberInfo

    IsField

    public bool IsField { get; }

    Property Value

    bool

    TargetObject

    Target object of this property (Read Only).

    public Object TargetObject { get; }

    Property Value

    Object

    Type

    Type of the property. (Read Only)

    public Type Type { get; }

    Property Value

    Type

    animationCurveValue

    Value of a animation curve property.

    public AnimationCurve animationCurveValue { get; set; }

    Property Value

    AnimationCurve

    animationCurveValueSingle

    Value of a animation curve property (Single)
    Returns the item's single value (not the multi-editing value).

    public AnimationCurve animationCurveValueSingle { get; }

    Property Value

    AnimationCurve

    arrayElementType

    Type name of the element in an array property. (Read Only)

    public string arrayElementType { get; }

    Property Value

    string

    arraySize

    The number of elements in the array.

    public int arraySize { get; set; }

    Property Value

    int

    boolValue

    Value of a boolean property.

    public bool boolValue { get; set; }

    Property Value

    bool

    boolValueSingle

    public bool boolValueSingle { get; }

    Property Value

    bool

    boundsIntValue

    Value of bounds with integer values property.

    public BoundsInt boundsIntValue { get; set; }

    Property Value

    BoundsInt

    boundsIntValueSingle

    Value of bounds with integer values property (Single)
    Returns the item's single value (not the multi-editing value).

    public BoundsInt boundsIntValueSingle { get; }

    Property Value

    BoundsInt

    boundsValue

    Value of bounds property.

    public Bounds boundsValue { get; set; }

    Property Value

    Bounds

    boundsValueSingle

    Value of bounds property (Single)
    Returns the item's single value (not the multi-editing value).

    public Bounds boundsValueSingle { get; }

    Property Value

    Bounds

    boxedValue

    Value of the SerializedProperty, boxed as a System.Object.

    public object boxedValue { get; set; }

    Property Value

    object

    boxedValueSingle

    Value of the SerializedProperty, boxed as a System.Object (Single)
    Returns the item's single value (not the multi-editing value).

    public object boxedValueSingle { get; }

    Property Value

    object

    colorValue

    Value of a color property.

    public Color colorValue { get; set; }

    Property Value

    Color

    colorValueSingle

    Value of a color property (Single)
    Returns the item's single value (not the multi-editing value).

    public Color colorValueSingle { get; }

    Property Value

    Color

    contentHash

    Provides the hash value for the property. (Read Only)

    public uint contentHash { get; }

    Property Value

    uint

    depth

    Nesting depth of the property. (Read Only)

    public int depth { get; }

    Property Value

    int

    displayName

    Nice display name of the property. (Read Only)

    public string displayName { get; }

    Property Value

    string

    doubleValue

    Value of a float property as a double.

    public double doubleValue { get; set; }

    Property Value

    double

    doubleValueSingle

    Value of a float property as a double (Single)
    Returns the item's single value (not the multi-editing value).

    public double doubleValueSingle { get; }

    Property Value

    double

    editable

    Is this property editable? (Read Only)

    public bool editable { get; }

    Property Value

    bool

    enumDisplayNames

    Display-friendly names of enumeration of an enum property.

    public string[] enumDisplayNames { get; }

    Property Value

    string[]

    enumDisplayNamesSingle

    Display-friendly names of enumeration of an enum property (Single)
    Returns the item's single value (not the multi-editing value).

    public string[] enumDisplayNamesSingle { get; }

    Property Value

    string[]

    enumNames

    Names of enumeration of an enum property.

    public string[] enumNames { get; }

    Property Value

    string[]

    enumNamesSingle

    Names of enumeration of an enum property (Single)
    Returns the item's single value (not the multi-editing value).

    public string[] enumNamesSingle { get; }

    Property Value

    string[]

    enumValueFlag

    Int32 representation of an enum property with Mixed Values.

    public int enumValueFlag { get; set; }

    Property Value

    int

    enumValueFlagSingle

    Int32 representation of an enum property with Mixed Values (Single)
    Returns the item's single value (not the multi-editing value).

    public int enumValueFlagSingle { get; }

    Property Value

    int

    enumValueIndex

    Enum index of an enum property.

    public int enumValueIndex { get; set; }

    Property Value

    int

    enumValueIndexSingle

    Enum index of an enum property (Single)
    Returns the item's single value (not the multi-editing value).

    public int enumValueIndexSingle { get; }

    Property Value

    int

    exposedReferenceValue

    A reference to another Object in the Scene. This reference is resolved in the context of the SerializedObject containing the SerializedProperty.

    public Object exposedReferenceValue { get; set; }

    Property Value

    Object

    exposedReferenceValueSingle

    A reference to another Object in the Scene. This reference is resolved in the context of the SerializedObject containing the SerializedProperty (Single)
    Returns the item's single value (not the multi-editing value).

    public Object exposedReferenceValueSingle { get; }

    Property Value

    Object

    fixedBufferSize

    The number of elements in the fixed buffer. (Read Only)

    public int fixedBufferSize { get; }

    Property Value

    int

    floatValue

    Value of a float property.

    public float floatValue { get; set; }

    Property Value

    float

    floatValueSingle

    Value of a float property (Single)
    Returns the item's single value (not the multi-editing value).

    public float floatValueSingle { get; }

    Property Value

    float

    gradientValue

    Value of a gradient property.

    public Gradient gradientValue { get; set; }

    Property Value

    Gradient

    gradientValueSingle

    Value of a gradient property (Single)
    Returns the item's single value (not the multi-editing value).

    public Gradient gradientValueSingle { get; }

    Property Value

    Gradient

    hasChildren

    Does it have child properties? (Read Only)

    public bool hasChildren { get; }

    Property Value

    bool

    hasMultipleDifferentValues

    Does this property represent multiple different values due to multi-object editing? (Read Only)

    public bool hasMultipleDifferentValues { get; }

    Property Value

    bool

    hasVisibleChildren

    Does it have visible child properties? (Read Only)

    public bool hasVisibleChildren { get; }

    Property Value

    bool

    hash128Value

    The value of a Hash128 property.

    public Hash128 hash128Value { get; set; }

    Property Value

    Hash128

    hash128ValueSingle

    The value of a Hash128 property (Single)
    Returns the item's single value (not the multi-editing value).

    public Hash128 hash128ValueSingle { get; }

    Property Value

    Hash128

    intValue

    Value of an integer property.

    public int intValue { get; set; }

    Property Value

    int

    intValueSingle

    Value of an integer property (Single)
    Returns the item's single value (not the multi-editing value).

    public int intValueSingle { get; }

    Property Value

    int

    isAnimated

    Is this property animated? (Read Only)

    public bool isAnimated { get; }

    Property Value

    bool

    isArray

    Is this property an array? (Read Only)

    public bool isArray { get; }

    Property Value

    bool

    isDefaultOverride

    Allows you to check whether his property is a PrefabUtility.IsDefaultOverride|default override. Certain properties on Prefab instances are default overrides. See PrefabUtility.IsDefaultOverride for more information.

    public bool isDefaultOverride { get; }

    Property Value

    bool

    isExpanded

    Is this property expanded in the inspector?

    public bool isExpanded { get; set; }

    Property Value

    bool

    isFixedBuffer

    Is this property a fixed buffer? (Read Only)

    public bool isFixedBuffer { get; }

    Property Value

    bool

    isInstantiatedPrefab

    Is property part of a Prefab instance? (Read Only)

    public bool isInstantiatedPrefab { get; }

    Property Value

    bool

    longValue

    Value of an integer property as a long.

    public long longValue { get; set; }

    Property Value

    long

    longValueSingle

    Value of an integer property as a long (Single)
    Returns the item's single value (not the multi-editing value).

    public long longValueSingle { get; }

    Property Value

    long

    managedReferenceFieldTypename

    String corresponding to the value of the managed reference field full type string.

    public string managedReferenceFieldTypename { get; }

    Property Value

    string

    managedReferenceFieldTypenameSingle

    String corresponding to the value of the managed reference field full type string (Single)
    Returns the item's single value (not the multi-editing value).

    public string managedReferenceFieldTypenameSingle { get; }

    Property Value

    string

    managedReferenceFullTypename

    String corresponding to the value of the managed reference object (dynamic) full type string.

    public string managedReferenceFullTypename { get; }

    Property Value

    string

    managedReferenceFullTypenameSingle

    String corresponding to the value of the managed reference object (dynamic) full type string (Single)
    Returns the item's single value (not the multi-editing value).

    public string managedReferenceFullTypenameSingle { get; }

    Property Value

    string

    managedReferenceId

    Id associated with a managed reference.

    public long managedReferenceId { get; set; }

    Property Value

    long

    managedReferenceIdSingle

    Id associated with a managed reference (Single)
    Returns the item's single value (not the multi-editing value).

    public long managedReferenceIdSingle { get; }

    Property Value

    long

    managedReferenceValue

    The object assigned to a field with SerializeReference attribute.

    public object managedReferenceValue { get; set; }

    Property Value

    object

    managedReferenceValueSingle

    The object assigned to a field with SerializeReference attribute (Single)
    Returns the item's single value (not the multi-editing value).

    public object managedReferenceValueSingle { get; }

    Property Value

    object

    minArraySize

    The smallest number of elements in the array across all target objects. (Read Only)

    public int minArraySize { get; }

    Property Value

    int

    name

    Name of the property. (Read Only)

    public string name { get; }

    Property Value

    string

    numericType

    Return the precise type for Integer and Floating point properties. (Read Only)

    public SerializedPropertyNumericType numericType { get; }

    Property Value

    SerializedPropertyNumericType

    objectReferenceInstanceIDValue

    Object ID of an object reference property.

    public int objectReferenceInstanceIDValue { get; set; }

    Property Value

    int

    objectReferenceInstanceIDValueSingle

    Object ID of an object reference property (Single)
    Returns the item's single value (not the multi-editing value).

    public int objectReferenceInstanceIDValueSingle { get; }

    Property Value

    int

    objectReferenceValue

    Value of an object reference property.

    public Object objectReferenceValue { get; set; }

    Property Value

    Object

    objectReferenceValueSingle

    Value of an object reference property (Single)
    Returns the item's single value (not the multi-editing value).

    public Object objectReferenceValueSingle { get; }

    Property Value

    Object

    prefabOverride

    Allows you to check whether a property's value is overriden (i.e. different to the Prefab it belongs to).

    public bool prefabOverride { get; set; }

    Property Value

    bool

    propertyPath

    Full path of the property. (Read Only)

    public string propertyPath { get; }

    Property Value

    string

    propertyType

    Type of this property (Read Only).

    public SerializedPropertyType propertyType { get; }

    Property Value

    SerializedPropertyType

    quaternionValue

    Value of a quaternion property.

    public Quaternion quaternionValue { get; set; }

    Property Value

    Quaternion

    quaternionValueSingle

    Value of a quaternion property (Single)
    Returns the item's single value (not the multi-editing value).

    public Quaternion quaternionValueSingle { get; }

    Property Value

    Quaternion

    rectIntValue

    Value of a rectangle with integer values property.

    public RectInt rectIntValue { get; set; }

    Property Value

    RectInt

    rectIntValueSingle

    Value of a rectangle with integer values property (Single)
    Returns the item's single value (not the multi-editing value).

    public RectInt rectIntValueSingle { get; }

    Property Value

    RectInt

    rectValue

    Value of a rectangle property.

    public Rect rectValue { get; set; }

    Property Value

    Rect

    rectValueSingle

    Value of a rectangle property (Single)
    Returns the item's single value (not the multi-editing value).

    public Rect rectValueSingle { get; }

    Property Value

    Rect

    serializedObject

    SerializedObject this property belongs to (Read Only).

    public SerializedObject serializedObject { get; }

    Property Value

    SerializedObject

    stringValue

    Value of a string property.

    public string stringValue { get; set; }

    Property Value

    string

    stringValueSingle

    Value of a string property (Single)
    Returns the item's single value (not the multi-editing value).

    public string stringValueSingle { get; }

    Property Value

    string

    superSerializedObject

    SerializedObject this property belongs to (Read Only).

    public SuperSerializedObject superSerializedObject { get; }

    Property Value

    SuperSerializedObject

    tooltip

    Tooltip of the property. (Read Only)

    public string tooltip { get; }

    Property Value

    string

    type

    Type name of the property. (Read Only)

    public string type { get; }

    Property Value

    string

    uintValue

    Value of an integer property as an unsigned int.

    public uint uintValue { get; set; }

    Property Value

    uint

    uintValueSingle

    Value of an integer property as an unsigned int (Single)
    Returns the item's single value (not the multi-editing value).

    public uint uintValueSingle { get; }

    Property Value

    uint

    ulongValue

    Value of an integer property as an unsigned long.

    public ulong ulongValue { get; set; }

    Property Value

    ulong

    ulongValueSingle

    Value of an integer property as an unsigned long (Single)
    Returns the item's single value (not the multi-editing value).

    public ulong ulongValueSingle { get; }

    Property Value

    ulong

    vector2IntValue

    Value of a 2D integer vector property.

    public Vector2Int vector2IntValue { get; set; }

    Property Value

    Vector2Int

    vector2IntValueSingle

    Value of a 2D integer vector property (Single)
    Returns the item's single value (not the multi-editing value).

    public Vector2Int vector2IntValueSingle { get; }

    Property Value

    Vector2Int

    vector2Value

    Value of a 2D vector property.

    public Vector2 vector2Value { get; set; }

    Property Value

    Vector2

    vector2ValueSingle

    Value of a 2D vector property (Single)
    Returns the item's single value (not the multi-editing value).

    public Vector2 vector2ValueSingle { get; }

    Property Value

    Vector2

    vector3IntValue

    Value of a 3D integer vector property.

    public Vector3Int vector3IntValue { get; set; }

    Property Value

    Vector3Int

    vector3IntValueSingle

    Value of a 3D integer vector property (Single)
    Returns the item's single value (not the multi-editing value).

    public Vector3Int vector3IntValueSingle { get; }

    Property Value

    Vector3Int

    vector3Value

    Value of a 3D vector property.

    public Vector3 vector3Value { get; set; }

    Property Value

    Vector3

    vector3ValueSingle

    Value of a 3D vector property (Single)
    Returns the item's single value (not the multi-editing value).

    public Vector3 vector3ValueSingle { get; }

    Property Value

    Vector3

    vector4Value

    Value of a 4D vector property.

    public Vector4 vector4Value { get; set; }

    Property Value

    Vector4

    vector4ValueSingle

    Value of a 4D vector property (Single)
    Returns the item's single value (not the multi-editing value).

    public Vector4 vector4ValueSingle { get; }

    Property Value

    Vector4

    Methods

    ClearArray()

    Remove all elements from the array.

    public void ClearArray()

    Copy()

    [Obsolete("Use SuperSerializedProperty.CopyPropery() instead.")]
    public SerializedProperty Copy()

    Returns

    SerializedProperty

    CopyPropery()

    Returns a copy of the SerializedProperty iterator in its current state.

    public SuperSerializedProperty CopyPropery()

    Returns

    SuperSerializedProperty

    CountInProperty()

    Count visible children of this property, including this property itself.

    public int CountInProperty()

    Returns

    int

    CountRemaining()

    Count remaining visible properties.

    public int CountRemaining()

    Returns

    int

    DataEquals(SerializedProperty, SerializedProperty)

    Compares the data for two SerializedProperties. This method ignores paths and SerializedObjects.

    public static bool DataEquals(SerializedProperty x, SerializedProperty y)

    Parameters

    x SerializedProperty
    y SerializedProperty

    Returns

    bool

    DeleteArrayElementAtIndex(int)

    Delete the element at the specified index in the array.

    public void DeleteArrayElementAtIndex(int index)

    Parameters

    index int

    DeleteCommand()

    Deletes the array element referenced by the SerializedProperty.

    public bool DeleteCommand()

    Returns

    bool

    Dispose()

    public void Dispose()

    DuplicateCommand()

    Duplicates the array element referenced by the SerializedProperty.

    public bool DuplicateCommand()

    Returns

    bool

    EqualContents(SerializedProperty, SerializedProperty)

    See if contained serialized properties are equal.

    public static bool EqualContents(SerializedProperty x, SerializedProperty y)

    Parameters

    x SerializedProperty
    y SerializedProperty

    Returns

    bool

    FindPropertyRelative(string)

    Retrieves the SerializedProperty at a relative path to the current property.

    public SerializedProperty FindPropertyRelative(string relativePropertyPath)

    Parameters

    relativePropertyPath string

    Returns

    SerializedProperty

    GetArrayElementAtIndex(int)

    Returns the element at the specified index in the array.

    public SerializedProperty GetArrayElementAtIndex(int index)

    Parameters

    index int

    Returns

    SerializedProperty

    GetEndProperty()

    Retrieves the SerializedProperty that defines the end range of this property.

    public SerializedProperty GetEndProperty()

    Returns

    SerializedProperty

    GetEndProperty(bool)

    Retrieves the SerializedProperty that defines the end range of this property.

    public SerializedProperty GetEndProperty(bool includeInvisible)

    Parameters

    includeInvisible bool

    Returns

    SerializedProperty

    GetEnumerator()

    Retrieves an iterator for enumerating over the visible child properties of the current property. If the property is an array it will enumerate over the array elements.

    public IEnumerator GetEnumerator()

    Returns

    IEnumerator

    GetFixedBufferElementAtIndex(int)

    Returns the element at the specified index in the fixed buffer.

    public SerializedProperty GetFixedBufferElementAtIndex(int index)

    Parameters

    index int

    Returns

    SerializedProperty

    InsertArrayElementAtIndex(int)

    Insert an new element at the specified index in the array.

    public void InsertArrayElementAtIndex(int index)

    Parameters

    index int

    InvokeMethod(string)

    Invoke a method on the target object / objects.

    public void InvokeMethod(string methodName)

    Parameters

    methodName string

    Name of the method to be invoked

    InvokeMethod(string, Object)

    Invoke a method on a specific target object.

    public void InvokeMethod(string methodName, Object obj)

    Parameters

    methodName string

    Name of the method to be invoked

    obj Object

    Target object

    InvokeMethod<T>(string, params object[])

    Invoke a method on the target object / objects with parameters.

    public T InvokeMethod<T>(string methodName, params object[] parameters)

    Parameters

    methodName string

    Name of the method to be invoked

    parameters object[]

    Parameters to be passed to the method

    Returns

    T

    Return value of the method

    Type Parameters

    T

    Type of the parameter

    InvokeMethod<T>(string, Object, params object[])

    Invoke a method on a specific target object with parameters.

    public T InvokeMethod<T>(string methodName, Object obj, params object[] parameters)

    Parameters

    methodName string

    Name of the method to be invoked

    obj Object

    Target object

    parameters object[]

    Parameters to be passed to the method

    Returns

    T

    Return value of the method

    Type Parameters

    T

    Type of the parameter

    MoveArrayElement(int, int)

    Move an array element from srcIndex to dstIndex.

    public bool MoveArrayElement(int srcIndex, int dstIndex)

    Parameters

    srcIndex int
    dstIndex int

    Returns

    bool

    Next(bool)

    Move to next property.

    public bool Next(bool enterChildren)

    Parameters

    enterChildren bool

    Returns

    bool

    NextVisible(bool)

    Move to next visible property.

    public bool NextVisible(bool enterChildren)

    Parameters

    enterChildren bool

    Returns

    bool

    Reevaluate()

    Trigger re-evaluation of all condition attributes on this property.

    public void Reevaluate()

    Reset()

    Move to first property of the object.

    public void Reset()

    Operators

    implicit operator SerializedProperty(SuperSerializedProperty)

    public static implicit operator SerializedProperty(SuperSerializedProperty superSerializedProperty)

    Parameters

    superSerializedProperty SuperSerializedProperty

    Returns

    SerializedProperty
    © Lords of Mahlstrom Gaming, all rights reserved.