UxrControllerInput.StartControllerElementsBlinking Method

Starts blinking one or more elements in a controller. This can be useful during tutorials to highlight which button(s) to press.

Namespace: UltimateXR.Devices
Assembly: UltimateXR (in UltimateXR.dll) Version: 0.0.0.0

Syntax

C#

public void StartControllerElementsBlinking(
	UxrHandSide handSide,
	UxrControllerElements controllerElements,
	Color emissionColor,
	float blinksPerSec = 3f,
	float durationSeconds = -1f
)

Parameters

 

handSide
Type: UltimateXR.Core.UxrHandSide
Which controller. In Single devices where IsHandednessSupported is false, such as in gamepads, both hands will address the single device.
controllerElements
Type: UltimateXR.Devices.UxrControllerElements
Element (or elements using flags) that should blink
emissionColor
Type: Color
Emission color use to blink. Usually it can be set to white with a mid alpha value to avoid too much brightness
blinksPerSec (Optional)
Type: System.Single
Blinks per second
durationSeconds (Optional)
Type: System.Single
Duration in seconds that it should blink

Implements

IUxrControllerInput.StartControllerElementsBlinking(UxrHandSide, UxrControllerElements, Color, Single, Single)

See Also

Reference

UxrControllerInput Class
UltimateXR.Devices Namespace
IUxrControllerInput.GetControllerElementsGameObjects(UxrHandSide, UxrControllerElements)
IUxrControllerInput.StopControllerElementsBlinking(UxrHandSide, UxrControllerElements)
IUxrControllerInput.StopAllBlinking(UxrHandSide)
IUxrControllerInput.IsAnyControllerElementBlinking(UxrHandSide, UxrControllerElements)
IUxrControllerInput.AreAllControllerElementsBlinking(UxrHandSide, UxrControllerElements)