Component:ReflectionProbeWizard: Difference between revisions

From Resonite Wiki
Automated: update SyncDelegates
add info
 
Line 3: Line 3:
|Name=Reflection Probe Wizard
|Name=Reflection Probe Wizard
}}
}}
{{stub}}
See [[Reflection Probe Wizard]] for more up to date info


== Usage ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|Root|Slot|
|Root|Slot| The root slot in which all probes in it's hierarchy should be baked.
|ProcessDisabled|Bool|
|ProcessDisabled|Bool| Whether to bake probes in disabled hierarchies.
|TeleportUserToProbe|Bool|
|TeleportUserToProbe|Bool| Whether to teleport the user to the probe before baking.
|_tag|'''[[Component:TextField|TextField]]'''|TypeAdv3=true|
|_tag|'''[[Component:TextField|TextField]]'''|TypeAdv3=true| Probes only with this tag will be baked.
|_delayBetweenProbes|'''[[Component:FloatTextEditorParser|FloatTextEditorParser]]'''|TypeAdv4=true|
|_delayBetweenProbes|'''[[Component:FloatTextEditorParser|FloatTextEditorParser]]'''|TypeAdv4=true| How long to wait between baking probes.
|_bakeCount|Int|
|_bakeCount|Int| The number of probes baked
|_bakeIndex|Int|
|_bakeIndex|Int| The current probe being baked.
}}
}}


== Sync Delegates ==
== Sync Delegates ==
{{Table ComponentTriggers
{{Table ComponentTriggers
|OnShowDebugVisuals:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true|
|OnShowDebugVisuals:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| Called when the show debug visuals button is touched.
|OnHideDebugVisuals:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true|
|OnHideDebugVisuals:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| Called when the hide debug visuals button is touched.
|OnBakeAll:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true|
|OnBakeAll:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| Called when the bake all button is touched.
}}
}}


== Behavior ==
== Usage ==
See [[Reflection Probe Wizard]].


== Examples ==
== Examples ==
See [[Reflection Probe Wizard]].


== See Also ==
== See Also ==
* [[Reflection Probe Wizard]]


[[Category:Components:Uncategorized{{#translation:}}|Reflection Probe Wizard]]
[[Category:Components:Uncategorized{{#translation:}}|Reflection Probe Wizard]]
[[Category:Components{{#translation:}}|Reflection Probe Wizard]]
[[Category:Components{{#translation:}}|Reflection Probe Wizard]]
[[Category:ComponentStubs]]

Latest revision as of 21:57, 7 April 2025

Component image 
Reflection Probe Wizard component as seen in the Scene Inspector

See Reflection Probe Wizard for more up to date info

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.
Root Slot The root slot in which all probes in it's hierarchy should be baked.
ProcessDisabled Bool Whether to bake probes in disabled hierarchies.
TeleportUserToProbe Bool Whether to teleport the user to the probe before baking.
_tag TextField Probes only with this tag will be baked.
_delayBetweenProbes FloatTextEditorParser How long to wait between baking probes.
_bakeCount Int The number of probes baked
_bakeIndex Int The current probe being baked.

Sync Delegates

Triggers
Method Name Method type and Arguments. Is the method hidden? Description
OnShowDebugVisuals:ButtonEventHandler ButtonEventHandler Called when the show debug visuals button is touched.
OnHideDebugVisuals:ButtonEventHandler ButtonEventHandler Called when the hide debug visuals button is touched.
OnBakeAll:ButtonEventHandler ButtonEventHandler Called when the bake all button is touched.

Usage

See Reflection Probe Wizard.

Examples

See Reflection Probe Wizard.

See Also