Component:GiggleTechSettings: Difference between revisions

← Older edit

VisualWikitext

Latest revision as of 22:13, 7 April 2025

Component image

File:GiggleTechSettingsComponent.png

Giggle Tech Settings component as seen in the Scene Inspector

The GiggleTechSettings Component is used to control different aspects of giggle pucks for use in Resonite.

See Settings for information.

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.
`Devices`	list of GiggleTechSettings.Device	A list of giggle pucks with settings for them.
`GigglePuckIP`	String	the IP address of the giggle puck.
`IsGigglePuckValid`	Bool	Whether the giggle puck is valid and tracking.

Device

Fields
Name	Type	Description
`IP`	String	The IP address of this device.
`IsConnected`	Bool	Whether this device is connected.
`UseDevice`	Bool	Whether to allow use and registration of this device.
`AlwaysTreatAsConnected`	Bool	Whether this puck should always be treated as connected even if it looses connection.
`CustomName`	String	A user defined name for this giggle puck.
`IntensityScale`	Float	The scaling for intensity.
`MinimumIntensity`	Float	The minimum intensity needed to activate this.
`InitialActivationIntensity`	Float	How strong the inital activation will be.
`HapticPointMapping`	direct HapticPointMapping	How this is mapped.
`HapticPointIndex`	Int	The index of this device in the list of haptic devices.

Sync Delegates

Triggers
Method Name	Method type and Arguments.	Is the method hidden?	Description
`RegisterGigglePuck:Action`	Action	X	Register a gigglepuck to the list
`GetDeviceForSubsetting:SubsettingGetter`	SubsettingGetter	X	Get one of the `Devices` by key.

Usage

See Settings for information.

Examples

See Settings for information.

@@ Line 4: / Line 4: @@
 }}
 The '''GiggleTechSettings''' Component is used to control different aspects of [https://giggletech.io/products/giggle_puck giggle pucks] for use in Resonite.
+See [[Settings]] for information.
 == Fields ==
 {{Table ComponentFields
-|Devices|{{RootFieldType|SyncList`1|[[#Device|Device]]}}|TypeAdv0=true| A list of giggle pucks with settings for them.
+|Devices|{{RootFieldType|SyncList`1|[[#Device|GiggleTechSettings.Device]]}}|TypeAdv0=true| A list of giggle pucks with settings for them.
-|GigglePuckIP|String|
+|GigglePuckIP|String| the IP address of the giggle puck.
-|IsGigglePuckValid|Bool|
+|IsGigglePuckValid|Bool| Whether the giggle puck is valid and tracking.
 }}
@@ Line 28: / Line 30: @@
 == Sync Delegates ==
 {{Table ComponentTriggers
-|RegisterGigglePuck()|[[Type:Action|Action]] -> [[Type:Void|Void]]| Register a gigglepuck to the list
+|RegisterGigglePuck:[[Type:Action|Action]]|[[Type:Action|Action]]|false| Register a gigglepuck to the list
-|GetDeviceForSubsetting(string)|[[Type:SubsettingGetter|SubsettingGetter]]&lt;[[Type:String|String]]: key&gt; -> [[Type:SyncObject|SyncObject]]| Get the settings of a subsetting. usually one of the <code>Devices</code> in this case.
+|GetDeviceForSubsetting:[[Type:SubsettingGetter|SubsettingGetter]]|[[Type:SubsettingGetter|SubsettingGetter]]|false| Get one of the <code>Devices</code> by key.
 }}
 == Usage ==
+See [[Settings]] for information.
 == Examples ==
+See [[Settings]] for information.
 == See Also ==
 * [[Component:SettingsFacetPreset]]
+* [[Settings]]
 [[Category:Components:Uncategorized{{#translation:}}|Giggle Tech Settings]]
 [[Category:Components{{#translation:}}|Giggle Tech Settings]]
 [[Category:Components With Nested Types{{#translation:}}|Giggle Tech Settings]]