Component:UserInterfaceEditModeSync: Difference between revisions

Latest revision as of 17:39, 6 February 2025

Component image

The UserInterfaceEditModeSync component allows a world to tell if a user is currently in edit mode.

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.
`TargetUser`	direct UserRef	The user to check edit mode for.
`EditModeActive`	Bool	Whether `TargetUser` is in edit mode.

Attach to a slot and either drive or set the values of the contained TargetUser to get an edit mode status.

Can be used to make world or item elements that should only be used in edit mode (basically super developer).

@@ Line 3: / Line 3: @@
 |Name=User Interface Edit Mode Sync
 }}
-{{stub}}
+The '''UserInterfaceEditModeSync''' component allows a world to tell if a user is currently in edit mode.
-== Usage ==
+== Fields ==
 {{Table ComponentFields
-|TargetUser|{{RootFieldType|UserRef}}|TypeAdv0=true|
+|TargetUser|{{RootFieldType|UserRef}}|TypeAdv0=true| The user to check edit mode for.
-|EditModeActive|Bool|
+|EditModeActive|Bool| Whether <code>TargetUser</code> is in edit mode.
 }}
-== Behavior ==
+== Usage ==
+Attach to a slot and either drive or set the values of the contained <code>TargetUser</code> to get an edit mode status.
 == Examples ==
+Can be used to make world or item elements that should only be used in edit mode (basically super developer).
 == See Also ==
+* [[Edit Mode]] what is edit mode?
 [[Category:Components:Utility{{#translation:}}|User Interface Edit Mode Sync]]
 [[Category:Components{{#translation:}}|User Interface Edit Mode Sync]]
-[[Category:ComponentStubs]]