Component:PrimitiveMemberEditor: Difference between revisions

From Resonite Wiki
m fill in some information from memory, of course more needed but can't fill in without getting in resonite and verifying some info
still not all info but some more
Line 5: Line 5:
{{stub}}
{{stub}}


The [[Component:PrimitiveMemberEditor|PrimitiveMemberEditor]] component is a lower-level component for accessing and editing the members of a particular primitive element. Its intention is for use in UIX objects that use a text field to drive member properties, such as in [[Scene Inspector Dialog|Inspectors]].
The '''PrimitiveMemberEditor''' component is a lower-level component for accessing and editing the members of a particular primitive element. Its intention is for use in UIX objects that use a text field to drive member properties, such as in [[Scene Inspector Dialog|Inspectors]]. It is also, as indicated by a big warning on it, commonly used for [[Ref Hacking]].


== Usage ==
== Usage ==
Line 12: Line 12:
|_path|String|Member path of target element field to access/edit.
|_path|String|Member path of target element field to access/edit.
|_target|{{RootFieldType|RelayRef`1|[[Type:IField|IField]]}}|TypeAdv2=true|The primitive element to access/edit.
|_target|{{RootFieldType|RelayRef`1|[[Type:IField|IField]]}}|TypeAdv2=true|The primitive element to access/edit.
|Format|String|
|Format|String|The format for representing the target primitive. Same as the Format field for the [[ProtoFlux:To String|To String]] node, but only works on a limited set of primitives.
|_textEditor|'''[[Component:TextEditor|TextEditor]]'''|TypeAdv4=true|The TextEditor that points to the [[Component:Text|Text Component]] used for <code>_textDrive</code>.
|_textEditor|'''[[Component:TextEditor|TextEditor]]'''|TypeAdv4=true|The TextEditor that points to the [[Component:Text|Text Component]] used for <code>_textDrive</code>.
|_textDrive|{{RootFieldType|FieldDrive`1|[[Type:String|String]]}}|TypeAdv5=true|Text field used as an interface to the member. Should be the <code>Content</code> field of a [[Component:Text|Text Component]].
|_textDrive|{{RootFieldType|FieldDrive`1|[[Type:String|String]]}}|TypeAdv5=true|Text field used as an interface to the member. Should be the <code>Content</code> field of a [[Component:Text|Text Component]].
Line 20: Line 20:


== Behavior ==
== Behavior ==
This component needs, at minimum, <code>_target</code> to point to an element with fields, a <code>_textDrive</code> that points to the <code>Content</code> field of a Text component, and a <code>_textEditor</code> that points to a TextEditor with its <code>Text</code> field pointing to the to the aforementioned Text component.


== Examples ==
== Examples ==
Line 25: Line 27:
== See Also ==
== See Also ==
* [[Things_to_Avoid#Reference_IDs_/_"Ref_Hacking"]]
* [[Things_to_Avoid#Reference_IDs_/_"Ref_Hacking"]]
* [[Tutorial:Ref Hacking]]


[[Category:Components:Uncategorized{{#translation:}}|Primitive Member Editor]]
[[Category:Components:Uncategorized{{#translation:}}|Primitive Member Editor]]
[[Category:Components{{#translation:}}|Primitive Member Editor]]
[[Category:Components{{#translation:}}|Primitive Member Editor]]
[[Category:ComponentStubs]]
[[Category:ComponentStubs]]

Revision as of 06:58, 22 May 2024

Component image 
Primitive Member Editor component as seen in the Scene Inspector


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


The PrimitiveMemberEditor component is a lower-level component for accessing and editing the members of a particular primitive element. Its intention is for use in UIX objects that use a text field to drive member properties, such as in Inspectors. It is also, as indicated by a big warning on it, commonly used for Ref Hacking.

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.
Continuous Bool
_path String Member path of target element field to access/edit.
_target direct RelayRef`1<IField> The primitive element to access/edit.
Format String The format for representing the target primitive. Same as the Format field for the To String node, but only works on a limited set of primitives.
_textEditor TextEditor The TextEditor that points to the Text Component used for _textDrive.
_textDrive field drive of String Text field used as an interface to the member. Should be the Content field of a Text Component.
_button Button
_resetButton Button

Behavior

This component needs, at minimum, _target to point to an element with fields, a _textDrive that points to the Content field of a Text component, and a _textEditor that points to a TextEditor with its Text field pointing to the to the aforementioned Text component.

Examples

See Also