Highroad Engine v1.3
Public Types | Public Attributes | Protected Member Functions | List of all members
MoreMountains.Tools.MMApplicationPlatformActivation Class Reference

Add this class to a gameobject, and it'll enable/disable it based on platform context, using Application.platform to detect the platform More...

Inheritance diagram for MoreMountains.Tools.MMApplicationPlatformActivation:

Public Types

enum  ExecutionTimes { Awake , Start , OnEnable }
 the possible times at which this script can run More...
 

Public Attributes

ExecutionTimes ExecutionTime = ExecutionTimes.Awake
 the selected execution time More...
 
bool DebugToTheConsole = false
 whether or not this should output a debug line in the console More...
 
List< PlatformBindingsPlatforms
 

Protected Member Functions

virtual void OnEnable ()
 On Enable, processes the state if needed More...
 
virtual void Awake ()
 On Awake, processes the state if needed More...
 
virtual void Start ()
 On Start, processes the state if needed More...
 
virtual void Process ()
 Enables or disables the object based on current platform More...
 
virtual void DisableIfNeeded (PlatformBindings.PlatformActions platform, string platformName)
 Disables the object if needed, and outputs a debug log if requested More...
 

Detailed Description

Add this class to a gameobject, and it'll enable/disable it based on platform context, using Application.platform to detect the platform

Member Enumeration Documentation

◆ ExecutionTimes

the possible times at which this script can run

Enumerator
Awake 
Start 
OnEnable 

Member Function Documentation

◆ Awake()

virtual void MoreMountains.Tools.MMApplicationPlatformActivation.Awake ( )
protectedvirtual

On Awake, processes the state if needed

◆ DisableIfNeeded()

virtual void MoreMountains.Tools.MMApplicationPlatformActivation.DisableIfNeeded ( PlatformBindings.PlatformActions  platform,
string  platformName 
)
protectedvirtual

Disables the object if needed, and outputs a debug log if requested

Parameters
platform
platformName

◆ OnEnable()

virtual void MoreMountains.Tools.MMApplicationPlatformActivation.OnEnable ( )
protectedvirtual

On Enable, processes the state if needed

◆ Process()

virtual void MoreMountains.Tools.MMApplicationPlatformActivation.Process ( )
protectedvirtual

Enables or disables the object based on current platform

◆ Start()

virtual void MoreMountains.Tools.MMApplicationPlatformActivation.Start ( )
protectedvirtual

On Start, processes the state if needed

Member Data Documentation

◆ DebugToTheConsole

bool MoreMountains.Tools.MMApplicationPlatformActivation.DebugToTheConsole = false

whether or not this should output a debug line in the console

◆ ExecutionTime

ExecutionTimes MoreMountains.Tools.MMApplicationPlatformActivation.ExecutionTime = ExecutionTimes.Awake

the selected execution time

◆ Platforms

List<PlatformBindings> MoreMountains.Tools.MMApplicationPlatformActivation.Platforms

The documentation for this class was generated from the following file: