Component:ValueField: Difference between revisions

Revision as of 05:09, 13 January 2024

The ValueField component contains a single field of a specific datatype that is selected when the component is attached.

Component image

**Value Field`1** component as seen in the Scene Inspector

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.
`Value`	Int

Usage

The ValueField component can be used to store a single value on a slot that can be edited from the inspector, or with other components and ProtoFlux. However, in cases where you want to be able to dynamically reference the value instead of directly referencing it, you may be better off using a dynamic variable, and in use cases where you want to easily reference and edit a value within a ProtoFlux script while still exposing that value to the data model, you may want to use the DataModelStore node.

Examples

A ValueField could be used when another component requires an input of an external value.

Related Components

</translate>

@@ Line 1: / Line 1: @@
-<languages></languages>
+The ValueField component contains a single field of a specific datatype that is selected when the component is attached.
-<translate>
-<!--T:1-->
-{{stub}}
 {{Infobox Component
 |Image=ValueField`1Component.png
@@ Line 16: / Line 13: @@
 <!--T:3-->
 == Usage ==
+The ValueField component can be used to store a single value on a slot that can be edited from the [[Scene Inspector|inspector]], or with other [[components]] and [[ProtoFlux]]. However, in cases where you want to be able to dynamically reference the value instead of directly referencing it, you may be better off using a [[DynamicValueVariable`1 (Component)|dynamic variable]], and in use cases where you want to easily reference and edit a value within a [[ProtoFlux]] script while still exposing that value to the data model, you may want to use the [[DataModelStore]] node.<!--T:4-->
-<!--T:4-->
 == Examples ==
+[[File:Value Field Demo.png|thumb|A ValueField<floatQ> being used as the input of a ValueCopy<floatQ>]]
+A ValueField could be used when another [[Components|component]] requires an input of an external value. <!--T:5-->
-<!--T:5-->
 == Related Components ==
 </translate>