Corgi Engine v9.3
Public Types | Public Attributes | Protected Member Functions | List of all members
MoreMountains.Tools.MMPlatformActivation Class Reference

Add this class to a gameobject, and it'll enable/disable it based on platform context, using conditional defintions to do so More...

Inheritance diagram for MoreMountains.Tools.MMPlatformActivation:

Public Types

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

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...
 
PlatformActions UNITY_STANDALONE_WIN = PlatformActions.DoNothing
 whether or not this gameobject should be active on Windows More...
 
PlatformActions UNITY_STANDALONE_OSX = PlatformActions.DoNothing
 whether or not this gameobject should be active on OSX More...
 
PlatformActions UNITY_STANDALONE_LINUX = PlatformActions.DoNothing
 whether or not this gameobject should be active on Linux More...
 
PlatformActions UNITY_STANDALONE = PlatformActions.DoNothing
 whether or not this gameobject should be active on standalone More...
 
PlatformActions UNITY_IOS = PlatformActions.DoNothing
 whether or not this gameobject should be active on iOS More...
 
PlatformActions UNITY_IPHONE = PlatformActions.DoNothing
 whether or not this gameobject should be active on iPhone More...
 
PlatformActions UNITY_ANDROID = PlatformActions.DoNothing
 whether or not this gameobject should be active on Android More...
 
PlatformActions UNITY_TIZEN = PlatformActions.DoNothing
 whether or not this gameobject should be active on Tizen More...
 
PlatformActions UNITY_WII = PlatformActions.DoNothing
 whether or not this gameobject should be active on Wii More...
 
PlatformActions UNITY_PS4 = PlatformActions.DoNothing
 whether or not this gameobject should be active on PS4 More...
 
PlatformActions UNITY_XBOXONE = PlatformActions.DoNothing
 whether or not this gameobject should be active on XBoxOne More...
 
PlatformActions UNITY_WEBGL = PlatformActions.DoNothing
 whether or not this gameobject should be active on WebGL More...
 
PlatformActions UNITY_LUMIN = PlatformActions.DoNothing
 whether or not this gameobject should be active on Lumin More...
 
PlatformActions UNITY_TVOS = PlatformActions.DoNothing
 whether or not this gameobject should be active on TVOS More...
 
PlatformActions UNITY_WSA = PlatformActions.DoNothing
 whether or not this gameobject should be active on WSA More...
 
PlatformActions UNITY_FACEBOOK = PlatformActions.DoNothing
 whether or not this gameobject should be active on Facebook More...
 
PlatformActions UNITY_ADS = PlatformActions.DoNothing
 whether or not this gameobject should be active on Ads More...
 
PlatformActions UNITY_ANALYTICS = PlatformActions.DoNothing
 whether or not this gameobject should be active on Analytics More...
 
PlatformActions UNITY_EDITOR = PlatformActions.DoNothing
 whether or not this gameobject should be active in Editor More...
 
PlatformActions UNITY_EDITOR_WIN = PlatformActions.DoNothing
 whether or not this gameobject should be active in Editor on Windows More...
 
PlatformActions UNITY_EDITOR_OSX = PlatformActions.DoNothing
 whether or not this gameobject should be active in Editor on OSX More...
 
