Download Download
UI and Cursors
UI Elements, menu flow and overlays

UI Elements in Blender

  • Marking an object as a UI Element tells FPE that the object can be used as a UI Option (menu element) or as a UI Cursor.
  • Keep UI meshes inside the camera view in Blender; the exporter does not reposition them for you. Place them where you want them to appear on-screen.
  • Use planes or simple meshes for cursors or buttons and keep their scale small so they remain manageable.

UI Cursors

  • The engine captures the mouse when gameplay starts, showing your cursor if one was exported as a UI Cursor.
  • When you use a UI Cursor the mouse automatically unlocks and allows free instead of keeping it in the center of the screen. Closing the menu re-locks the mouse and returns to the game cursor state.

UI Options

  • UI Options are objects that can be cycled through with UI interaction Inputs and a UI Cursor.
  • UI Options are Triggers and are primarily used with the Interaction Trigger Type.
  • UI Options can also be used with other Trigger Types like Enter and Exit to create effects like button sounds and animations.