Files
Crash-Course/Documentation/api/Game.LifeDisplayManager.yml

280 lines
7.1 KiB
YAML
Raw Normal View History

2025-04-16 19:20:36 -04:00
### YamlMime:ManagedReference
items:
2025-04-16 19:57:54 -04:00
- uid: Game.LifeDisplayManager
commentId: T:Game.LifeDisplayManager
2025-04-16 19:20:36 -04:00
id: LifeDisplayManager
2025-04-16 19:57:54 -04:00
parent: Game
2025-04-16 19:20:36 -04:00
children:
2025-04-16 19:57:54 -04:00
- Game.LifeDisplayManager.HideLifeDisplay
- Game.LifeDisplayManager.lifeDisplays
- Game.LifeDisplayManager.lifePrefab
- Game.LifeDisplayManager.playerPrefab
- Game.LifeDisplayManager.players
2025-04-16 19:20:36 -04:00
langs:
- csharp
- vb
name: LifeDisplayManager
nameWithType: LifeDisplayManager
2025-04-16 19:57:54 -04:00
fullName: Game.LifeDisplayManager
2025-04-16 19:20:36 -04:00
type: Class
source:
id: LifeDisplayManager
path: ''
2025-04-18 20:11:19 -04:00
startLine: 2746
2025-04-16 19:20:36 -04:00
assemblies:
- cs.temp.dll
2025-04-16 19:57:54 -04:00
namespace: Game
2025-04-18 20:11:19 -04:00
summary: "\nThis class manages the display of player lives, including creating life icons\nand updating them based on the player's remaining lives.\n"
example: []
2025-04-16 19:20:36 -04:00
syntax:
content: 'public class LifeDisplayManager : MonoBehaviour'
content.vb: Public Class LifeDisplayManager Inherits MonoBehaviour
inheritance:
- System.Object
2025-04-16 19:57:54 -04:00
- uid: Game.LifeDisplayManager.players
commentId: F:Game.LifeDisplayManager.players
2025-04-16 19:20:36 -04:00
id: players
2025-04-16 19:57:54 -04:00
parent: Game.LifeDisplayManager
2025-04-16 19:20:36 -04:00
langs:
- csharp
- vb
name: players
nameWithType: LifeDisplayManager.players
2025-04-16 19:57:54 -04:00
fullName: Game.LifeDisplayManager.players
2025-04-16 19:20:36 -04:00
type: Field
source:
id: players
path: ''
2025-04-18 20:11:19 -04:00
startLine: 2751
2025-04-16 19:20:36 -04:00
assemblies:
- cs.temp.dll
2025-04-16 19:57:54 -04:00
namespace: Game
2025-04-18 20:11:19 -04:00
summary: "\nThe parent object that contains all player life displays.\n"
example: []
2025-04-16 19:20:36 -04:00
syntax:
content: public GameObject players
return:
type: Global.GameObject
content.vb: Public players As GameObject
2025-04-16 19:57:54 -04:00
- uid: Game.LifeDisplayManager.playerPrefab
commentId: F:Game.LifeDisplayManager.playerPrefab
2025-04-16 19:20:36 -04:00
id: playerPrefab
2025-04-16 19:57:54 -04:00
parent: Game.LifeDisplayManager
2025-04-16 19:20:36 -04:00
langs:
- csharp
- vb
name: playerPrefab
nameWithType: LifeDisplayManager.playerPrefab
2025-04-16 19:57:54 -04:00
fullName: Game.LifeDisplayManager.playerPrefab
2025-04-16 19:20:36 -04:00
type: Field
source:
id: playerPrefab
path: ''
2025-04-18 20:11:19 -04:00
startLine: 2756
2025-04-16 19:20:36 -04:00
assemblies:
- cs.temp.dll
2025-04-16 19:57:54 -04:00
namespace: Game
2025-04-18 20:11:19 -04:00
summary: "\nThe prefab used to represent a player in the life display.\n"
example: []
2025-04-16 19:20:36 -04:00
syntax:
content: public GameObject playerPrefab
return:
type: Global.GameObject
content.vb: Public playerPrefab As GameObject
2025-04-16 19:57:54 -04:00
- uid: Game.LifeDisplayManager.lifePrefab
commentId: F:Game.LifeDisplayManager.lifePrefab
2025-04-16 19:20:36 -04:00
id: lifePrefab
2025-04-16 19:57:54 -04:00
parent: Game.LifeDisplayManager
2025-04-16 19:20:36 -04:00
langs:
- csharp
- vb
name: lifePrefab
nameWithType: LifeDisplayManager.lifePrefab
2025-04-16 19:57:54 -04:00
fullName: Game.LifeDisplayManager.lifePrefab
2025-04-16 19:20:36 -04:00
type: Field
source:
id: lifePrefab
path: ''
2025-04-18 20:11:19 -04:00
startLine: 2761
2025-04-16 19:20:36 -04:00
assemblies:
- cs.temp.dll
2025-04-16 19:57:54 -04:00
namespace: Game
2025-04-18 20:11:19 -04:00
summary: "\nThe prefab used to represent a single life icon.\n"
example: []
2025-04-16 19:20:36 -04:00
syntax:
content: public GameObject lifePrefab
return:
type: Global.GameObject
content.vb: Public lifePrefab As GameObject
2025-04-16 19:57:54 -04:00
- uid: Game.LifeDisplayManager.lifeDisplays
commentId: F:Game.LifeDisplayManager.lifeDisplays
2025-04-16 19:20:36 -04:00
id: lifeDisplays
2025-04-16 19:57:54 -04:00
parent: Game.LifeDisplayManager
2025-04-16 19:20:36 -04:00
langs:
- csharp
- vb
name: lifeDisplays
nameWithType: LifeDisplayManager.lifeDisplays
2025-04-16 19:57:54 -04:00
fullName: Game.LifeDisplayManager.lifeDisplays
2025-04-16 19:20:36 -04:00
type: Field
source:
id: lifeDisplays
path: ''
2025-04-18 20:11:19 -04:00
startLine: 2767
2025-04-16 19:20:36 -04:00
assemblies:
- cs.temp.dll
2025-04-16 19:57:54 -04:00
namespace: Game
2025-04-18 20:11:19 -04:00
summary: "\nA dictionary mapping each player&apos;s <xref href=\"Player.Damageable\" data-throw-if-not-resolved=\"false\"></xref> component\nto their corresponding list of life icons.\n"
example: []
2025-04-16 19:20:36 -04:00
syntax:
content: public Dictionary<Damageable, List<GameObject>> lifeDisplays
return:
2025-04-16 19:57:54 -04:00
type: Global.Dictionary{Player.Damageable,List{GameObject}}
2025-04-16 19:20:36 -04:00
content.vb: Public lifeDisplays As Dictionary(Of Damageable, List(Of GameObject))
2025-04-16 19:57:54 -04:00
- uid: Game.LifeDisplayManager.HideLifeDisplay
commentId: M:Game.LifeDisplayManager.HideLifeDisplay
2025-04-16 19:20:36 -04:00
id: HideLifeDisplay
2025-04-16 19:57:54 -04:00
parent: Game.LifeDisplayManager
2025-04-16 19:20:36 -04:00
langs:
- csharp
- vb
name: HideLifeDisplay()
nameWithType: LifeDisplayManager.HideLifeDisplay()
2025-04-16 19:57:54 -04:00
fullName: Game.LifeDisplayManager.HideLifeDisplay()
2025-04-16 19:20:36 -04:00
type: Method
source:
id: HideLifeDisplay
path: ''
2025-04-18 20:11:19 -04:00
startLine: 2817
2025-04-16 19:20:36 -04:00
assemblies:
- cs.temp.dll
2025-04-16 19:57:54 -04:00
namespace: Game
2025-04-18 20:11:19 -04:00
summary: "\nHides the life display by deactivating the parent object.\n"
example: []
2025-04-16 19:20:36 -04:00
syntax:
content: public void HideLifeDisplay()
content.vb: Public Sub HideLifeDisplay()
2025-04-16 19:57:54 -04:00
overload: Game.LifeDisplayManager.HideLifeDisplay*
2025-04-16 19:20:36 -04:00
references:
2025-04-16 19:57:54 -04:00
- uid: Game
commentId: N:Game
name: Game
nameWithType: Game
fullName: Game
2025-04-16 19:20:36 -04:00
- uid: System.Object
commentId: T:System.Object
parent: System
isExternal: true
name: object
nameWithType: object
fullName: object
nameWithType.vb: Object
fullName.vb: Object
name.vb: Object
- uid: System
commentId: N:System
isExternal: true
name: System
nameWithType: System
fullName: System
- uid: Global.GameObject
isExternal: true
name: GameObject
nameWithType: GameObject
fullName: GameObject
2025-04-18 20:11:19 -04:00
- uid: Player.Damageable
commentId: T:Player.Damageable
parent: Player
name: Damageable
nameWithType: Damageable
fullName: Player.Damageable
2025-04-16 19:57:54 -04:00
- uid: Global.Dictionary{Player.Damageable,List{GameObject}}
commentId: '!:Global.Dictionary{Player.Damageable,List{GameObject}}'
2025-04-16 19:20:36 -04:00
definition: Global.Dictionary`2
name: Dictionary<Damageable, List<GameObject>>
nameWithType: Dictionary<Damageable, List<GameObject>>
2025-04-16 19:57:54 -04:00
fullName: Dictionary<Player.Damageable, List<GameObject>>
2025-04-16 19:20:36 -04:00
nameWithType.vb: Dictionary(Of Damageable, List(Of GameObject))
2025-04-16 19:57:54 -04:00
fullName.vb: Dictionary(Of Player.Damageable, List(Of GameObject))
2025-04-16 19:20:36 -04:00
name.vb: Dictionary(Of Damageable, List(Of GameObject))
spec.csharp:
- uid: Global.Dictionary`2
name: Dictionary
isExternal: true
- name: <
2025-04-16 19:57:54 -04:00
- uid: Player.Damageable
2025-04-16 19:20:36 -04:00
name: Damageable
- name: ','
- name: " "
- uid: Global.List`1
name: List
isExternal: true
- name: <
- uid: Global.GameObject
name: GameObject
isExternal: true
- name: '>'
- name: '>'
spec.vb:
- uid: Global.Dictionary`2
name: Dictionary
isExternal: true
- name: (
- name: Of
- name: " "
2025-04-16 19:57:54 -04:00
- uid: Player.Damageable
2025-04-16 19:20:36 -04:00
name: Damageable
- name: ','
- name: " "
- uid: Global.List`1
name: List
isExternal: true
- name: (
- name: Of
- name: " "
- uid: Global.GameObject
name: GameObject
isExternal: true
- name: )
- name: )
2025-04-18 20:11:19 -04:00
- uid: Player
commentId: N:Player
name: Player
nameWithType: Player
fullName: Player
2025-04-16 19:20:36 -04:00
- uid: Global.Dictionary`2
isExternal: true
name: Dictionary<, >
nameWithType: Dictionary<, >
fullName: Dictionary<, >
nameWithType.vb: Dictionary(Of , )
fullName.vb: Dictionary(Of , )
name.vb: Dictionary(Of , )
spec.csharp:
- uid: Global.Dictionary`2
name: Dictionary
isExternal: true
- name: <
- name: ''
- name: ','
- name: " "
- name: ''
- name: '>'
spec.vb:
- uid: Global.Dictionary`2
name: Dictionary
isExternal: true
- name: (
- name: Of
- name: " "
- name: ''
- name: ','
- name: " "
- name: ''
- name: )
2025-04-16 19:57:54 -04:00
- uid: Game.LifeDisplayManager.HideLifeDisplay*
commentId: Overload:Game.LifeDisplayManager.HideLifeDisplay
2025-04-16 19:20:36 -04:00
name: HideLifeDisplay
nameWithType: LifeDisplayManager.HideLifeDisplay
2025-04-16 19:57:54 -04:00
fullName: Game.LifeDisplayManager.HideLifeDisplay