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

344 lines
9.2 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.TerribleHealthBarScript
commentId: T:Game.TerribleHealthBarScript
2025-04-16 19:20:36 -04:00
id: TerribleHealthBarScript
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.TerribleHealthBarScript.actualHealthVisual
- Game.TerribleHealthBarScript.deathVisual
- Game.TerribleHealthBarScript.fullDeathColor
- Game.TerribleHealthBarScript.fullHealthColor
- Game.TerribleHealthBarScript.healthVisual
- Game.TerribleHealthBarScript.player
- Game.TerribleHealthBarScript.SetPlayer(GameObject)
- Game.TerribleHealthBarScript.smoothSpeed
- Game.TerribleHealthBarScript.subtractionColor
- Game.TerribleHealthBarScript.text
2025-04-16 19:20:36 -04:00
langs:
- csharp
- vb
name: TerribleHealthBarScript
nameWithType: TerribleHealthBarScript
2025-04-16 19:57:54 -04:00
fullName: Game.TerribleHealthBarScript
2025-04-16 19:20:36 -04:00
type: Class
source:
id: TerribleHealthBarScript
path: ''
2025-04-19 12:59:07 -04:00
startLine: 2927
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 health bar visuals for a player, including updating\nthe health bar's size, position, and color based on the player's current health.\n"
example: []
2025-04-16 19:20:36 -04:00
syntax:
content: 'public class TerribleHealthBarScript : MonoBehaviour'
content.vb: Public Class TerribleHealthBarScript Inherits MonoBehaviour
inheritance:
- System.Object
2025-04-16 19:57:54 -04:00
- uid: Game.TerribleHealthBarScript.fullHealthColor
commentId: F:Game.TerribleHealthBarScript.fullHealthColor
2025-04-16 19:20:36 -04:00
id: fullHealthColor
2025-04-16 19:57:54 -04:00
parent: Game.TerribleHealthBarScript
2025-04-16 19:20:36 -04:00
langs:
- csharp
- vb
name: fullHealthColor
nameWithType: TerribleHealthBarScript.fullHealthColor
2025-04-16 19:57:54 -04:00
fullName: Game.TerribleHealthBarScript.fullHealthColor
2025-04-16 19:20:36 -04:00
type: Field
source:
id: fullHealthColor
path: ''
2025-04-19 12:59:07 -04:00
startLine: 2932
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 color of the health bar when the player is at full health.\n"
example: []
2025-04-16 19:20:36 -04:00
syntax:
content: public Color fullHealthColor
return:
type: Global.Color
content.vb: Public fullHealthColor As Color
2025-04-16 19:57:54 -04:00
- uid: Game.TerribleHealthBarScript.fullDeathColor
commentId: F:Game.TerribleHealthBarScript.fullDeathColor
2025-04-16 19:20:36 -04:00
id: fullDeathColor
2025-04-16 19:57:54 -04:00
parent: Game.TerribleHealthBarScript
2025-04-16 19:20:36 -04:00
langs:
- csharp
- vb
name: fullDeathColor
nameWithType: TerribleHealthBarScript.fullDeathColor
2025-04-16 19:57:54 -04:00
fullName: Game.TerribleHealthBarScript.fullDeathColor
2025-04-16 19:20:36 -04:00
type: Field
source:
id: fullDeathColor
path: ''
2025-04-19 12:59:07 -04:00
startLine: 2937
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 color of the health bar when the player is at zero health.\n"
example: []
2025-04-16 19:20:36 -04:00
syntax:
content: public Color fullDeathColor
return:
type: Global.Color
content.vb: Public fullDeathColor As Color
2025-04-16 19:57:54 -04:00
- uid: Game.TerribleHealthBarScript.subtractionColor
commentId: F:Game.TerribleHealthBarScript.subtractionColor
2025-04-16 19:20:36 -04:00
id: subtractionColor
2025-04-16 19:57:54 -04:00
parent: Game.TerribleHealthBarScript
2025-04-16 19:20:36 -04:00
langs:
- csharp
- vb
name: subtractionColor
nameWithType: TerribleHealthBarScript.subtractionColor
2025-04-16 19:57:54 -04:00
fullName: Game.TerribleHealthBarScript.subtractionColor
2025-04-16 19:20:36 -04:00
type: Field
source:
id: subtractionColor
path: ''
2025-04-19 12:59:07 -04:00
startLine: 2942
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 color used to represent health subtraction.\n"
example: []
2025-04-16 19:20:36 -04:00
syntax:
content: public Color subtractionColor
return:
type: Global.Color
content.vb: Public subtractionColor As Color
2025-04-16 19:57:54 -04:00
- uid: Game.TerribleHealthBarScript.healthVisual
commentId: F:Game.TerribleHealthBarScript.healthVisual
2025-04-16 19:20:36 -04:00
id: healthVisual
2025-04-16 19:57:54 -04:00
parent: Game.TerribleHealthBarScript
2025-04-16 19:20:36 -04:00
langs:
- csharp
- vb
name: healthVisual
nameWithType: TerribleHealthBarScript.healthVisual
2025-04-16 19:57:54 -04:00
fullName: Game.TerribleHealthBarScript.healthVisual
2025-04-16 19:20:36 -04:00
type: Field
source:
id: healthVisual
path: ''
2025-04-19 12:59:07 -04:00
startLine: 2947
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 visual representation of the health bar.\n"
example: []
2025-04-16 19:20:36 -04:00
syntax:
content: public GameObject healthVisual
return:
type: Global.GameObject
content.vb: Public healthVisual As GameObject
2025-04-16 19:57:54 -04:00
- uid: Game.TerribleHealthBarScript.actualHealthVisual
commentId: F:Game.TerribleHealthBarScript.actualHealthVisual
2025-04-16 19:20:36 -04:00
id: actualHealthVisual
2025-04-16 19:57:54 -04:00
parent: Game.TerribleHealthBarScript
2025-04-16 19:20:36 -04:00
langs:
- csharp
- vb
name: actualHealthVisual
nameWithType: TerribleHealthBarScript.actualHealthVisual
2025-04-16 19:57:54 -04:00
fullName: Game.TerribleHealthBarScript.actualHealthVisual
2025-04-16 19:20:36 -04:00
type: Field
source:
id: actualHealthVisual
path: ''
2025-04-19 12:59:07 -04:00
startLine: 2952
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 actual health bar that reflects the player's current health.\n"
example: []
2025-04-16 19:20:36 -04:00
syntax:
content: public GameObject actualHealthVisual
return:
type: Global.GameObject
content.vb: Public actualHealthVisual As GameObject
2025-04-16 19:57:54 -04:00
- uid: Game.TerribleHealthBarScript.deathVisual
commentId: F:Game.TerribleHealthBarScript.deathVisual
2025-04-16 19:20:36 -04:00
id: deathVisual
2025-04-16 19:57:54 -04:00
parent: Game.TerribleHealthBarScript
2025-04-16 19:20:36 -04:00
langs:
- csharp
- vb
name: deathVisual
nameWithType: TerribleHealthBarScript.deathVisual
2025-04-16 19:57:54 -04:00
fullName: Game.TerribleHealthBarScript.deathVisual
2025-04-16 19:20:36 -04:00
type: Field
source:
id: deathVisual
path: ''
2025-04-19 12:59:07 -04:00
startLine: 2957
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 visual representation of the player's death state.\n"
example: []
2025-04-16 19:20:36 -04:00
syntax:
content: public GameObject deathVisual
return:
type: Global.GameObject
content.vb: Public deathVisual As GameObject
2025-04-16 19:57:54 -04:00
- uid: Game.TerribleHealthBarScript.smoothSpeed
commentId: F:Game.TerribleHealthBarScript.smoothSpeed
2025-04-16 19:20:36 -04:00
id: smoothSpeed
2025-04-16 19:57:54 -04:00
parent: Game.TerribleHealthBarScript
2025-04-16 19:20:36 -04:00
langs:
- csharp
- vb
name: smoothSpeed
nameWithType: TerribleHealthBarScript.smoothSpeed
2025-04-16 19:57:54 -04:00
fullName: Game.TerribleHealthBarScript.smoothSpeed
2025-04-16 19:20:36 -04:00
type: Field
source:
id: smoothSpeed
path: ''
2025-04-19 12:59:07 -04:00
startLine: 2962
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 speed at which the health bar updates smoothly.\n"
example: []
2025-04-16 19:20:36 -04:00
syntax:
content: public float smoothSpeed
return:
type: System.Single
content.vb: Public smoothSpeed As Single
2025-04-16 19:57:54 -04:00
- uid: Game.TerribleHealthBarScript.text
commentId: F:Game.TerribleHealthBarScript.text
2025-04-16 19:20:36 -04:00
id: text
2025-04-16 19:57:54 -04:00
parent: Game.TerribleHealthBarScript
2025-04-16 19:20:36 -04:00
langs:
- csharp
- vb
name: text
nameWithType: TerribleHealthBarScript.text
2025-04-16 19:57:54 -04:00
fullName: Game.TerribleHealthBarScript.text
2025-04-16 19:20:36 -04:00
type: Field
source:
id: text
path: ''
2025-04-19 12:59:07 -04:00
startLine: 2967
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 text element displaying the player's current and maximum health.\n"
example: []
2025-04-16 19:20:36 -04:00
syntax:
content: public TextMeshProUGUI text
return:
type: Global.TextMeshProUGUI
content.vb: Public text As TextMeshProUGUI
2025-04-16 19:57:54 -04:00
- uid: Game.TerribleHealthBarScript.player
commentId: F:Game.TerribleHealthBarScript.player
2025-04-16 19:20:36 -04:00
id: player
2025-04-16 19:57:54 -04:00
parent: Game.TerribleHealthBarScript
2025-04-16 19:20:36 -04:00
langs:
- csharp
- vb
name: player
nameWithType: TerribleHealthBarScript.player
2025-04-16 19:57:54 -04:00
fullName: Game.TerribleHealthBarScript.player
2025-04-16 19:20:36 -04:00
type: Field
source:
id: player
path: ''
2025-04-19 12:59:07 -04:00
startLine: 3002
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 player associated with this health bar.\n"
example: []
2025-04-16 19:20:36 -04:00
syntax:
content: public GameObject player
return:
type: Global.GameObject
content.vb: Public player As GameObject
2025-04-16 19:57:54 -04:00
- uid: Game.TerribleHealthBarScript.SetPlayer(GameObject)
commentId: M:Game.TerribleHealthBarScript.SetPlayer(GameObject)
2025-04-16 19:20:36 -04:00
id: SetPlayer(GameObject)
2025-04-16 19:57:54 -04:00
parent: Game.TerribleHealthBarScript
2025-04-16 19:20:36 -04:00
langs:
- csharp
- vb
name: SetPlayer(GameObject)
nameWithType: TerribleHealthBarScript.SetPlayer(GameObject)
2025-04-16 19:57:54 -04:00
fullName: Game.TerribleHealthBarScript.SetPlayer(GameObject)
2025-04-16 19:20:36 -04:00
type: Method
source:
id: SetPlayer
path: ''
2025-04-19 12:59:07 -04:00
startLine: 3043
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: "\nSets the player associated with this health bar.\n"
example: []
2025-04-16 19:20:36 -04:00
syntax:
content: public void SetPlayer(GameObject player)
parameters:
- id: player
type: Global.GameObject
2025-04-18 20:11:19 -04:00
description: The player to associate with this health bar.
2025-04-16 19:20:36 -04:00
content.vb: Public Sub SetPlayer(player As GameObject)
2025-04-16 19:57:54 -04:00
overload: Game.TerribleHealthBarScript.SetPlayer*
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.Color
isExternal: true
name: Color
nameWithType: Color
fullName: Color
- uid: Global.GameObject
isExternal: true
name: GameObject
nameWithType: GameObject
fullName: GameObject
- uid: System.Single
commentId: T:System.Single
parent: System
isExternal: true
name: float
nameWithType: float
fullName: float
nameWithType.vb: Single
fullName.vb: Single
name.vb: Single
- uid: Global.TextMeshProUGUI
isExternal: true
name: TextMeshProUGUI
nameWithType: TextMeshProUGUI
fullName: TextMeshProUGUI
2025-04-16 19:57:54 -04:00
- uid: Game.TerribleHealthBarScript.SetPlayer*
commentId: Overload:Game.TerribleHealthBarScript.SetPlayer
2025-04-16 19:20:36 -04:00
name: SetPlayer
nameWithType: TerribleHealthBarScript.SetPlayer
2025-04-16 19:57:54 -04:00
fullName: Game.TerribleHealthBarScript.SetPlayer