Platformer Pro  2.3.2
A platform game kit for Unity.
PlatformerPro.Extras Namespace Reference

Classes

class  FX_BaseInspector
 Editor for dash attacks. More...
 
class  FX_Base
 Base class for simple FX. More...
 
class  FX_DisableAfterDelay
 FX class which disables or deactivates things after a delay. More...
 
class  FX_FadeToColour
 FX class which fades colour of an object. More...
 
class  FX_Flash
 FX class which flashes a sprite by changing its colour. More...
 
class  FX_ImpartForce2D
 Simple FX class which adds a force to a rigidbody. More...
 
class  FX_MoveTo
 FX class which tweens position of a GameObject. More...
 
class  FX_Shake
 FX class which shakes something back and forth (usually a camera). More...
 
class  FX_SnapTo
 FX class which tweens position of a UI element. More...
 
class  FX_SpinningObject
 Simple FX class which spins an object a fixed amount in a fixed time. More...
 
class  FX_UIFadeToColour
 Simple FX class which sfdes colour of a UI object. More...
 
class  FX_UIMoveTo
 FX class which tweens position of a UI element. More...
 
interface  IValueRenderer
 Interface implemented by things taht draw a value provided by a UIValueProvider. More...
 
class  UIBreath_PercentageBar
 Scales an image bar based on the percentage of breath (current/max). More...
 
class  UICharge_PercentageBar
 Scales an image bar based on the percentage of health (current/max). More...
 
class  UICoolDownIcon
 A simple UI for showing a cool down. More...
 
class  UIDialog
 Displays a GameObject (which typically has text information in it). More...
 
class  UIDialogTyper
 Shows dialog by slowly revealing text with option to fast forward. More...
 
class  UIHealth_Icons
 Shows images based on health. More...
 
class  UIHealth_PercentageBar
 Scales an image bar based on the percentage of health (current/max). More...
 
class  UILevelStartScreen
 Displays some UI content on level start. More...
 
class  UIScore
 Shows score in a text field. More...
 
class  UIStackable_PercentageBar
 Scales an image bar based on the percentage of a stackable item (current/max). More...
 
class  UITimer
 Shows score in a text field. More...
 
class  UIEnemyHealthValueProvider
 Provides the enemy health value for rendering by IValueRenderer components. More...
 
class  UIGameOverScreen
 Displays some UI content when a players game ends. More...
 
class  UIHealthValueProvider
 Provides the health value for rendering by IValueRenderer components. More...
 
class  UIIconRenderer
 Renders a UI value provider as icons. More...
 
class  UIItemCountValueProvider
 Provides the count of an item as a value for rendering by IValueRenderer components. More...
 
class  UILivesValueProvider
 Provides the lives value for rendering by IValueRenderer components. More...
 
class  UIPercentageBarRenderer
 Renders a UI value provider as a percentage amount using the fill amount or sizeDelta(in x) of an image. More...
 
class  UIStackableItemCounter
 Shows count of a stackable item. More...
 
class  UITextRenderer
 Renders a UI value provider as text. More...
 
class  UIValueProvider
 Base component which supports showing a property of a player with a given id. More...
 
class  UIEquipmentManager
 Shows equipped items. More...
 
class  UIInventory
 Shows inventory More...
 
class  UIInventoryButtonGroup
 Used to group buttons that can be placed on an inventory screen. More...
 
class  UIInventorySlot
 UI item for an individual slot in an inventory. More...
 
class  UIInventoryNavigation
 Stores custom UI navigation data. More...
 
class  UIShop
 UI for a shop. More...
 
class  UIShopItemDetails
 
class  UIShopSlot
 UI item for an individual slot in an inventory. More...
 
class  UILevelSelectCharacter
 A character in a top down level select screen. More...
 
class  UILevelSelectTile
 A top down tile in a level select view on which the character can walk. More...
 
interface  IMenu
 
interface  IMenuItemRenderer
 
class  UIBasicMenu
 User interface for a very simple menu made of text items. Pressing up/down moves a pointer through the items and pressing ENTER, SPACE, jump of action button 1 activates selected item. items may optionallyhave handling for left and right directions. More...
 
class  UIMenuItem
 An item in a menu. More...
 
class  UIMenuItem_CharacterSelect
 Menu item for selecting a character. More...
 
class  UIMenuItem_KeyConfig
 Men uitem which is used for configuring a key. More...
 
class  UIMenuItem_NumberOfPlayers
 An item in a menu. More...
 
class  UIMenuItem_SwitchInputType
 An item in a menu. More...
 
class  NameAndPref
 Associates a human readable name to an input XML resource name. More...
 
class  UIMenuItem_Volume
 Menu item which is used for configuring a key. More...
 
class  UIMenuItemRenderer_Image
 Renders a menu item using the title as the name of a texture and the extra info as text. More...
 
class  UIMenuItemRenderer_SimpleText
 Renders a menu item using a single text field. More...
 
class  UIMenuItemRenderer_TwoColumn
 Renders a menu item using a two column layout. More...
 
class  UIMenuItemRenderer_Volume
 Renders a menu item using a two column layout. More...
 
class  UIPauseMenu
 User interface for the pause menu. It shows the background then hands over to another menu. More...
 
class  UIScrollingMenu
 Extends the basic menu to a scrolling menu view. Relies on a pointer image to set the selected item position although the image can be empty. More...
 
class  UIVolumePip
 
class  UIScreen
 A screen is a user interface component that can be shown and hidden. More...
 

Enumerations

enum class  NavigationDirection { UP , DOWN , LEFT , RIGHT }
 Directions we can navigate in. More...
 
enum class  UIMenuAction {
  SHOW_MENU , LOAD_SCENE , CONFIGURE_KEY , RESTORE_DEFAULT_KEYS ,
  SWITCH_INPUT_TYPE , MUSIC_VOLUME , SFX_VOLUME , SEND_MESSAGE ,
  ACTIVATE_GAMEOBJECT , DEACTIVATE_GAMEOBJECT , EXIT , PAUSE_AND_HIDE ,
  USE_ITEM , USE_ITEM_AND_HIDE , NUMBER_OF_PLAYERS , SELECT_PLAYER ,
  ACTIVATE_ITEM , DEACTIVATE_ITEM
}
 Actions that can occur by clicking a menu item. More...
 
enum class  VolumeType { MUSIC , SFX }
 Volume type. More...
 

Enumeration Type Documentation

◆ NavigationDirection

Directions we can navigate in.

Enumerator
UP 
DOWN 
LEFT 
RIGHT 

◆ UIMenuAction

Actions that can occur by clicking a menu item.

Enumerator
SHOW_MENU 
LOAD_SCENE 
CONFIGURE_KEY 
RESTORE_DEFAULT_KEYS 
SWITCH_INPUT_TYPE 
MUSIC_VOLUME 
SFX_VOLUME 
SEND_MESSAGE 
ACTIVATE_GAMEOBJECT 
DEACTIVATE_GAMEOBJECT 
EXIT 
PAUSE_AND_HIDE 
USE_ITEM 
USE_ITEM_AND_HIDE 
NUMBER_OF_PLAYERS 
SELECT_PLAYER 
ACTIVATE_ITEM 
DEACTIVATE_ITEM 

◆ VolumeType

Volume type.

Enumerator
MUSIC 
SFX