s&box docs
API Referenceglobal

CustomizableSerializedPropertyclass

A proxy around a SerializedProperty that allows overriding any property for UI customization. Unset values fall through to the underlying property.

object→Proxy→CustomizableSerializedProperty
Namespace
global
Assembly
Sandbox.System
Declaration
public class Sandbox.SerializedProperty.CustomizableSerializedProperty : Sandbox.SerializedProperty.Proxy

Constructors1

Showing 1 constructors

Methods18

Showing 18 methods

public void AddAttribute(System.Attribute attribute)PUBLIC

Append an extra attribute visible to the editor and control widgets.

ParameterTypeDescription
attributeAttribute—
Returns:void—

public virtual System.Collections.Generic.IEnumerable`1<System.Attribute> GetAttributes()PUBLICVIRTUAL

Returns the underlying attributes merged with any added via `Sandbox.SerializedProperty.CustomizableSerializedProperty.AddAttribute(System.Attribute)`.

Returns:IEnumerable<Attribute>—

public void SetDescription(string value)PUBLIC

Override the tooltip / description text.

ParameterTypeDescription
valuestring—
Returns:void—

public void SetDisplayName(string value)PUBLIC

Override the label shown in the inspector.

ParameterTypeDescription
valuestring—
Returns:void—

public void SetGroupName(string value)PUBLIC

Override which inspector group this property appears in.

ParameterTypeDescription
valuestring—
Returns:void—

public void SetHasChanges(bool value)PUBLIC

Override the dirty/changed flag.

ParameterTypeDescription
valuebool—
Returns:void—

public void SetIsEditable(bool value)PUBLIC

Force the property to be editable or read-only.

ParameterTypeDescription
valuebool—
Returns:void—

public void SetIsField(bool value)PUBLIC

Override whether this appears as a field.

ParameterTypeDescription
valuebool—
Returns:void—

public void SetIsMethod(bool value)PUBLIC

Override whether this appears as a method.

ParameterTypeDescription
valuebool—
Returns:void—

public void SetIsProperty(bool value)PUBLIC

Override whether this appears as a property.

ParameterTypeDescription
valuebool—
Returns:void—

public void SetIsPublic(bool value)PUBLIC

Override the public visibility flag.

ParameterTypeDescription
valuebool—
Returns:void—

public void SetIsValid(bool value)PUBLIC

Override the validity flag.

ParameterTypeDescription
valuebool—
Returns:void—

public void SetName(string value)PUBLIC

Override the property's internal name.

ParameterTypeDescription
valuestring—
Returns:void—

public void SetOrder(int value)PUBLIC

Override the sort order within the inspector.

ParameterTypeDescription
valueint—
Returns:void—

public void SetPropertyType(System.Type value)PUBLIC

Override the reported property type.

ParameterTypeDescription
valueType—
Returns:void—

public void SetSourceFile(string value)PUBLIC

Override the reported source file path.

ParameterTypeDescription
valuestring—
Returns:void—

public void SetSourceLine(int value)PUBLIC

Override the reported source line number.

ParameterTypeDescription
valueint—
Returns:void—

Properties17

Showing 17 properties

Vector3

Previous Page

Description

Next Page

On this page

Constructorspublic CustomizableSerializedProperty(Sandbox.SerializedProperty property)Methodspublic System.Void AddAttribute(System.Attribute attribute)public virtual System.Collections.Generic.IEnumerable`1<System.Attribute> GetAttributes()public System.Void SetDescription(System.String value)public System.Void SetDisplayName(System.String value)public System.Void SetGroupName(System.String value)public System.Void SetHasChanges(System.Boolean value)public System.Void SetIsEditable(System.Boolean value)public System.Void SetIsField(System.Boolean value)public System.Void SetIsMethod(System.Boolean value)public System.Void SetIsProperty(System.Boolean value)public System.Void SetIsPublic(System.Boolean value)public System.Void SetIsValid(System.Boolean value)public System.Void SetName(System.String value)public System.Void SetOrder(System.Int32 value)public System.Void SetParent(Sandbox.SerializedObject value)public System.Void SetPropertyType(System.Type value)public System.Void SetSourceFile(System.String value)public System.Void SetSourceLine(System.Int32 value)Propertiespublic virtual System.String Sandbox.SerializedProperty.CustomizableSerializedProperty.Description { get; set; }public virtual System.String Sandbox.SerializedProperty.CustomizableSerializedProperty.DisplayName { get; set; }public virtual System.String Sandbox.SerializedProperty.CustomizableSerializedProperty.GroupName { get; set; }public virtual System.Boolean Sandbox.SerializedProperty.CustomizableSerializedProperty.HasChanges { get; set; }public virtual System.Boolean Sandbox.SerializedProperty.CustomizableSerializedProperty.IsEditable { get; set; }public virtual System.Boolean Sandbox.SerializedProperty.CustomizableSerializedProperty.IsField { get; set; }public virtual System.Boolean Sandbox.SerializedProperty.CustomizableSerializedProperty.IsMethod { get; set; }public virtual System.Boolean Sandbox.SerializedProperty.CustomizableSerializedProperty.IsProperty { get; set; }public virtual System.Boolean Sandbox.SerializedProperty.CustomizableSerializedProperty.IsPublic { get; set; }public virtual System.Boolean Sandbox.SerializedProperty.CustomizableSerializedProperty.IsValid { get; set; }public virtual System.String Sandbox.SerializedProperty.CustomizableSerializedProperty.Name { get; set; }public virtual System.Int32 Sandbox.SerializedProperty.CustomizableSerializedProperty.Order { get; set; }public virtual Sandbox.SerializedObject Sandbox.SerializedProperty.CustomizableSerializedProperty.Parent { get; set; }public virtual System.Type Sandbox.SerializedProperty.CustomizableSerializedProperty.PropertyType { get; set; }protected virtual Sandbox.SerializedProperty Sandbox.SerializedProperty.CustomizableSerializedProperty.ProxyTarget { get; set; }public virtual System.String Sandbox.SerializedProperty.CustomizableSerializedProperty.SourceFile { get; set; }public virtual System.Int32 Sandbox.SerializedProperty.CustomizableSerializedProperty.SourceLine { get; set; }Metadata