s&
newspaper
About
info
About s&box
newspaper
Latest News
published_with_changes
Changes
map
Roadmap
monitoring
Metrics
games
Games
sports_esports
Browse Games
rocket
Discover Games
business_center
Workshop
sports_esports
Games
landscape
Maps
chair
Models
texture
Materials
apparel
Clothing
construction
More..
forum
Forum
docs
Docs
docs
Documentation
dashboard
Api Reference
school
Tutorials
input
Log in with Steam
chevron_left
Change Language
简体中文
English
Русский
Español
Português-Brasil
Deutsch
日本語
Français
Polski
Türkçe
한국어
Pirate
Italiano
ไทย
繁體中文
Українська
Čeština
Nederlands
Magyar
Dansk
Suomi
Svenska
Norsk
Ελληνικά
Română
Български
Tiếng Việt
Bahasa Indonesia
Español-Latinoamérica
العربية
Api
Classes
SerializedProperty
chevron_left
Classes
class
SerializedProperty
search
Constructors
functions
SerializedProperty
Properties
data_object
As
data_object
Description
data_object
DisplayName
data_object
GroupName
data_object
HasChanges
data_object
IsEditable
data_object
IsField
data_object
IsMethod
data_object
IsMultipleDifferentValues
data_object
IsMultipleValues
data_object
IsNull
data_object
IsNullable
data_object
IsProperty
data_object
IsPublic
data_object
IsValid
data_object
MultipleProperties
data_object
Name
data_object
NullableType
data_object
OnChanged
data_object
OnFinishEdit
data_object
OnPreChange
data_object
OnStartEdit
data_object
Order
data_object
Parent
data_object
PropertyType
data_object
SourceFile
data_object
SourceLine
Methods
functions
GetAttributes
functions
GetCustomizable
functions
GetDefault
functions
GetKey
functions
GetValue
functions
HasAttribute
functions
Invoke
lock
NoteChanged
lock
NoteFinishEdit
lock
NotePreChange
lock
NoteStartEdit
functions
SetNullState
functions
SetValue
functions
ShouldShow
functions
TryGetAsObject
functions
TryGetAttribute
lock
ValueToType
Static Methods
remove_circle
Create
functions
FindPathInScene
functions
GetContainingGameObject
SerializedProperty
class
Sandbox
.
abstract
Sandbox.System
build
Constructors
1
SerializedProperty
(
)
data_object
Properties
27
As
AsAccessor
Description
string
DisplayName
string
GroupName
string
HasChanges
bool
Returns true if the current set value differs from the actual value
IsEditable
bool
IsField
bool
IsMethod
bool
IsMultipleDifferentValues
bool
True if this holds multiple values, and they're all different.
IsMultipleValues
bool
True if this holds multiple values. That might all be the same.
IsNull
bool
True if the value is null
IsNullable
bool
Return true if this is a nullable value type
IsProperty
bool
IsPublic
bool
IsValid
bool
MultipleProperties
IEnumerable`1
Get all properties if this holds multiple values
Name
string
NullableType
Type
If this is a nullable type, this will return the nullable target type
OnChanged
PropertyChangedDelegate
Called when the property value has changed.
OnFinishEdit
PropertyFinishEditDelegate
Called when the property has finished being edited (eg. in a ControlWidget).
OnPreChange
PropertyPreChangeDelegate
Called when the property value is about to change.
OnStartEdit
PropertyStartEditDelegate
Called when the property is about to be edited (eg. in a ControlWidget).
Order
int
Parent
SerializedObject
PropertyType
Type
SourceFile
string
The source filename, if available
SourceLine
int
The line in the source file, if available
functions
Methods
17
GetAttributes
(
)
IEnumerable`1
Get all of these attributes from the property.
GetCustomizable
(
)
CustomizableSerializedProperty
Return a version of this property that can be customized for editor UI. You'll be able to change things like display name and tooltip, and add extra attributes that control how editor controls interact with it.
GetDefault
(
)
object
Get the default value of a specific property type.
GetKey
(
)
SerializedProperty
If this entry is a dictionary, we can get the key for it here
GetValue
(
defaultValue
)
T
HasAttribute
(
)
bool
Return true if the property has this attribute
Invoke
(
)
If is method
NoteChanged
(
)
Our value has changed, maybe our parent would like to know
NoteFinishEdit
(
)
NotePreChange
(
)
NoteStartEdit
(
)
SetNullState
(
isnull
)
If this is a nullable type, you can use this to toggle between it being null or the default value type
SetValue
(
value
)
ShouldShow
(
)
bool
Returns true if this property should be shown in the inspector
TryGetAsObject
(
obj
)
bool
Try to convert this property into a serialized object for further editing and exploration
TryGetAttribute
(
attribute
)
bool
Try to get this attribute from the property. Return false on fail.
ValueToType
(
value
,
defaultValue
)
T
Convert an object value to a T type
functions
Static Methods
3
Create
(
title
,
get
,
set
,
attributes
)
obsolete
SerializedProperty
FindPathInScene
(
prop
)
PropertyPath
Tries to find the path from a Sandbox.GameObject or Sandbox.Component to this property. Returns
if not found.
GetContainingGameObject
(
prop
)
GameObject
Tries to find the Sandbox.GameObject that contains the given property. Returns
if not found.
Inheritance
SerializedProperty
Proxy
CustomizableSerializedProperty
people
Log in to reply
You can't reply if you're not logged in. That would be crazy.