AsaApiModUtils Namespace Reference

Functions
FORCEINLINE AActor *	GetSingleton ()
	Returns the actor singleton, and loads the weak reference to the singleton actor.
FORCEINLINE void	DrawDebugLine (FVector Start, FVector End, FLinearColor Color, int Duration)
	Draw a line in the world for all players to see.
FORCEINLINE TWeakObjectPtr< AActor >	DrawSphere (const DrawDebugSphere_Params &params)
	Draw a sphere in the world.
FORCEINLINE FString	AddNotification (const AsaApiUtilsNotification &notificationParams)
	Add a notification to the player's screen or to the chat box.
FORCEINLINE APrimalBuff_ApiUtils *	GetBuffForPlayer (AShooterCharacter *Character)
	This is a helper function to get the buff for the player.
FORCEINLINE APrimalBuff_ApiUtils *	GetBuffForPlayer (AShooterPlayerController *PC)
	This is a helper function to get the buff for the player.
FORCEINLINE APrimalBuff_ApiUtils *	GetBuffForPlayer (APlayerController *PC)
	This is a helper function to get the buff for the player.

Variables
TWeakObjectPtr< AActor >	Singleton

Function Documentation

AddNotification()

FORCEINLINE FString AsaApiModUtils::AddNotification

(

const AsaApiUtilsNotification &

notificationParams

)

Add a notification to the player's screen or to the chat box.

Parameters

Text	The text to display
RecipientEOS	The player IDs to display the notification to
BackgroundColor	The background color of the notification
TextColor	The text color of the notification
TextScale	The scale of the text
Duration	The duration of the notification in seconds
TextJustification	The justification of the text
ScreenPosition	The position of the notification on the screen
bAddToChat	Whether or not to add the notification to the chat box

Returns

The notification ID

Definition at line 97 of file AsaApiModUtils.hpp.

Here is the call graph for this function:

Here is the caller graph for this function:

DrawDebugLine()

FORCEINLINE void AsaApiModUtils::DrawDebugLine	(	FVector	Start,
		FVector	End,
		FLinearColor	Color,
		int	Duration )

Draw a line in the world for all players to see.

Parameters

Start	The start location of the line
End	The end location of the line
Color	The color of the line
Duration	The duration of the line in seconds

Definition at line 44 of file AsaApiModUtils.hpp.

Here is the call graph for this function:

DrawSphere()

FORCEINLINE TWeakObjectPtr< AActor > AsaApiModUtils::DrawSphere

(

const DrawDebugSphere_Params &

params

)

Draw a sphere in the world.

It will be drawn for all players if ForPlayerID is -1, and for all tribes if ForTribeID is -1, otherwise it will only be drawn for the specified player or tribe

Duration is in seconds, and set in Actor->SetLifeSpan(Duration)

Parameters

Center	The center of the sphere
Radius	The radius of the sphere
ForPlayerID	The player ID to draw the sphere for, -1 for all players
ForTribeID	The tribe ID to draw the sphere for, -1 for all tribes
Color	The color of the sphere
Duration	The duration of the sphere in seconds
drawType	The type of sphere to draw

Returns

The sphere actor

Definition at line 71 of file AsaApiModUtils.hpp.

Here is the call graph for this function:

GetBuffForPlayer() [1/3]

FORCEINLINE APrimalBuff_ApiUtils * AsaApiModUtils::GetBuffForPlayer

(

APlayerController *

PC

)

This is a helper function to get the buff for the player.

Parameters

PC	The player controller to get the buff for

Returns

The buff for the player

Definition at line 147 of file AsaApiModUtils.hpp.

Here is the call graph for this function:

GetBuffForPlayer() [2/3]

FORCEINLINE APrimalBuff_ApiUtils * AsaApiModUtils::GetBuffForPlayer

(

AShooterCharacter *

Character

)

This is a helper function to get the buff for the player.

Parameters

Character

The character to get the buff for

Returns

The buff for the player

Definition at line 116 of file AsaApiModUtils.hpp.

GetBuffForPlayer() [3/3]

FORCEINLINE APrimalBuff_ApiUtils * AsaApiModUtils::GetBuffForPlayer

(

AShooterPlayerController *

PC

)

This is a helper function to get the buff for the player.

Parameters

PC	The player controller to get the buff for

Returns

The buff for the player

Definition at line 137 of file AsaApiModUtils.hpp.

Here is the caller graph for this function:

GetSingleton()

FORCEINLINE AActor * AsaApiModUtils::GetSingleton

(

)

Returns the actor singleton, and loads the weak reference to the singleton actor.

Returns

The actor singleton

Definition at line 14 of file AsaApiModUtils.hpp.

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

Singleton

TWeakObjectPtr<AActor> AsaApiModUtils::Singleton

Definition at line 8 of file AsaApiModUtils.hpp.