Highroad Engine v1.3
Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
MoreMountains.HighroadEngine.LocalLobbyPlayerUI Class Reference

This class manages a player on the lobby/menu screen. Implements IActorInput interface for UI manipulation More...

Inheritance diagram for MoreMountains.HighroadEngine.LocalLobbyPlayerUI:
MoreMountains.HighroadEngine.IActorInput

Public Member Functions

virtual void Start ()
 Initialisation More...
 
virtual void OnAddPlayerButton ()
 Describes what happens when the Add Player button gets pressed More...
 
virtual void OnAddBotButton ()
 Describes what happens when the Add Bot button gets pressed More...
 
virtual void OnRemovePlayer ()
 Describes what happens when a player gets removed More...
 
virtual void OnLeft ()
 Describes what happens when the left button gets pressed More...
 
virtual void OnRight ()
 Describes what happens when the right button gets pressed More...
 
virtual void OnReady (bool fromGUI)
 Describes what happens when the ready button is pressed More...
 
virtual void MainActionDown ()
 Main Action button More...
 
virtual void AltActionDown ()
 Alt button : Cancel Button. More...
 
virtual void HorizontalPosition (float value)
 Input management from keyboard / joystick. More...
 
virtual void VerticalPosition (float value)
 Update of the vertical value (from -1 to 1) More...
 
void RespawnActionDown ()
 Button Respawn Action is pressed down More...
 
virtual void AltActionReleased ()
 Button Alt Action is released More...
 
virtual void RespawnActionReleased ()
 Button Respawn Action is released More...
 
void MobileJoystickPosition (Vector2 value)
 Update of the mobile joystick position More...
 
virtual void MainActionReleased ()
 Button Main Action is released More...
 
virtual void LeftPressed ()
 Button Left is being pressed More...
 
virtual void RightPressed ()
 Button Right is being pressed More...
 
virtual void UpPressed ()
 Button Up is being pressed More...
 
virtual void DownPressed ()
 Button Down is being pressed More...
 
void AltActionPressed ()
 Button Alt Action is being pressed More...
 
void RespawnActionPressed ()
 Button Respawn Action is being pressed More...
 
virtual void MainActionPressed ()
 Button Main Action is being pressed More...
 
void LeftReleased ()
 Button Left is released More...
 
void RightReleased ()
 Button Right is released More...
 
void UpReleased ()
 Button Up is released More...
 
void DownReleased ()
 Button Down is released More...
 

Public Attributes

int Position
 Slot number. Used for Input Management and UI. More...
 
string JoinActionInputName
 Use this text to specify the MainActionButton name of this slot. More...
 
LocalLobbyGameUI MenuSceneManager
 Reference to menu scene manager. More...
 
Text PlayerNameText
 
RectTransform AddPlayerZone
 
Button NewPlayerButton
 
Button NewBotButton
 
RectTransform ChooseVehicleZone
 
Button RemovePlayerButton
 
Button LeftButton
 
Button RightButton
 
Text VehicleText
 
Image VehicleImage
 
Button ReadyButton
 
Sprite ReadyButtonSprite
 
Sprite CancelReadyButtonSprite
 

Protected Member Functions

virtual void InitManagers ()
 Initializes managers More...
 
virtual void InitUI ()
 Initializes links to UI elements More...
 
virtual void InitStartState ()
 Initializes the start state. More...
 
virtual void ShowSelectedVehicle ()
 Shows the selected vehicle from the LobbyManager Available Vehicles More...
 
virtual void AddLobbyPlayer (bool isBot)
 Internal logic when adding new player in the lobby More...
 
virtual void AddLocalPlayerToLobby ()
 Adds a local player to lobby. More...
 
virtual void CancelPlayer ()
 Cancel player selection More...
 

Protected Attributes

LocalLobbyManager _localLobbyManager
 
bool _ready
 
bool _isBot
 
int _currentVehicleIndex = -1
 
bool okToMove
 Stopper boolean for vehicle selector More...
 

Detailed Description

This class manages a player on the lobby/menu screen. Implements IActorInput interface for UI manipulation

Member Function Documentation

◆ AddLobbyPlayer()

virtual void MoreMountains.HighroadEngine.LocalLobbyPlayerUI.AddLobbyPlayer ( bool  isBot)
protectedvirtual

Internal logic when adding new player in the lobby

Parameters
isBotIf set to true player is a bot.

◆ AddLocalPlayerToLobby()

virtual void MoreMountains.HighroadEngine.LocalLobbyPlayerUI.AddLocalPlayerToLobby ( )
protectedvirtual

Adds a local player to lobby.

◆ AltActionDown()

virtual void MoreMountains.HighroadEngine.LocalLobbyPlayerUI.AltActionDown ( )
virtual

Alt button : Cancel Button.

Implements MoreMountains.HighroadEngine.IActorInput.

◆ AltActionPressed()

