Skip to content

PlatformProvider

Inherits: Resource

Base class that defines a particular platform

Description

A "platform" can be a particular set of hardware (i.e. a handheld PC), an OS platform, etc. Anything that requires special consideration for OpenGamepadUI to run correctly.

Properties

Type Name Default
String name
PlatformAction[] startup_actions
PlatformAction[] shutdown_actions
CustomLogger logger

Methods

Returns Signature
void ready(root: Window)

Property Descriptions

name

String name

Name of the platform

startup_actions

PlatformAction[] startup_actions

Actions to take upon startup

shutdown_actions

PlatformAction[] shutdown_actions

Actions to take upon shutdown

logger

CustomLogger logger

Note

There is currently no description for this property. Please help us by contributing one!


Method Descriptions

ready()

void ready(root: Window)

Ready will be called after the scene tree has initialized. This should be overridden in the child class if the platform wants to make changes to the scene tree.