Documentation

Blueprints

Oculus Blueprints are available for developer use.

Gear VR

To access Blueprints for Gear VR, you must enable the Gear VR plugin in Edit > Plugins > Virtual Reality.

The following Blueprints under the Gear VR class are provided to assist with mobile development:

  • Are Head Phones Plugged In - returns bool
  • Get Battery Level - returns float
  • Get Temperature in Celsius - returns float
  • Is Power Level State Minimum - returns bool
  • Is Power Level State Throttled - returns bool
  • Set CPU And GPU Levels - passes floats to Gear VR Function Library

Oculus Rift

To access these Blueprints, you must enable the Online Subsystem Oculus in Edit > Plugin > Online Platform.

The following Blueprints are available for Rift development:

  • Add Oculus Rift Boundary Component - Creates a new Guardian System boundary component and assigns ownership of it to an actor.
  • Cast to Oculus Rift Boundary Component
  • Cast to Oculus Rift Boundary Component Class

Oculus Rift Input

To access these Blueprints, you must enable the Online Subsystem Oculus in Edit > Plugin > Online Platform.

  • Gamepad events
    • return Oculus Remote button events (bool)
    • return Oculus Touch button events (bool)
  • Gamepad Values - return Oculus Touch values (floats)
  • Oculus Library - provides a number of Blueprints for querying and controlling splash screen, HMD pose, loading icon, user profile, raw sensor data, position scale, and more.

Oculus Touch

The following Blueprints are not Oculus-specific, but may be used to control haptics for the Xbox or Oculus Touch controllers. For detailed information, see Haptics for Rift Controllers

  • Play Haptic Effect
  • Stop Haptic Effect
  • Set Haptics by Value
  • Play Haptic Soundwave

Platform

To access these Blueprints, you must enable the Online Subsystem Oculus in Edit > Plugin > Online Platform.

  • Verify Entitlements - verifies the user is authorized to run the application.
  • Get Oculus Identity - returns Oculus ID and Oculus username as strings; provides flow control for On Success/On Failure

In this simple example of the Verify Entitlement Blueprint, the application will verify that the user has an entitlement when the application launches, and quit if the check fails. In reality, we recommend providing an appropriate error message before shutting down.

This example of the Get Oculus Identity Blueprint illustrates how to print the user’s Oculus ID to the log or screen.

Loading…