PlatformActions UNITY_EDITOR_LINUX = PlatformActions.DoNothing
 whether or not this gameobject should be active in Editor on Linux More...
 

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 (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 conditional defintions to do so

Member Enumeration Documentation

◆ ExecutionTimes

enum MoreMountains.Tools.MMPlatformActivation.ExecutionTimes

the possible times at which this script can run

Enumerator
Awake 
Start 
OnEnable 

◆ PlatformActions

enum MoreMountains.Tools.MMPlatformActivation.PlatformActions
Enumerator
DoNothing 
Disable 

Member Function Documentation

◆ Awake()

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

On Awake, processes the state if needed

◆ DisableIfNeeded()

virtual void MoreMountains.Tools.MMPlatformActivation.DisableIfNeeded ( 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.MMPlatformActivation.OnEnable ( )
protectedvirtual

On Enable, processes the state if needed

◆ Process()

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

Enables or disables the object based on current platform

◆ Start()

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

On Start, processes the state if needed

Member Data Documentation

◆ DebugToTheConsole

bool MoreMountains.Tools.MMPlatformActivation.DebugToTheConsole = false

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

◆ ExecutionTime

ExecutionTimes MoreMountains.Tools.MMPlatformActivation.ExecutionTime = ExecutionTimes.Awake

the selected execution time

◆ UNITY_ADS

PlatformActions MoreMountains.Tools.MMPlatformActivation.UNITY_ADS = PlatformActions.DoNothing

whether or not this gameobject should be active on Ads

◆ UNITY_ANALYTICS

PlatformActions MoreMountains.Tools.MMPlatformActivation.UNITY_ANALYTICS = PlatformActions.DoNothing

whether or not this gameobject should be active on Analytics

◆ UNITY_ANDROID

PlatformActions MoreMountains.Tools.MMPlatformActivation.UNITY_ANDROID = PlatformActions.DoNothing

whether or not this gameobject should be active on Android

◆ UNITY_EDITOR

PlatformActions MoreMountains.Tools.MMPlatformActivation.UNITY_EDITOR = PlatformActions.DoNothing

whether or not this gameobject should be active in Editor

◆ UNITY_EDITOR_LINUX

PlatformActions MoreMountains.Tools.MMPlatformActivation.UNITY_EDITOR_LINUX = PlatformActions.DoNothing

whether or not this gameobject should be active in Editor on Linux

◆ UNITY_EDITOR_OSX

PlatformActions MoreMountains.Tools.MMPlatformActivation.UNITY_EDITOR_OSX = PlatformActions.DoNothing

whether or not this gameobject should be active in Editor on OSX

◆ UNITY_EDITOR_WIN

PlatformActions MoreMountains.Tools.MMPlatformActivation.UNITY_EDITOR_WIN = PlatformActions.DoNothing

whether or not this gameobject should be active in Editor on Windows

◆ UNITY_FACEBOOK

PlatformActions MoreMountains.Tools.MMPlatformActivation.UNITY_FACEBOOK = PlatformActions.DoNothing

whether or not this gameobject should be active on Facebook

◆ UNITY_IOS

PlatformActions MoreMountains.Tools.MMPlatformActivation.UNITY_IOS = PlatformActions.DoNothing

whether or not this gameobject should be active on iOS

◆ UNITY_IPHONE

PlatformActions MoreMountains.Tools.MMPlatformActivation.UNITY_IPHONE = PlatformActions.DoNothing

whether or not this gameobject should be active on iPhone

◆ UNITY_LUMIN

PlatformActions MoreMountains.Tools.MMPlatformActivation.UNITY_LUMIN = PlatformActions.DoNothing

whether or not this gameobject should be active on Lumin

◆ UNITY_PS4

PlatformActions MoreMountains.Tools.MMPlatformActivation.UNITY_PS4 = PlatformActions.DoNothing

whether or not this gameobject should be active on PS4

◆ UNITY_STANDALONE

PlatformActions MoreMountains.Tools.MMPlatformActivation.UNITY_STANDALONE = PlatformActions.DoNothing

whether or not this gameobject should be active on standalone

◆ UNITY_STANDALONE_LINUX

PlatformActions MoreMountains.Tools.MMPlatformActivation.UNITY_STANDALONE_LINUX = PlatformActions.DoNothing

whether or not this gameobject should be active on Linux

◆ UNITY_STANDALONE_OSX

PlatformActions MoreMountains.Tools.MMPlatformActivation.UNITY_STANDALONE_OSX = PlatformActions.DoNothing

whether or not this gameobject should be active on OSX

◆ UNITY_STANDALONE_WIN

PlatformActions MoreMountains.Tools.MMPlatformActivation.UNITY_STANDALONE_WIN = PlatformActions.DoNothing

whether or not this gameobject should be active on Windows

◆ UNITY_TIZEN

PlatformActions MoreMountains.Tools.MMPlatformActivation.UNITY_TIZEN = PlatformActions.DoNothing

whether or not this gameobject should be active on Tizen

◆ UNITY_TVOS

PlatformActions MoreMountains.Tools.MMPlatformActivation.UNITY_TVOS = PlatformActions.DoNothing

whether or not this gameobject should be active on TVOS

◆ UNITY_WEBGL

PlatformActions MoreMountains.Tools.MMPlatformActivation.UNITY_WEBGL = PlatformActions.DoNothing

whether or not this gameobject should be active on WebGL

◆ UNITY_WII

PlatformActions MoreMountains.Tools.MMPlatformActivation.UNITY_WII = PlatformActions.DoNothing

whether or not this gameobject should be active on Wii

◆ UNITY_WSA

PlatformActions MoreMountains.Tools.MMPlatformActivation.UNITY_WSA = PlatformActions.DoNothing

whether or not this gameobject should be active on WSA

◆ UNITY_XBOXONE

PlatformActions MoreMountains.Tools.MMPlatformActivation.UNITY_XBOXONE = PlatformActions.DoNothing

whether or not this gameobject should be active on XBoxOne

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