Platformer Pro  2.3.2
A platform game kit for Unity.
PlatformerPro.EscapeKeyHandler Class Reference

Because ESC very commonly pauses and/or exits it can be convenient to handle this separate to the input system. This class allows this (but you don't have to add it). More...

Inheritance diagram for PlatformerPro.EscapeKeyHandler:

Public Attributes

bool pauseFirst = true
 If this is true then escape will pause before exiting. Second press will either exit or unpause depending on 'escape when puased' setting. More...
 
string escapeWhenPausedScene
 If this is not empty then hitting escape while paused will load the provided scene. Otherwise it will unpause. More...
 

Detailed Description

Because ESC very commonly pauses and/or exits it can be convenient to handle this separate to the input system. This class allows this (but you don't have to add it).

Member Data Documentation

◆ escapeWhenPausedScene

string PlatformerPro.EscapeKeyHandler.escapeWhenPausedScene

If this is not empty then hitting escape while paused will load the provided scene. Otherwise it will unpause.

◆ pauseFirst

bool PlatformerPro.EscapeKeyHandler.pauseFirst = true

If this is true then escape will pause before exiting. Second press will either exit or unpause depending on 'escape when puased' setting.


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