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

AstrumPlayerControllerBase (PlayerController)

AstrumPlayerControllerBase

Parent - PlayerController


New VirtualController Input (method)

New VirtualController Input on both X and Y axis.

Inputs

NameTypeDescription
VirtualElement IdIntegerID of the VirtualElement that was interacted with.
Controller X AxisFloatNew X axis input.
Controller Y AxisFloatNew Y axis input.

Outputs

No outputs.


New VirtualButton Input (method)

New VirtualController Input on both X and Y axis.

Inputs

NameTypeDescription
VirtualElement IdIntegerID of the VirtualElement that was interacted with.
EventEnum_Astrum_HUD_Virtual_Button_EventsEvent that occured (pressed \ released).

Outputs

No outputs.


Destroy (method)

Interface for developers to add custom logic to "destroy" of character actor.

Inputs

No inputs.

Outputs

No outputs.

← AstrumClient (Actor Component)AstrumPlayerCharacter (Actor) →
  • AstrumPlayerControllerBase
  • New VirtualController Input (method)
    • Inputs
    • Outputs
  • New VirtualButton Input (method)
    • Inputs
    • Outputs
  • Destroy (method)
    • Inputs
    • Outputs
Project Astrum
Docs
Getting StartedDocsTips
This is a academic project run by William Stansfield-Tyler (U1555999@unimail.hud.ac.uk)