Skip to main content

VpsCoachingOverlay.configure()

VpsCoachingOverlay.configure({ wayspotName, hintImage, animationColor, animationDuration, textColor, promptPrefix, promptSuffix, statusText, disablePrompt })

Description

Configures behavior and look of the Lightship VPS Coaching Overlay.

Parameters (All Optional)

ParameterTypeDefaultDescription
wayspotNameStringThe name of the Wayspot which the Coaching Overlay is guiding the user to localize at. If no Wayspot name is specified, it will use the nearest Project Wayspot. If the project does not have any Project Wayspots, then it will use the nearest wayspot.
hintImageStringImage displayed to the user to guide them to the real-world location. If no hint-image is specified, it will use the default image for the Wayspot. If the Wayspot does not have a default image, no image will be shown.
animationColorString'#ffffff'Color of the Coaching Overlay animation. This parameter accepts valid CSS color arguments.
animationDurationNumber5000Total time the hint image is displayed before shrinking (in milliseconds).
textColorString'#ffffff'Color of all the Coaching Overlay text. This parameter accepts valid CSS color arguments.
promptPrefixString'Point your camera at'Sets the text string for advised user action above the name of the Wayspot.
promptSuffixString'and move around'Sets the text string for advised user action below the name of the Wayspot.
statusTextString'Scanning...'Sets the text string that is displayed below the hint-image when it is in the shrunken state.
disablePromptBooleanfalseSet to true to hide default Coaching Overlay in order to use Coaching Overlay events for a custom overlay.

Returns

None

Example - Code

VpsCoachingOverlay.configure({
textColor: '#0000FF',
promptPrefix: 'Go look for',
})