Component:RefEditor: Difference between revisions

From Resonite Wiki
Automated: create new component page
 
Add info
 
Line 4: Line 4:
}}
}}
{{stub}}
{{stub}}
A ref editor is used internally by [[Inspector|inspectors]] to show the human readable name of any [[Type:IWorldElement|IWorldElement]]. Whenever you are looking at a field and see a text like "Enabled on ObjectRoot on ComponentHolder", that description is generated by this component. This can be used to identify fields in the process of [[Ref Hacking]] which is one of the [[Things to Avoid]]


== Usage ==
== Usage ==
{{Table ComponentFields
{{Table ComponentFields
|_targetRef|{{RootFieldType|RelayRef`1|[[Type:ISyncRef|ISyncRef]]}}|TypeAdv0=true|
|_targetRef|{{RootFieldType|RelayRef`1|[[Type:ISyncRef|ISyncRef]]}}|TypeAdv0=true| The reference to generate a short description for
|_textDrive|{{RootFieldType|FieldDrive`1|[[Type:String|String]]}}|TypeAdv1=true|
|_textDrive|{{RootFieldType|FieldDrive`1|[[Type:String|String]]}}|TypeAdv1=true| The text to fill with the short description of <code>_targetRef</code>
|_button|'''[[Component:Button|Button]]'''|TypeAdv2=true|
|_button|'''[[Component:Button|Button]]'''|TypeAdv2=true| The button that allows for setting the field of <code>_targetRef</code> when clicked.
}}
}}


== Behavior ==
== Behavior ==
Button is not required for the <code>_textDrive</code> to fill with the description of <code>_targetRef</code>


== Examples ==
== Examples ==
Used internally by inspectors.


== See Also ==
== See Also ==
Line 20: Line 23:
[[Category:Components:Uncategorized{{#translation:}}|Ref Editor]]
[[Category:Components:Uncategorized{{#translation:}}|Ref Editor]]
[[Category:Components{{#translation:}}|Ref Editor]]
[[Category:Components{{#translation:}}|Ref Editor]]
[[Category:ComponentStubs]]

Latest revision as of 16:09, 18 October 2024

Component image 
Ref Editor component as seen in the Scene Inspector


This article or section is a Stub. You can help the Resonite Wiki by expanding it.


A ref editor is used internally by inspectors to show the human readable name of any IWorldElement. Whenever you are looking at a field and see a text like "Enabled on ObjectRoot on ComponentHolder", that description is generated by this component. This can be used to identify fields in the process of Ref Hacking which is one of the Things to Avoid

Usage

Fields
Name Type Description
persistent Bool Determines whether or not this item will be saved to the server.
UpdateOrder Int Controls the order in which this component is updated.
Enabled Bool Controls whether or not this component is enabled.
_targetRef direct RelayRef`1<ISyncRef> The reference to generate a short description for
_textDrive field drive of String The text to fill with the short description of _targetRef
_button Button The button that allows for setting the field of _targetRef when clicked.

Behavior

Button is not required for the _textDrive to fill with the description of _targetRef

Examples

Used internally by inspectors.

See Also