Modular Turret C++ Plugin  Version 3
Turret C++ Unreal engine 4 plugin
UMortarTeamComponent Class Reference
+ Inheritance diagram for UMortarTeamComponent:
+ Collaboration diagram for UMortarTeamComponent:

Public Member Functions

bool DoSwitchTeam (const FMortarTeamProperties &DesiredTeam)
 
FMortarTeamProperties GetDefaultTeamInfo () const
 
FMortarTeamProperties GetTeamInfo () const
 
void ResetTeamInfo ()
 
void SetDefaultTeamInfo (const FMortarTeamProperties &DefaultTeamProperties)
 
void SetTeamInfo (const FMortarTeamProperties &DesiredTeam)
 
 UMortarTeamComponent ()
 

Static Public Member Functions

static EMortarAgentAttitude::Type GetAttitude (const uint8 &ATeamID, const uint8 &BTeamID)
 

Public Attributes

FTeamChangeEvent OnTeamChange
 

Static Public Attributes

static uint8 NeutralTeamID
 

Private Attributes

FMortarTeamProperties DefaultTeamInfo
 
FMortarTeamProperties TeamInfo
 

Detailed Description

Generic Actor Component That can be assigned to any Actor Each Actor then can have a team id,name and color and also team

Constructor & Destructor Documentation

◆ UMortarTeamComponent()

UMortarTeamComponent::UMortarTeamComponent ( )

Member Function Documentation

◆ DoSwitchTeam()

bool UMortarTeamComponent::DoSwitchTeam ( const FMortarTeamProperties DesiredTeam)

Tries to switches the team for the player. This will be possible only when Current Team ID is neutral

Parameters
[in]DesiredTeamTeam Properties to Set

◆ GetAttitude()

static EMortarAgentAttitude::Type UMortarTeamComponent::GetAttitude ( const uint8 &  ATeamID,
const uint8 &  BTeamID 
)
static

Static Function to Find Attitude of Two players and returns the attitude

Parameters
[in]ATeamID- Team ID of Player A
[in]BTeamID- Team ID of Player B
Returns
Returns Attitude towards each other as enum => Friendly,Neutral,Hostile

◆ GetDefaultTeamInfo()

FMortarTeamProperties UMortarTeamComponent::GetDefaultTeamInfo ( ) const

Returns Default Team Properties

Returns
Structure containing all team related info

◆ GetTeamInfo()

FMortarTeamProperties UMortarTeamComponent::GetTeamInfo ( ) const

Returns Current Team Properties

Returns
Structure containing all team related info

◆ ResetTeamInfo()

void UMortarTeamComponent::ResetTeamInfo ( )

Resets Team Information to Default

◆ SetDefaultTeamInfo()

void UMortarTeamComponent::SetDefaultTeamInfo ( const FMortarTeamProperties DefaultTeamProperties)

Sets Default Information For a team which can be used later

Parameters
[in]DefaultTeamPropertiesDefault Team Properties to Set

◆ SetTeamInfo()

void UMortarTeamComponent::SetTeamInfo ( const FMortarTeamProperties DesiredTeam)

Sets Information For a team

Parameters
[in]DesiredTeamTeam Properties to Set

Member Data Documentation

◆ DefaultTeamInfo

FMortarTeamProperties UMortarTeamComponent::DefaultTeamInfo
private

Default Team ID - This is The Team information used after every Respawn. So if a player of Team A dies then it will switch back to the default Team after respawning TeamID - Should Be unique and other than 0 which is neutral. Different TeamID means They are enemies.Same TeamID means they are friends TeamName - Each Team Can have a name which can be used in blueprint for different purposes TeamColor - Color For each Team

◆ NeutralTeamID

uint8 UMortarTeamComponent::NeutralTeamID
static

This will be the neutral team id.

◆ OnTeamChange

FTeamChangeEvent UMortarTeamComponent::OnTeamChange

Team Change Event That Will be Broadcasted as soon as Team changes from Neutral to Desired Team in SwitchTeam

◆ TeamInfo

FMortarTeamProperties UMortarTeamComponent::TeamInfo
private

Current Team ID - This is The Team information for Current Spawn. TeamID - Should Be unique and other than 0 which is neutral. Different TeamID means They are enemies.Same TeamID means they are friends TeamName - Each Team Can have a name which can be used in blueprint for different purposes TeamColor - Color For each Team


The documentation for this class was generated from the following file: