Component:PhotoCaptureSettings: Difference between revisions

From Resonite Wiki
Automated: update Fields, SyncDelegates
add info
 
(2 intermediate revisions by 2 users not shown)
Line 3: Line 3:
|Name=Photo Capture Settings
|Name=Photo Capture Settings
}}
}}
{{stub}}
The '''PhotoCaptureSettings''' component is used to control the behavior of the [[Component:PhotoCaptureManager|PhotoCaptureManager]] and what it does.


== Usage ==
See [[Settings]].
 
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|FingerGestureEnabled|Bool|
|FingerGestureEnabled|Bool| Whether the finger photos should even render.
|NormalCaptureResolution|Int2|
|NormalCaptureResolution|Int2| The resolution of pictures taken without timer.
|TimerCaptureResolution|Int2|
|TimerCaptureResolution|Int2| The resolution of pictures taken with timer.
|TimerSeconds|Float|
|TimerSeconds|Float| How long the timer should be for timed photos.
|CapturePrivateUI|Bool|
|CapturePrivateUI|Bool| Whether finger photos should capture private ui elements like the dash.
|CaptureStereo|Bool|
|CaptureStereo|Bool| Whether photos should be 3D with a left and right "eye".
|StereoSeparation|Float|
|StereoSeparation|Float| how far apart the left and right "eye" are when taking stereo photos.
|AlwaysHideNameplates|Bool|
|AlwaysHideNameplates|Bool| Whether to always hide nameplates in taken photos.
|EncodeFormat|PhotoEncodeFormat|
|EncodeFormat|PhotoEncodeFormat| The format taken photos should output as.
|PhotoAutosavePath|String|
|PhotoAutosavePath|String| Where to auto save photos in the inventory to.
|AutosaveActive|Bool|
|AutosaveActive|Bool| Whether to use the auto save photos to inventory feature.
}}
}}


== Sync Delegates ==
== Sync Delegates ==
{{Table ComponentTriggers
{{Table ComponentTriggers
|OpenAutosavePath[[Type:Action|Action]]|[[Type:Action|Action]]|false|
|OpenAutosavePath:[[Type:Action|Action]]|[[Type:Action|Action]]|false| Opens the auto save path set in the settings.
}}
}}


== Behavior ==
== Usage ==


== Examples ==
== Examples ==


== See Also ==
== See Also ==
* [[Component:PhotoCaptureManager]]


[[Category:Components:Uncategorized{{#translation:}}|Photo Capture Settings]]
[[Category:Components:Uncategorized{{#translation:}}|Photo Capture Settings]]
[[Category:Components{{#translation:}}|Photo Capture Settings]]
[[Category:Components{{#translation:}}|Photo Capture Settings]]
[[Category:ComponentStubs]]

Latest revision as of 11:15, 5 July 2025

Component image 
Photo Capture Settings component as seen in the Scene Inspector

The PhotoCaptureSettings component is used to control the behavior of the PhotoCaptureManager and what it does.

See Settings.

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.
FingerGestureEnabled Bool Whether the finger photos should even render.
NormalCaptureResolution Int2 The resolution of pictures taken without timer.
TimerCaptureResolution Int2 The resolution of pictures taken with timer.
TimerSeconds Float How long the timer should be for timed photos.
CapturePrivateUI Bool Whether finger photos should capture private ui elements like the dash.
CaptureStereo Bool Whether photos should be 3D with a left and right "eye".
StereoSeparation Float how far apart the left and right "eye" are when taking stereo photos.
AlwaysHideNameplates Bool Whether to always hide nameplates in taken photos.
EncodeFormat PhotoEncodeFormat The format taken photos should output as.
PhotoAutosavePath String Where to auto save photos in the inventory to.
AutosaveActive Bool Whether to use the auto save photos to inventory feature.

Sync Delegates

Triggers
Method Name Method type and Arguments. Is the method hidden? Description
OpenAutosavePath:Action Action X Opens the auto save path set in the settings.

Usage

Examples

See Also