Component:RecordEditForm: Difference between revisions

Latest revision as of 03:09, 1 August 2025

Component image

**Record Edit Form** component as seen in the Scene Inspector

The RecordEditForm component is used to edit the details and info/metadata for a world.

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.
`_worldOrb`	WorldOrb	The world orb that created this dialog.
`_name`	TextField	The field to edit the name of the world.
`_description`	TextField	The field to edit the description of the world.
`_path`	TextField	The field to edit the path of the world.
`_tags`	TextField	The field to edit the tags of the world.
`_publicSetting`	RecordEditForm.PublicSetting	The field to edit the of the world.
`_readonly`	Checkbox	The checkbox to edit the read only property of the world.
`_ownerUser`	direct UserRef	The field to show the owner of the world.
`_privateOptionText`	Text	The field to show the private options of the world.

Sync Delegates

Triggers
Method Name	Method type and Arguments.	Is the method hidden?	Description
`OnCancel:ButtonEventHandler`	ButtonEventHandler	✓	Called when the cancel button is touched.
`OnSave:ButtonEventHandler`	ButtonEventHandler	✓	Called when the save button is touched.

Usage

See World.

Examples

See World.

@@ Line 3: / Line 3: @@
 |Name=Record Edit Form
 }}
-{{stub}}
+See [[World]].
-== Usage ==
+The '''RecordEditForm''' component is used to edit the details and info/metadata for a world.
+== Fields ==
 {{Table ComponentFields
-|_worldOrb|'''[[Component:WorldOrb|WorldOrb]]'''|TypeAdv0=true|
+|_worldOrb|'''[[Component:WorldOrb|WorldOrb]]'''|TypeAdv0=true| The world orb that created this dialog.
-|_name|'''[[Component:TextField|TextField]]'''|TypeAdv1=true|
+|_name|'''[[Component:TextField|TextField]]'''|TypeAdv1=true| The field to edit the name of the world.
-|_description|'''[[Component:TextField|TextField]]'''|TypeAdv2=true|
+|_description|'''[[Component:TextField|TextField]]'''|TypeAdv2=true| The field to edit the description of the world.
-|_path|'''[[Component:TextField|TextField]]'''|TypeAdv3=true|
+|_path|'''[[Component:TextField|TextField]]'''|TypeAdv3=true| The field to edit the path of the world.
-|_tags|'''[[Component:TextField|TextField]]'''|TypeAdv4=true|
+|_tags|'''[[Component:TextField|TextField]]'''|TypeAdv4=true| The field to edit the tags of the world.
-|_publicSetting|'''[[#PublicSetting|PublicSetting]]'''|TypeAdv5=true|
+|_publicSetting|'''[[#PublicSetting|RecordEditForm.PublicSetting]]'''|TypeAdv5=true| The field to edit the  of the world.
-|_ownerUser|{{RootFieldType|UserRef}}|TypeAdv6=true|
+|_readonly|'''[[Component:Checkbox|Checkbox]]'''|TypeAdv6=true| The checkbox to edit the read only property of the world.
-|_privateOptionText|'''[[Component:Text|Text]]'''|TypeAdv7=true|
+|_ownerUser|{{RootFieldType|UserRef}}|TypeAdv7=true| The field to show the owner of the world.
+|_privateOptionText|'''[[Component:Text|Text]]'''|TypeAdv8=true| The field to show the private options of the world.
 }}
-== Behavior ==
+== Sync Delegates ==
+{{Table ComponentTriggers
+|OnCancel:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| Called when the cancel button is touched.
+|OnSave:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| Called when the save button is touched.
+}}
+== Usage ==
+See [[World]].
 == Examples ==
+See [[World]].
 == See Also ==
+See [[World]].
 [[Category:Components:Uncategorized{{#translation:}}|Record Edit Form]]
 [[Category:Components{{#translation:}}|Record Edit Form]]
 [[Category:Components With Nested Enums{{#translation:}}|Record Edit Form]]
-[[Category:ComponentStubs]]