Project Astrum

Project Astrum

  • Installation

›API

Getting Started

  • Installation
  • Configuration
  • Usage
  • Demonstration
  • Browser Support

Guides

  • Framework
  • VirtualElements Guide
  • Quirks

API

  • AstrumClient (Actor Component)
  • AstrumPlayerControllerBase (PlayerController)
  • AstrumPlayerCharacter (Actor)
  • VirtualElement (Object)
  • VirtualButton (VirtualElement)
  • VirtualAnalogue (VirtualElement)
  • VirtualText (VirtualElement)
  • VirtualImage (VirtualElement)

Enumerations

  • AstrumEnumHUDHorizonalAlignment (Enumeration)
  • AstrumEnumHUDVerticalAlignment (Enumeration)
  • AstrumEnumEventRecipient (Enumeration)

References

  • Software Used

VirtualElement (Object)

VirtualElement

Parent - Object


NameTypeDescription
Element IdIntegerAn unique identifier that can be used to update and remove HUD elements.
X PositionFloatThe position of this HUD element on the X axis.
Y PositionFloatThe position of this HUD element on the Y axis.
HiddenBooleanWhether this HUD element will be hidden or not.
RelativeBooleanIf relative is true, "X Position" and "Y Position" should take a normalised and relative to device screen size (0-1). If relative is false,"X Position" and "Y Position" represents the pixel location.

Study this diagram to determine the difference between absolute and relative positioning. Relative vs Absolute Diagram

← AstrumPlayerCharacter (Actor)VirtualButton (VirtualElement) →
  • VirtualElement
Project Astrum
Docs
Getting StartedDocsTips
This is a academic project run by William Stansfield-Tyler (U1555999@unimail.hud.ac.uk)