Files
Crash-Course/Documentation/api/Player.PlayerManager.yml

276 lines
6.5 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: Player.PlayerManager
commentId: T:Player.PlayerManager
2025-04-16 19:20:36 -04:00
id: PlayerManager
2025-04-16 19:57:54 -04:00
parent: Player
2025-04-16 19:20:36 -04:00
children:
2025-04-16 19:57:54 -04:00
- Player.PlayerManager.cards
- Player.PlayerManager.Instance
- Player.PlayerManager.playerColors
- Player.PlayerManager.playerSelect
- Player.PlayerManager.StartGame
2025-04-16 19:20:36 -04:00
langs:
- csharp
- vb
name: PlayerManager
nameWithType: PlayerManager
2025-04-16 19:57:54 -04:00
fullName: Player.PlayerManager
2025-04-16 19:20:36 -04:00
type: Class
source:
id: PlayerManager
path: ''
2025-04-19 12:59:07 -04:00
startLine: 3656
2025-04-16 19:20:36 -04:00
assemblies:
- cs.temp.dll
2025-04-16 19:57:54 -04:00
namespace: Player
2025-04-18 20:11:19 -04:00
summary: "\nThis class manages player-related functionality, such as joining, leaving, and assigning colors.\nIt also handles starting the game once players have joined.\n"
example: []
2025-04-16 19:20:36 -04:00
syntax:
content: 'public class PlayerManager : MonoBehaviour'
content.vb: Public Class PlayerManager Inherits MonoBehaviour
inheritance:
- System.Object
2025-04-16 19:57:54 -04:00
- uid: Player.PlayerManager.Instance
commentId: F:Player.PlayerManager.Instance
2025-04-16 19:20:36 -04:00
id: Instance
2025-04-16 19:57:54 -04:00
parent: Player.PlayerManager
2025-04-16 19:20:36 -04:00
langs:
- csharp
- vb
name: Instance
nameWithType: PlayerManager.Instance
2025-04-16 19:57:54 -04:00
fullName: Player.PlayerManager.Instance
2025-04-16 19:20:36 -04:00
type: Field
source:
id: Instance
path: ''
2025-04-19 12:59:07 -04:00
startLine: 3661
2025-04-16 19:20:36 -04:00
assemblies:
- cs.temp.dll
2025-04-16 19:57:54 -04:00
namespace: Player
2025-04-18 20:11:19 -04:00
summary: "\nThe singleton instance of the <xref href=\"Player.PlayerManager\" data-throw-if-not-resolved=\"false\"></xref> class.\n"
example: []
2025-04-16 19:20:36 -04:00
syntax:
content: public static PlayerManager Instance
return:
2025-04-16 19:57:54 -04:00
type: Player.PlayerManager
2025-04-16 19:20:36 -04:00
content.vb: Public Shared Instance As PlayerManager
2025-04-16 19:57:54 -04:00
- uid: Player.PlayerManager.cards
commentId: F:Player.PlayerManager.cards
2025-04-16 19:20:36 -04:00
id: cards
2025-04-16 19:57:54 -04:00
parent: Player.PlayerManager
2025-04-16 19:20:36 -04:00
langs:
- csharp
- vb
name: cards
nameWithType: PlayerManager.cards
2025-04-16 19:57:54 -04:00
fullName: Player.PlayerManager.cards
2025-04-16 19:20:36 -04:00
type: Field
source:
id: cards
path: ''
2025-04-19 12:59:07 -04:00
startLine: 3666
2025-04-16 19:20:36 -04:00
assemblies:
- cs.temp.dll
2025-04-16 19:57:54 -04:00
namespace: Player
2025-04-18 20:11:19 -04:00
summary: "\nA list of player join cards, which represent players in the UI.\n"
example: []
2025-04-16 19:20:36 -04:00
syntax:
content: public List<PlayerJoinCard> cards
return:
2025-04-16 19:57:54 -04:00
type: Global.List{Game.PlayerJoinCard}
2025-04-16 19:20:36 -04:00
content.vb: Public cards As List(Of PlayerJoinCard)
2025-04-16 19:57:54 -04:00
- uid: Player.PlayerManager.playerColors
commentId: F:Player.PlayerManager.playerColors
2025-04-16 19:20:36 -04:00
id: playerColors
2025-04-16 19:57:54 -04:00
parent: Player.PlayerManager
2025-04-16 19:20:36 -04:00
langs:
- csharp
- vb
name: playerColors
nameWithType: PlayerManager.playerColors
2025-04-16 19:57:54 -04:00
fullName: Player.PlayerManager.playerColors
2025-04-16 19:20:36 -04:00
type: Field
source:
id: playerColors
path: ''
2025-04-19 12:59:07 -04:00
startLine: 3676
2025-04-16 19:20:36 -04:00
assemblies:
- cs.temp.dll
2025-04-16 19:57:54 -04:00
namespace: Player
2025-04-18 20:11:19 -04:00
summary: "\nA list of colors assigned to players for identification.\n"
example: []
2025-04-16 19:20:36 -04:00
syntax:
content: public List<Color> playerColors
return:
type: Global.List{Color}
content.vb: Public playerColors As List(Of Color)
2025-04-16 19:57:54 -04:00
- uid: Player.PlayerManager.playerSelect
commentId: F:Player.PlayerManager.playerSelect
2025-04-16 19:20:36 -04:00
id: playerSelect
2025-04-16 19:57:54 -04:00
parent: Player.PlayerManager
2025-04-16 19:20:36 -04:00
langs:
- csharp
- vb
name: playerSelect
nameWithType: PlayerManager.playerSelect
2025-04-16 19:57:54 -04:00
fullName: Player.PlayerManager.playerSelect
2025-04-16 19:20:36 -04:00
type: Field
source:
id: playerSelect
path: ''
2025-04-19 12:59:07 -04:00
startLine: 3681
2025-04-16 19:20:36 -04:00
assemblies:
- cs.temp.dll
2025-04-16 19:57:54 -04:00
namespace: Player
2025-04-18 20:11:19 -04:00
summary: "\nThe UI element used for player selection.\n"
example: []
2025-04-16 19:20:36 -04:00
syntax:
content: public GameObject playerSelect
return:
type: Global.GameObject
content.vb: Public playerSelect As GameObject
2025-04-16 19:57:54 -04:00
- uid: Player.PlayerManager.StartGame
commentId: M:Player.PlayerManager.StartGame
2025-04-16 19:20:36 -04:00
id: StartGame
2025-04-16 19:57:54 -04:00
parent: Player.PlayerManager
2025-04-16 19:20:36 -04:00
langs:
- csharp
- vb
name: StartGame()
nameWithType: PlayerManager.StartGame()
2025-04-16 19:57:54 -04:00
fullName: Player.PlayerManager.StartGame()
2025-04-16 19:20:36 -04:00
type: Method
source:
id: StartGame
path: ''
2025-04-19 12:59:07 -04:00
startLine: 3780
2025-04-16 19:20:36 -04:00
assemblies:
- cs.temp.dll
2025-04-16 19:57:54 -04:00
namespace: Player
2025-04-18 20:11:19 -04:00
summary: "\nStarts the game if at least one player has joined.\n"
example: []
2025-04-16 19:20:36 -04:00
syntax:
content: public void StartGame()
content.vb: Public Sub StartGame()
2025-04-16 19:57:54 -04:00
overload: Player.PlayerManager.StartGame*
2025-04-16 19:20:36 -04:00
references:
2025-04-16 19:57:54 -04:00
- uid: Player
commentId: N:Player
name: Player
nameWithType: Player
fullName: Player
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
2025-04-16 19:57:54 -04:00
- uid: Player.PlayerManager
commentId: T:Player.PlayerManager
parent: Player
2025-04-16 19:20:36 -04:00
name: PlayerManager
nameWithType: PlayerManager
2025-04-16 19:57:54 -04:00
fullName: Player.PlayerManager
- uid: Global.List{Game.PlayerJoinCard}
commentId: '!:Global.List{Game.PlayerJoinCard}'
2025-04-16 19:20:36 -04:00
definition: Global.List`1
name: List<PlayerJoinCard>
nameWithType: List<PlayerJoinCard>
2025-04-16 19:57:54 -04:00
fullName: List<Game.PlayerJoinCard>
2025-04-16 19:20:36 -04:00
nameWithType.vb: List(Of PlayerJoinCard)
2025-04-16 19:57:54 -04:00
fullName.vb: List(Of Game.PlayerJoinCard)
2025-04-16 19:20:36 -04:00
name.vb: List(Of PlayerJoinCard)
spec.csharp:
- uid: Global.List`1
name: List
isExternal: true
- name: <
2025-04-16 19:57:54 -04:00
- uid: Game.PlayerJoinCard
2025-04-16 19:20:36 -04:00
name: PlayerJoinCard
- name: '>'
spec.vb:
- uid: Global.List`1
name: List
isExternal: true
- name: (
- name: Of
- name: " "
2025-04-16 19:57:54 -04:00
- uid: Game.PlayerJoinCard
2025-04-16 19:20:36 -04:00
name: PlayerJoinCard
- name: )
- uid: Global.List`1
isExternal: true
name: List<>
nameWithType: List<>
fullName: List<>
nameWithType.vb: List(Of )
fullName.vb: List(Of )
name.vb: List(Of )
spec.csharp:
- uid: Global.List`1
name: List
isExternal: true
- name: <
- name: ''
- name: '>'
spec.vb:
- uid: Global.List`1
name: List
isExternal: true
- name: (
- name: Of
- name: " "
- name: ''
- name: )
- uid: Global.List{Color}
commentId: '!:Global.List{Color}'
definition: Global.List`1
name: List<Color>
nameWithType: List<Color>
fullName: List<Color>
nameWithType.vb: List(Of Color)
fullName.vb: List(Of Color)
name.vb: List(Of Color)
spec.csharp:
- uid: Global.List`1
name: List
isExternal: true
- name: <
- uid: Global.Color
name: Color
isExternal: true
- name: '>'
spec.vb:
- uid: Global.List`1
name: List
isExternal: true
- name: (
- name: Of
- name: " "
- uid: Global.Color
name: Color
isExternal: true
- name: )
- uid: Global.GameObject
isExternal: true
name: GameObject
nameWithType: GameObject
fullName: GameObject
2025-04-16 19:57:54 -04:00
- uid: Player.PlayerManager.StartGame*
commentId: Overload:Player.PlayerManager.StartGame
2025-04-16 19:20:36 -04:00
name: StartGame
nameWithType: PlayerManager.StartGame
2025-04-16 19:57:54 -04:00
fullName: Player.PlayerManager.StartGame