void MoreMountains.HighroadEngine.LocalLobbyPlayerUI.AltActionPressed ( )

Button Alt Action is being pressed

Implements MoreMountains.HighroadEngine.IActorInput.

◆ AltActionReleased()

virtual void MoreMountains.HighroadEngine.LocalLobbyPlayerUI.AltActionReleased ( )
virtual

Button Alt Action is released

Implements MoreMountains.HighroadEngine.IActorInput.

◆ CancelPlayer()

virtual void MoreMountains.HighroadEngine.LocalLobbyPlayerUI.CancelPlayer ( )
protectedvirtual

Cancel player selection

◆ DownPressed()

virtual void MoreMountains.HighroadEngine.LocalLobbyPlayerUI.DownPressed ( )
virtual

Button Down is being pressed

Implements MoreMountains.HighroadEngine.IActorInput.

◆ DownReleased()

void MoreMountains.HighroadEngine.LocalLobbyPlayerUI.DownReleased ( )

Button Down is released

Implements MoreMountains.HighroadEngine.IActorInput.

◆ HorizontalPosition()

virtual void MoreMountains.HighroadEngine.LocalLobbyPlayerUI.HorizontalPosition ( float  value)
virtual

Input management from keyboard / joystick.

Parameters
valueValue.

Implements MoreMountains.HighroadEngine.IActorInput.

◆ InitManagers()

virtual void MoreMountains.HighroadEngine.LocalLobbyPlayerUI.InitManagers ( )
protectedvirtual

Initializes managers

◆ InitStartState()

virtual void MoreMountains.HighroadEngine.LocalLobbyPlayerUI.InitStartState ( )
protectedvirtual

Initializes the start state.

◆ InitUI()

virtual void MoreMountains.HighroadEngine.LocalLobbyPlayerUI.InitUI ( )
protectedvirtual

Initializes links to UI elements

◆ LeftPressed()

virtual void MoreMountains.HighroadEngine.LocalLobbyPlayerUI.LeftPressed ( )
virtual

Button Left is being pressed

Implements MoreMountains.HighroadEngine.IActorInput.

◆ LeftReleased()

void MoreMountains.HighroadEngine.LocalLobbyPlayerUI.LeftReleased ( )

Button Left is released

Implements MoreMountains.HighroadEngine.IActorInput.

◆ MainActionDown()

virtual void MoreMountains.HighroadEngine.LocalLobbyPlayerUI.MainActionDown ( )
virtual

Main Action button

Implements MoreMountains.HighroadEngine.IActorInput.

◆ MainActionPressed()

virtual void MoreMountains.HighroadEngine.LocalLobbyPlayerUI.MainActionPressed ( )
virtual

Button Main Action is being pressed

Implements MoreMountains.HighroadEngine.IActorInput.

◆ MainActionReleased()

virtual void MoreMountains.HighroadEngine.LocalLobbyPlayerUI.MainActionReleased ( )
virtual

Button Main Action is released

Implements MoreMountains.HighroadEngine.IActorInput.

◆ MobileJoystickPosition()

void MoreMountains.HighroadEngine.LocalLobbyPlayerUI.MobileJoystickPosition ( Vector2  value)

Update of the mobile joystick position

Parameters
valueValue.

Implements MoreMountains.HighroadEngine.IActorInput.

◆ OnAddBotButton()

virtual void MoreMountains.HighroadEngine.LocalLobbyPlayerUI.OnAddBotButton ( )
virtual

Describes what happens when the Add Bot button gets pressed

◆ OnAddPlayerButton()

virtual void MoreMountains.HighroadEngine.LocalLobbyPlayerUI.OnAddPlayerButton ( )
virtual

Describes what happens when the Add Player button gets pressed

◆ OnLeft()

virtual void MoreMountains.HighroadEngine.LocalLobbyPlayerUI.OnLeft ( )
virtual

Describes what happens when the left button gets pressed

◆ OnReady()

virtual void MoreMountains.HighroadEngine.LocalLobbyPlayerUI.OnReady ( bool  fromGUI)
virtual

Describes what happens when the ready button is pressed

Parameters
fromGUIIf this parameter is set to true, we won't activate the specific case where player 1 can start the game. This allows us to separate keyboard and joystick control from Mobile Touch and mouse controls

◆ OnRemovePlayer()

virtual void MoreMountains.HighroadEngine.LocalLobbyPlayerUI.OnRemovePlayer ( )
virtual

Describes what happens when a player gets removed

◆ OnRight()

virtual void MoreMountains.HighroadEngine.LocalLobbyPlayerUI.OnRight ( )
virtual

Describes what happens when the right button gets pressed

◆ RespawnActionDown()

void MoreMountains.HighroadEngine.LocalLobbyPlayerUI.RespawnActionDown ( )

Button Respawn Action is pressed down

Implements MoreMountains.HighroadEngine.IActorInput.

◆ RespawnActionPressed()

