Ark Server API (ASA) - Wiki
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | List of all members
AsaApiUtilsMessagingManager Class Reference

#include <AsaApiUtilsMessagingManager.h>

+ Inheritance diagram for AsaApiUtilsMessagingManager:
+ Collaboration diagram for AsaApiUtilsMessagingManager:

Public Member Functions

std::optional< std::string > MeetsRequirementsToWork () override
 Returns wether this messaging manager is able to work in the current session.
 
FORCEINLINE FString SendNotificationPrettyToPlayer (APlayerController *PC, const FString &Text, const FLinearColor &BackgroundColor, const FLinearColor &TextColor, const double TextScale, const double Duration, const Position TextJustification, const Position ScreenPosition, const bool bAddToChat)
 
FORCEINLINE FString SendNotificationPrettyToPlayer (const FString &EOSid, const FString &Text, const FLinearColor &BackgroundColor, const FLinearColor &TextColor, const double TextScale, const double Duration, const Position TextJustification, const Position ScreenPosition, const bool bAddToChat)
 
FORCEINLINE FString SendNotificationPrettyToPlayers (TArray< APlayerController * > PCs, const FString &Text, const FLinearColor &BackgroundColor, const FLinearColor &TextColor, const double TextScale, const double Duration, const Position TextJustification, const Position ScreenPosition, const bool bAddToChat)
 
FORCEINLINE FString SendNotificationPrettyToPlayers (const TArray< FString > &IDs, const FString &Text, const FLinearColor &BackgroundColor, const FLinearColor &TextColor, const double TextScale, const double Duration, const Position TextJustification, const Position ScreenPosition, const bool bAddToChat)
 
- Public Member Functions inherited from MessagingManager
template<typename T , typename... Args>
FORCEINLINE void SendServerMessage (AShooterPlayerController *player_controller, FLinearColor msg_color, const T *msg, Args &&... args)
 Sends server message to the specific player. Using fmt::format.
 
template<typename T , typename... Args>
FORCEINLINE void SendNotification (AShooterPlayerController *player_controller, FLinearColor color, float display_scale, float display_time, UTexture2D *icon, const T *msg, Args &&... args)
 Sends notification (on-screen message) to the specific player. Using fmt::format.
 
template<typename T , typename... Args>
FORCEINLINE void SendChatMessage (AShooterPlayerController *player_controller, const FString &sender_name, const T *msg, Args &&... args)
 Sends chat message to the specific player. Using fmt::format.
 
template<typename T , typename... Args>
FORCEINLINE void SendServerMessageToAll (FLinearColor msg_color, const T *msg, Args &&... args)
 Sends server message to all players. Using fmt::format.
 
template<typename T , typename... Args>
FORCEINLINE void SendNotificationToAll (FLinearColor color, float display_scale, float display_time, UTexture2D *icon, const T *msg, Args &&... args)
 Sends notification (on-screen message) to all players. Using fmt::format.
 
template<typename T , typename... Args>
FORCEINLINE void SendChatMessageToAll (const FString &sender_name, const T *msg, Args &&... args)
 Sends chat message to all players. Using fmt::format.
 
void SetWorldContext (UWorld *world_context)
 Sets the world context. This is called by the API automatically.
 

Protected Member Functions

void SendServerMessage_Impl (AShooterPlayerController *player_controller, FLinearColor msg_color, const FString &msg) override
 
void SendNotification_Impl (AShooterPlayerController *player_controller, FLinearColor color, float display_scale, float display_time, UTexture2D *icon, const FString &msg) override
 
- Protected Member Functions inherited from MessagingManager
virtual void SendChatMessage_Impl (AShooterPlayerController *player_controller, const FString &sender_name, const FString &msg)
 

Additional Inherited Members

- Protected Attributes inherited from MessagingManager
 : virtual void SendServerMessage_Impl(AShooterPlayerController* player_controller
 
FLinearColor msg_color
 
FLinearColor const FString & msg
 
player_controller ClientServerChatDirectMessage & msg
 
 : UWorld* WorldContext = nullptr
 

Detailed Description

Definition at line 6 of file AsaApiUtilsMessagingManager.h.

Member Function Documentation

◆ MeetsRequirementsToWork()

std::optional< std::string > AsaApiUtilsMessagingManager::MeetsRequirementsToWork ( )
inlineoverridevirtual

Returns wether this messaging manager is able to work in the current session.

The default one does not depend in any mod or external service so it always returns true.

Subclasses should redefine this function if they depend on any external service.

If it returns an error, it will be removed and the plugin will fall back to the default API messaging manager.

Returns
Empty optional if no error, or optional filled with error string.

Reimplemented from MessagingManager.

Definition at line 9 of file AsaApiUtilsMessagingManager.h.

+ Here is the call graph for this function:

◆ SendNotification_Impl()

void AsaApiUtilsMessagingManager::SendNotification_Impl ( AShooterPlayerController * player_controller,
FLinearColor color,
float display_scale,
float display_time,
UTexture2D * icon,
const FString & msg )
inlineoverrideprotectedvirtual

Reimplemented from MessagingManager.

Definition at line 59 of file AsaApiUtilsMessagingManager.h.

◆ SendNotificationPrettyToPlayer() [1/2]

FORCEINLINE FString AsaApiUtilsMessagingManager::SendNotificationPrettyToPlayer ( APlayerController * PC,
const FString & Text,
const FLinearColor & BackgroundColor,
const FLinearColor & TextColor,
const double TextScale,
const double Duration,
const Position TextJustification,
const Position ScreenPosition,
const bool bAddToChat )
inline

Definition at line 18 of file AsaApiUtilsMessagingManager.h.

+ Here is the call graph for this function:

◆ SendNotificationPrettyToPlayer() [2/2]

FORCEINLINE FString AsaApiUtilsMessagingManager::SendNotificationPrettyToPlayer ( const FString & EOSid,
const FString & Text,
const FLinearColor & BackgroundColor,
const FLinearColor & TextColor,
const double TextScale,
const double Duration,
const Position TextJustification,
const Position ScreenPosition,
const bool bAddToChat )
inline

Definition at line 25 of file AsaApiUtilsMessagingManager.h.

+ Here is the caller graph for this function:

◆ SendNotificationPrettyToPlayers() [1/2]

FORCEINLINE FString AsaApiUtilsMessagingManager::SendNotificationPrettyToPlayers ( const TArray< FString > & IDs,
const FString & Text,
const FLinearColor & BackgroundColor,
const FLinearColor & TextColor,
const double TextScale,
const double Duration,
const Position TextJustification,
const Position ScreenPosition,
const bool bAddToChat )
inline

Definition at line 43 of file AsaApiUtilsMessagingManager.h.

+ Here is the call graph for this function:

◆ SendNotificationPrettyToPlayers() [2/2]

FORCEINLINE FString AsaApiUtilsMessagingManager::SendNotificationPrettyToPlayers ( TArray< APlayerController * > PCs,
const FString & Text,
const FLinearColor & BackgroundColor,
const FLinearColor & TextColor,
const double TextScale,
const double Duration,
const Position TextJustification,
const Position ScreenPosition,
const bool bAddToChat )
inline

Definition at line 34 of file AsaApiUtilsMessagingManager.h.

◆ SendServerMessage_Impl()

void AsaApiUtilsMessagingManager::SendServerMessage_Impl ( AShooterPlayerController * player_controller,
FLinearColor msg_color,
const FString & msg )
inlineoverrideprotected

Definition at line 51 of file AsaApiUtilsMessagingManager.h.

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