Detailed Description
The main player of the metaspaces, it is a PlayerController as the PlayerController should never change.
Public Member Functions | |
Blueprint Functions | |
| void | SetManualSpawn (const FTransform &pSpawn) |
| Sets the spawn position for manual spawning. More... | |
| void | OnSpawn () |
| A spawn function that can be overriden by blueprints to define their own spawning behavior. More... | |
| void | SpawnPlayerInstance () |
| Spawns the player into the game and posses the player Should ONLY be called when AutoSpawn is set to false. More... | |
| UYomModule * | GetModuleByName (const FString &pName) |
| Tries to find a module with a given name. More... | |
| AYomManager * | GetManagerByName (const FString &pName) |
| Tries to find a manager with a given name. More... | |
| TArray< UYomModule * > & | GetLoadedModules () |
| Returns all loaded modules on this player. More... | |
| const FWallet & | GetWallet () const |
| Returns the current wallet data from the player. More... | |
| const FString & | GetWalletID () const |
| Returns the current walletID from the player. More... | |
| const FString & | GetPlayerName () const |
| Get the current walletID from the player. More... | |
| UPixelStreamingInput * | GetInputComponent () const |
| Returns the current pixelstream input component from this player. More... | |
| bool | HasSpawned () const |
| Returns true if the player has a pawn that spawned in the game. More... | |
Public Attributes | |
Blueprint Members | |
| TArray< TSubclassOf< APawn > > | PlayerAssets |
| The player asset of the player that needs to be spawned. More... | |
| TArray< TSubclassOf< AYomManager > > | YomManagers |
| List of YomManagers that should be spawned when player connnects. More... | |
| bool | ManualSpawnLocation = false |
| Determines where to spawn the player If true, it spawns the player at a random player start If false, the player will be spawned at the ManualSpawnTransform which can be set by the user. More... | |
| FTransform | ManualSpawnTransform |
| The transform that can be set to spawn a player in a specific position. More... | |
| ULevelSequence * | MovieSceneSequence |
| The class of the camera sequence that plays when the player does not have a wallet. More... | |
| FMovieSceneSequencePlaybackSettings | MovieSceneSettings |
| The camera settings of the camera sequence that plays when the player does not have a wallet. More... | |
| FLevelSequenceCameraSettings | CameraSettings |
Member Function Documentation
◆ GetInputComponent()
| UPixelStreamingInput * AYomPlayer::GetInputComponent | ( | ) | const |
Returns the current pixelstream input component from this player.
◆ GetLoadedModules()
| TArray< UYomModule * > & AYomPlayer::GetLoadedModules | ( | ) |
Returns all loaded modules on this player.
- Returns
- All loaded modules
◆ GetManagerByName()
| AYomManager * AYomPlayer::GetManagerByName | ( | const FString & | pName | ) |
Tries to find a manager with a given name.
- Parameters
-
pName The name of the manager
- Returns
- If found it returns the module, if not it returns a nullptr
◆ GetModuleByName()
| UYomModule * AYomPlayer::GetModuleByName | ( | const FString & | pName | ) |
Tries to find a module with a given name.
- Parameters
-
pName The name of the module
- Returns
- If found it returns the module, if not it returns a nullptr
◆ GetPlayerName()
| const FString & AYomPlayer::GetPlayerName | ( | ) | const |
Get the current walletID from the player.
◆ GetWallet()
| const FWallet & AYomPlayer::GetWallet | ( | ) | const |
Returns the current wallet data from the player.
◆ GetWalletID()
| const FString & AYomPlayer::GetWalletID | ( | ) | const |
Returns the current walletID from the player.
◆ HasSpawned()
| bool AYomPlayer::HasSpawned | ( | ) | const |
Returns true if the player has a pawn that spawned in the game.
◆ OnSpawn()
| void AYomPlayer::OnSpawn | ( | ) |
A spawn function that can be overriden by blueprints to define their own spawning behavior.
◆ SetManualSpawn()
| void AYomPlayer::SetManualSpawn | ( | const FTransform & | pSpawn | ) |
Sets the spawn position for manual spawning.
- Parameters
-
pSpawn The spawn position
◆ SpawnPlayerInstance()
| void AYomPlayer::SpawnPlayerInstance | ( | ) |
Spawns the player into the game and posses the player Should ONLY be called when AutoSpawn is set to false.
Member Data Documentation
◆ CameraSettings
| FLevelSequenceCameraSettings AYomPlayer::CameraSettings |
◆ ManualSpawnLocation
| bool AYomPlayer::ManualSpawnLocation = false |
Determines where to spawn the player If true, it spawns the player at a random player start If false, the player will be spawned at the ManualSpawnTransform which can be set by the user.
◆ ManualSpawnTransform
| FTransform AYomPlayer::ManualSpawnTransform |
The transform that can be set to spawn a player in a specific position.
◆ MovieSceneSequence
| ULevelSequence* AYomPlayer::MovieSceneSequence |
The class of the camera sequence that plays when the player does not have a wallet.
◆ MovieSceneSettings
| FMovieSceneSequencePlaybackSettings AYomPlayer::MovieSceneSettings |
The camera settings of the camera sequence that plays when the player does not have a wallet.
◆ PlayerAssets
| TArray<TSubclassOf<APawn> > AYomPlayer::PlayerAssets |
The player asset of the player that needs to be spawned.
◆ YomManagers
| TArray<TSubclassOf<AYomManager> > AYomPlayer::YomManagers |
List of YomManagers that should be spawned when player connnects.
