Component:RefEditor: Difference between revisions

From Resonite Wiki
Automated: update SyncDelegates
clean and add sync delegate desc
 
Line 3: Line 3:
|Name=Ref Editor
|Name=Ref Editor
}}
}}
{{stub}}
The '''RefEditor''' component 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]]
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 ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|_targetRef|{{RootFieldType|RelayRef`1|[[Type:ISyncRef|ISyncRef]]}}|TypeAdv0=true| The reference to generate a short description for
|_targetRef|{{RootFieldType|RelayRef`1|[[Type:ISyncRef|ISyncRef]]}}|TypeAdv0=true| The reference to generate a short description for
Line 15: Line 14:
== Sync Delegates ==
== Sync Delegates ==
{{Table ComponentTriggers
{{Table ComponentTriggers
|RemovePressed:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true|
|RemovePressed:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| Called when the removed button is touched.
|OpenInspectorButton:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true|
|OpenInspectorButton:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| Called when the open inspector button is touched.
|OpenWorkerInspectorButton:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true|
|OpenWorkerInspectorButton:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| Called when the open worker inspector (single component inspector) button is touched.
|SetReference:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true|
|SetReference:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| Called when the set reference button is touched.
}}
}}


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



Latest revision as of 21:47, 7 April 2025

Component image 
Ref Editor component as seen in the Scene Inspector

The RefEditor component 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

Fields

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. Some components stop their functionality when this field is disabled, but some don't.
_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.

Sync Delegates

Triggers
Method Name Method type and Arguments. Is the method hidden? Description
RemovePressed:ButtonEventHandler ButtonEventHandler Called when the removed button is touched.
OpenInspectorButton:ButtonEventHandler ButtonEventHandler Called when the open inspector button is touched.
OpenWorkerInspectorButton:ButtonEventHandler ButtonEventHandler Called when the open worker inspector (single component inspector) button is touched.
SetReference:ButtonEventHandler ButtonEventHandler Called when the set reference button is touched.

Usage

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

Examples

Used internally by inspectors.

See Also