Project Astrum

Project Astrum

  • Installation

›Guides

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

Quirks in Astrum Framework

Quirks

There are some intresting quirks to Astrum:



OnVirtualControllerUpdate vs Tick

To save on network bandwidth, Astrum Clients emit "VirtualControllerUpdate" events every 30ms (0.03s).

Due to this, the "New VirtualController Input" event in the "AstrumInputInterface" interface is not suitable for Tick style character movement.

Solution

To eleviate this, devs should use the execution pin on the "Tick Event" node or an Input node instead of the execution pin off the "New VirtualController Input" event. (Image Ref)



Use of arrays in Astrum functions

Arrays are required for most of Astrum's functions (Image Ref)

This means that even when only one value is required, it will need to be transmitted via an array

Solution

Make use of Unreal's "make" node to create arrays for use with these functions (Blueprint Ref)



Images (via VirtualImage)

Images sent via VirtualImage to the mobile client can break if developers do not follow the following advice.

Solution

Images have a multitude of restrictions that must be followed to avoid engine crashes and mobile client bugs

  • Images MUST be in PNG format
  • Images CANNOT have the same width and height
  • Images SHOULD NOT be more than 1000px wide or height
← VirtualElements GuideAstrumClient (Actor Component) →
  • Quirks
    • OnVirtualControllerUpdate vs Tick
    • Use of arrays in Astrum functions
    • Images (via VirtualImage)
Project Astrum
Docs
Getting StartedDocsTips
This is a academic project run by William Stansfield-Tyler (U1555999@unimail.hud.ac.uk)