void MoreMountains.HighroadEngine.LocalLobbyPlayerUI.RespawnActionPressed ( )

Button Respawn Action is being pressed

Implements MoreMountains.HighroadEngine.IActorInput.

◆ RespawnActionReleased()

virtual void MoreMountains.HighroadEngine.LocalLobbyPlayerUI.RespawnActionReleased ( )
virtual

Button Respawn Action is released

Implements MoreMountains.HighroadEngine.IActorInput.

◆ RightPressed()

virtual void MoreMountains.HighroadEngine.LocalLobbyPlayerUI.RightPressed ( )
virtual

Button Right is being pressed

Implements MoreMountains.HighroadEngine.IActorInput.

◆ RightReleased()

void MoreMountains.HighroadEngine.LocalLobbyPlayerUI.RightReleased ( )

Button Right is released

Implements MoreMountains.HighroadEngine.IActorInput.

◆ ShowSelectedVehicle()

virtual void MoreMountains.HighroadEngine.LocalLobbyPlayerUI.ShowSelectedVehicle ( )
protectedvirtual

Shows the selected vehicle from the LobbyManager Available Vehicles

◆ Start()

virtual void MoreMountains.HighroadEngine.LocalLobbyPlayerUI.Start ( )
virtual

Initialisation

◆ UpPressed()

virtual void MoreMountains.HighroadEngine.LocalLobbyPlayerUI.UpPressed ( )
virtual

Button Up is being pressed

Implements MoreMountains.HighroadEngine.IActorInput.

◆ UpReleased()

void MoreMountains.HighroadEngine.LocalLobbyPlayerUI.UpReleased ( )

Button Up is released

Implements MoreMountains.HighroadEngine.IActorInput.

◆ VerticalPosition()

virtual void MoreMountains.HighroadEngine.LocalLobbyPlayerUI.VerticalPosition ( float  value)
virtual

Update of the vertical value (from -1 to 1)

Parameters
valueValue.

Implements MoreMountains.HighroadEngine.IActorInput.

Member Data Documentation

◆ _currentVehicleIndex

int MoreMountains.HighroadEngine.LocalLobbyPlayerUI._currentVehicleIndex = -1
protected

◆ _isBot

bool MoreMountains.HighroadEngine.LocalLobbyPlayerUI._isBot
protected

◆ _localLobbyManager

LocalLobbyManager MoreMountains.HighroadEngine.LocalLobbyPlayerUI._localLobbyManager
protected

◆ _ready

bool MoreMountains.HighroadEngine.LocalLobbyPlayerUI._ready
protected

◆ AddPlayerZone

RectTransform MoreMountains.HighroadEngine.LocalLobbyPlayerUI.AddPlayerZone

◆ CancelReadyButtonSprite

Sprite MoreMountains.HighroadEngine.LocalLobbyPlayerUI.CancelReadyButtonSprite

◆ ChooseVehicleZone

RectTransform MoreMountains.HighroadEngine.LocalLobbyPlayerUI.ChooseVehicleZone

◆ JoinActionInputName

string MoreMountains.HighroadEngine.LocalLobbyPlayerUI.JoinActionInputName

Use this text to specify the MainActionButton name of this slot.

◆ LeftButton

Button MoreMountains.HighroadEngine.LocalLobbyPlayerUI.LeftButton

◆ MenuSceneManager

LocalLobbyGameUI MoreMountains.HighroadEngine.LocalLobbyPlayerUI.MenuSceneManager

Reference to menu scene manager.

◆ NewBotButton

Button MoreMountains.HighroadEngine.LocalLobbyPlayerUI.NewBotButton

◆ NewPlayerButton

Button MoreMountains.HighroadEngine.LocalLobbyPlayerUI.NewPlayerButton

◆ okToMove

bool MoreMountains.HighroadEngine.LocalLobbyPlayerUI.okToMove
protected

Stopper boolean for vehicle selector

◆ PlayerNameText

Text MoreMountains.HighroadEngine.LocalLobbyPlayerUI.PlayerNameText

◆ Position

int MoreMountains.HighroadEngine.LocalLobbyPlayerUI.Position

Slot number. Used for Input Management and UI.

◆ ReadyButton

Button MoreMountains.HighroadEngine.LocalLobbyPlayerUI.ReadyButton

◆ ReadyButtonSprite

Sprite MoreMountains.HighroadEngine.LocalLobbyPlayerUI.ReadyButtonSprite

◆ RemovePlayerButton

Button MoreMountains.HighroadEngine.LocalLobbyPlayerUI.RemovePlayerButton

◆ RightButton

Button MoreMountains.HighroadEngine.LocalLobbyPlayerUI.RightButton

◆ VehicleImage

Image MoreMountains.HighroadEngine.LocalLobbyPlayerUI.VehicleImage

◆ VehicleText

Text MoreMountains.HighroadEngine.LocalLobbyPlayerUI.VehicleText

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