C# Class Antura.UI.MinigamesUILives

Shows the number of current and max lives available in a minigame.
Inheritance: Antura.UI.ABSMinigamesUIComponent
Afficher le fichier Open project: vgwb/Antura_arabic Class Usage Examples

Méthodes publiques

Свойство Type Description
LifePrefab Antura.UI.MinigamesUISingleLife

Méthodes publiques

Méthode Description
Awake ( ) : void
GainALife ( bool _canExceedMax = false ) : int

Adds one life and retuns the current active ones (the ones with a full heart). If the new value is higher than MaxLives, new life objects are created and MaxLives is modified accordingly.

LoseALife ( ) : int

Removes one active life and retuns the current active ones (the ones with a full heart)

ResetToMax ( ) : int

Makes all life objects active (with a full heart)

SetCurrLives ( int _to, bool _canExceedMax = false ) : int

Sets the current lives to the given value and returns the value (representing the lives with a full heart).

Setup ( int _maxLives ) : void

Sets the max lives. Call this before calling any other method.

Method Details

Awake() public méthode

public Awake ( ) : void
Résultat void

GainALife() public méthode

Adds one life and retuns the current active ones (the ones with a full heart). If the new value is higher than MaxLives, new life objects are created and MaxLives is modified accordingly.
public GainALife ( bool _canExceedMax = false ) : int
_canExceedMax bool If TRUE and the new value is higher than , /// new life objects are created and is modified accordingly.
Résultat int

LoseALife() public méthode

Removes one active life and retuns the current active ones (the ones with a full heart)
public LoseALife ( ) : int
Résultat int

ResetToMax() public méthode

Makes all life objects active (with a full heart)
public ResetToMax ( ) : int
Résultat int

SetCurrLives() public méthode

Sets the current lives to the given value and returns the value (representing the lives with a full heart).
public SetCurrLives ( int _to, bool _canExceedMax = false ) : int
_to int Lives to set as active (with full heart)
_canExceedMax bool If TRUE and the new value is higher than , /// new life objects are created and is modified accordingly.
Résultat int

Setup() public méthode

Sets the max lives. Call this before calling any other method.
public Setup ( int _maxLives ) : void
_maxLives int Max lives
Résultat void

Property Details

LifePrefab public_oe property

public MinigamesUISingleLife,Antura.UI LifePrefab
Résultat Antura.UI.MinigamesUISingleLife