#include <AtlasApiUtils.h>

Inheritance diagram for ArkApi::IApiUtils:

Public Member Functions
virtual	~IApiUtils ()=default

virtual UWorld *	GetWorld () const =0
	Returns a pointer to UWorld.

virtual AShooterGameMode *	GetShooterGameMode () const =0
	Returns a pointer to AShooterGameMode.

virtual ServerStatus	GetStatus () const =0
	Returns the current server status.

virtual UShooterCheatManager *	GetCheatManager () const =0
	Returns a point to URCON CheatManager.

template<typename T , typename... Args>
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>
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>
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>
void	SendServerMessageToAll (FLinearColor msg_color, const T *msg, Args &&... args)
	Sends server message to all players. Using fmt::format.

template<typename T , typename... Args>
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>
void	SendChatMessageToAll (const FString &sender_name, const T *msg, Args &&... args)
	Sends chat message to all players. Using fmt::format.

AShooterPlayerController *	FindPlayerFromSteamName (const FString &steam_name) const
	Finds player from the given steam name.

AShooterPlayerController *	FindControllerFromCharacter (AShooterCharacter *character) const
	Finds player controller from the given player character.

TArray< AShooterPlayerController * >	FindPlayerFromCharacterName (const FString &character_name, ESearchCase::Type search, bool full_match) const
	Finds all matching players from the given character name.

AShooterPlayerController *	FindPlayerFromSteamId (uint64 steam_id) const
	Finds player from the given steam id.

APrimalDinoCharacter *	SpawnDino (AShooterPlayerController player, FString blueprint, FVector location, int lvl, bool force_tame, bool neutered) const
	Spawns a dino near player or at specific coordinates.

uint64	GetSteamIDForPlayerID (int player_id) const

AShooterGameState *	GetGameState ()
	Get Shooter Game State.

UPrimalGameData *	GetGameData ()
	Returns pointer to Primal Game Data.

TArray< AActor * >	GetAllActorsInRange (FVector location, float radius, EServerOctreeGroup::Type ActorType)
	Gets all actors in radius at location.

TArray< AActor * >	GetAllActorsInRange (FVector location, float radius, EServerOctreeGroup::Type ActorType, TArray< AActor * > ignores)
	Gets all actors in radius at location, with ignore actors.

virtual	~IApiUtils ()=default

virtual UWorld *	GetWorld () const =0
	Returns a pointer to UWorld.

virtual AShooterGameMode *	GetShooterGameMode () const =0
	Returns a pointer to AShooterGameMode.

virtual ServerStatus	GetStatus () const =0
	Returns the current server status.

virtual UShooterCheatManager *	GetCheatManager () const =0
	Returns a point to URCON CheatManager.

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.

FORCEINLINE AShooterPlayerController *	FindPlayerFromSteamName (const FString &steam_name) const
	Finds player from the given steam name.

FORCEINLINE AShooterPlayerController *	FindControllerFromCharacter (AShooterCharacter *character) const
	Finds player controller from the given player character.

FORCEINLINE TArray< AShooterPlayerController * >	FindPlayerFromCharacterName (const FString &character_name, ESearchCase::Type search, bool full_match) const
	Finds all matching players from the given character name.

FORCEINLINE AShooterPlayerController *	FindPlayerFromSteamId (uint64 steam_id) const
	Finds player from the given steam id.

FORCEINLINE bool	SpawnDrop (const wchar_t *blueprint, FVector pos, int amount, float item_quality=0.0f, bool force_blueprint=false, float life_span=0.0f) const
	Spawns an item drop.

FORCEINLINE APrimalDinoCharacter *	SpawnDino (AShooterPlayerController player, FString blueprint, FVector location, int lvl, bool force_tame, bool neutered) const
	Spawns a dino near player or at specific coordinates.

FORCEINLINE uint64	GetSteamIDForPlayerID (int player_id) const

FORCEINLINE AShooterGameState *	GetGameState ()
	Get Shooter Game State.

FORCEINLINE UPrimalGameData *	GetGameData ()
	Returns pointer to Primal Game Data.

FORCEINLINE TArray< AActor * >	GetAllActorsInRange (FVector location, float radius, EServerOctreeGroup::Type ActorType)
	Gets all actors in radius at location.

FORCEINLINE TArray< AActor * >	GetAllActorsInRange (FVector location, float radius, EServerOctreeGroup::Type ActorType, TArray< AActor * > ignores)
	Gets all actors in radius at location, with ignore actors.

FORCEINLINE MapCoords	FVectorToCoords (FVector actor_position)
	Converts FVector into coords that are displayed when you view the ingame map.

FORCEINLINE uint64	GetAttackerSteamID (AActor target, AController killer, AActor *damage_causer, bool tribe_check=true)
	obtains the steam ID of an attacker, meant to be used in hooks such as TakeDamage

void	RunHiddenCommand (AShooterPlayerController _this, FString Command)

Static Public Member Functions
static uint64	GetSteamIdFromController (AController *controller)
	Returns Steam ID from player controller.

static FString	GetCharacterName (AShooterPlayerController *player_controller, bool include_first_name=true, bool include_last_name=true)
	Returns the character name of player.

static FString	GetSteamName (AController *player_controller)
	Returns the steam name of player.

static bool	IsRidingDino (AShooterPlayerController *player_controller)
	Returns true if character is riding a dino, false otherwise.

static APrimalDinoCharacter *	GetRidingDino (AShooterPlayerController *player_controller)
	Returns the dino the character is riding.

static FVector	GetPosition (APlayerController *player_controller)
	Returns the position of a player.

static std::optional< FString >	TeleportToPlayer (AShooterPlayerController me, AShooterPlayerController him, bool check_for_dino, float max_dist)
	Teleport one player to another.

static bool	TeleportToPos (AShooterPlayerController *player_controller, const FVector &pos)
	Teleports player to the given position.

static int	GetInventoryItemCount (AShooterPlayerController *player_controller, const FString &item_name)
	Counts a specific items quantity.

static FString	GetIPAddress (AShooterPlayerController *player_controller)
	Returns IP address of player.

static FORCEINLINE FString	GetItemBlueprint (UPrimalItem *item)
	Returns blueprint from UPrimalItem.

static bool	IsPlayerDead (AShooterPlayerController *player)
	Returns true if player is dead, false otherwise.

static uint64	GetPlayerID (APrimalCharacter *character)

static uint64	GetPlayerID (AController *controller)

static FORCEINLINE FString	GetBlueprint (UObjectBase *object)
	Returns blueprint path from any UObject.

static FORCEINLINE FString	GetClassBlueprint (UClass *the_class)
	Returns blueprint path from any UClass.

static UShooterCheatManager *	GetCheatManagerByPC (AShooterPlayerController *SPC)
	Get UShooterCheatManager* of player controller.

static FORCEINLINE uint64	GetSteamIdFromController (AController *controller)
	Returns Steam ID from player controller.

static FORCEINLINE FString	GetCharacterName (AShooterPlayerController *player_controller)
	Returns the character name of player.

static FORCEINLINE FString	GetSteamName (AController *player_controller)
	Returns the steam name of player.

static FORCEINLINE bool	IsRidingDino (AShooterPlayerController *player_controller)
	Returns true if character is riding a dino, false otherwise.

static FORCEINLINE APrimalDinoCharacter *	GetRidingDino (AShooterPlayerController *player_controller)
	Returns the dino the character is riding.

static FORCEINLINE FVector	GetPosition (APlayerController *player_controller)
	Returns the position of a player.

static FORCEINLINE std::optional< FString >	TeleportToPlayer (AShooterPlayerController me, AShooterPlayerController him, bool check_for_dino, float max_dist)
	Teleport one player to another.

static FORCEINLINE bool	TeleportToPos (AShooterPlayerController *player_controller, const FVector &pos)
	Teleports player to the given position.

static FORCEINLINE int	GetInventoryItemCount (AShooterPlayerController *player_controller, const FString &item_name)
	Counts a specific items quantity.

static FORCEINLINE FString	GetIPAddress (AShooterPlayerController *player)
	Returns IP address of player.

static FORCEINLINE FString	GetItemBlueprint (UPrimalItem *item)
	Returns blueprint from UPrimalItem.

static FORCEINLINE bool	IsPlayerDead (AShooterPlayerController *player)
	Returns true if player is dead, false otherwise.

static FORCEINLINE uint64	GetPlayerID (APrimalCharacter *character)

static FORCEINLINE uint64	GetPlayerID (AController *controller)

static FORCEINLINE FString	GetBlueprint (UObjectBase *object)
	Returns blueprint path from any UObject.

static FORCEINLINE FString	GetClassBlueprint (UClass *the_class)
	Returns blueprint path from any UClass.

static FORCEINLINE UShooterCheatManager *	GetCheatManagerByPC (AShooterPlayerController *SPC)
	Get UShooterCheatManager* of player controller.

static FORCEINLINE int	GetTribeID (AShooterPlayerController *player_controller)
	Get Tribe ID of player controller.

static FORCEINLINE int	GetTribeID (AShooterCharacter *player_character)
	Get Tribe ID of character.

Private Member Functions
virtual AShooterPlayerController *	FindPlayerFromSteamId_Internal (uint64 steam_id) const =0

virtual AShooterPlayerController *	FindPlayerFromSteamId_Internal (uint64 steam_id) const =0

Detailed Description

Definition at line 11 of file AtlasApiUtils.h.

Constructor & Destructor Documentation

◆ ~IApiUtils() [1/2]

virtual ArkApi::IApiUtils::~IApiUtils ( )

virtualdefault

◆ ~IApiUtils() [2/2]

virtual ArkApi::IApiUtils::~IApiUtils ( )

virtualdefault

Member Function Documentation

◆ FindControllerFromCharacter() [1/2]

FORCEINLINE AShooterPlayerController * ArkApi::IApiUtils::FindControllerFromCharacter ( AShooterCharacter * character ) const

inline

Finds player controller from the given player character.

Parameters

character Player character

Returns: Pointer to AShooterPlayerController

Definition at line 240 of file ArkApiUtils.h.

◆ FindControllerFromCharacter() [2/2]

AShooterPlayerController * ArkApi::IApiUtils::FindControllerFromCharacter ( AShooterCharacter * character ) const

inline

Finds player controller from the given player character.

Parameters

character Player character

Returns: Pointer to AShooterPlayerController

Definition at line 248 of file AtlasApiUtils.h.

Here is the call graph for this function:

◆ FindPlayerFromCharacterName() [1/2]

FORCEINLINE TArray< AShooterPlayerController * > ArkApi::IApiUtils::FindPlayerFromCharacterName	(	const FString &	character_name,
		ESearchCase::Type	search,
		bool	full_match ) const

inline

Finds all matching players from the given character name.

Parameters

character_name	Character name
search	Type Defaulted To ESearchCase::Type::IgnoreCase
full_match	Will match the full length of the string if true

Returns: Array of AShooterPlayerController*

Definition at line 263 of file ArkApiUtils.h.

◆ FindPlayerFromCharacterName() [2/2]

TArray< AShooterPlayerController * > ArkApi::IApiUtils::FindPlayerFromCharacterName	(	const FString &	character_name,
		ESearchCase::Type	search,
		bool	full_match ) const

inline

Finds all matching players from the given character name.

Parameters

character_name	Character name
search	Type Defaulted To ESearchCase::Type::IgnoreCase
full_match	Will match the full length of the string if true

Returns: Array of AShooterPlayerController*

Definition at line 274 of file AtlasApiUtils.h.

Here is the call graph for this function:

◆ FindPlayerFromSteamId() [1/2]

FORCEINLINE AShooterPlayerController * ArkApi::IApiUtils::FindPlayerFromSteamId ( uint64 steam_id ) const

inline

Finds player from the given steam id.

Parameters

steam_id Steam id

Returns: Pointer to AShooterPlayerController

Definition at line 316 of file ArkApiUtils.h.

◆ FindPlayerFromSteamId() [2/2]

AShooterPlayerController * ArkApi::IApiUtils::FindPlayerFromSteamId ( uint64 steam_id ) const

inline

Finds player from the given steam id.

Parameters

steam_id Steam id

Returns: Pointer to AShooterPlayerController

Definition at line 341 of file AtlasApiUtils.h.

Here is the call graph for this function:

◆ FindPlayerFromSteamId_Internal() [1/2]

virtual AShooterPlayerController * ArkApi::IApiUtils::FindPlayerFromSteamId_Internal ( uint64 steam_id ) const

privatepure virtual

Implemented in ArkApi::ApiUtils, and AtlasApi::ApiUtils.

◆ FindPlayerFromSteamId_Internal() [2/2]

virtual AShooterPlayerController * ArkApi::IApiUtils::FindPlayerFromSteamId_Internal ( uint64 steam_id ) const

privatepure virtual

Implemented in ArkApi::ApiUtils, and AtlasApi::ApiUtils.

Here is the caller graph for this function:

◆ FindPlayerFromSteamName() [1/2]

FORCEINLINE AShooterPlayerController * ArkApi::IApiUtils::FindPlayerFromSteamName ( const FString & steam_name ) const

inline

Finds player from the given steam name.

Parameters

steam_name Steam name

Returns: Pointer to AShooterPlayerController

Definition at line 215 of file ArkApiUtils.h.

◆ FindPlayerFromSteamName() [2/2]

AShooterPlayerController * ArkApi::IApiUtils::FindPlayerFromSteamName ( const FString & steam_name ) const

inline

Finds player from the given steam name.

Parameters

steam_name Steam name

Returns: Pointer to AShooterPlayerController

Definition at line 223 of file AtlasApiUtils.h.

Here is the call graph for this function:

◆ FVectorToCoords()

FORCEINLINE MapCoords ArkApi::IApiUtils::FVectorToCoords ( FVector actor_position )

inline

Converts FVector into coords that are displayed when you view the ingame map.

Definition at line 748 of file ArkApiUtils.h.

◆ GetAllActorsInRange() [1/4]

FORCEINLINE TArray< AActor * > ArkApi::IApiUtils::GetAllActorsInRange	(	FVector	location,
		float	radius,
		EServerOctreeGroup::Type	ActorType )

inline

Gets all actors in radius at location.

Definition at line 721 of file ArkApiUtils.h.

◆ GetAllActorsInRange() [2/4]

TArray< AActor * > ArkApi::IApiUtils::GetAllActorsInRange	(	FVector	location,
		float	radius,
		EServerOctreeGroup::Type	ActorType )

inline

Gets all actors in radius at location.

Definition at line 704 of file AtlasApiUtils.h.

Here is the call graph for this function:

◆ GetAllActorsInRange() [3/4]

FORCEINLINE TArray< AActor * > ArkApi::IApiUtils::GetAllActorsInRange	(	FVector	location,
		float	radius,
		EServerOctreeGroup::Type	ActorType,
		TArray< AActor * >	ignores )

inline

Gets all actors in radius at location, with ignore actors.

Definition at line 733 of file ArkApiUtils.h.

◆ GetAllActorsInRange() [4/4]

TArray< AActor * > ArkApi::IApiUtils::GetAllActorsInRange	(	FVector	location,
		float	radius,
		EServerOctreeGroup::Type	ActorType,
		TArray< AActor * >	ignores )

inline

Gets all actors in radius at location, with ignore actors.

Definition at line 716 of file AtlasApiUtils.h.

Here is the call graph for this function:

◆ GetAttackerSteamID()

FORCEINLINE uint64 ArkApi::IApiUtils::GetAttackerSteamID	(	AActor *	target,
		AController *	killer,
		AActor *	damage_causer,
		bool	tribe_check = true )

inline

obtains the steam ID of an attacker, meant to be used in hooks such as TakeDamage

Parameters

tribe_check if set to true will return NULL if the target is from the same tribe as the attacker

Definition at line 776 of file ArkApiUtils.h.

◆ GetBlueprint() [1/2]

static FORCEINLINE FString ArkApi::IApiUtils::GetBlueprint ( UObjectBase * object )

inlinestatic

Returns blueprint path from any UObject.

Definition at line 629 of file ArkApiUtils.h.

◆ GetBlueprint() [2/2]

static FORCEINLINE FString ArkApi::IApiUtils::GetBlueprint ( UObjectBase * object )

inlinestatic

Returns blueprint path from any UObject.

Definition at line 632 of file AtlasApiUtils.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetCharacterName() [1/2]

static FORCEINLINE FString ArkApi::IApiUtils::GetCharacterName ( AShooterPlayerController * player_controller )

inlinestatic

Returns the character name of player.

Parameters

player_controller Player

Definition at line 290 of file ArkApiUtils.h.

◆ GetCharacterName() [2/2]

static FString ArkApi::IApiUtils::GetCharacterName	(	AShooterPlayerController *	player_controller,
		bool	include_first_name = true,
		bool	include_last_name = true )

inlinestatic

Returns the character name of player.

Parameters

player_controller Player

Definition at line 301 of file AtlasApiUtils.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetCheatManager() [1/2]

virtual UShooterCheatManager * ArkApi::IApiUtils::GetCheatManager ( ) const

pure virtual

Returns a point to URCON CheatManager.

Implemented in ArkApi::ApiUtils, and AtlasApi::ApiUtils.

◆ GetCheatManager() [2/2]

virtual UShooterCheatManager * ArkApi::IApiUtils::GetCheatManager ( ) const

pure virtual

Returns a point to URCON CheatManager.

Implemented in ArkApi::ApiUtils, and AtlasApi::ApiUtils.

◆ GetCheatManagerByPC() [1/2]

static FORCEINLINE UShooterCheatManager * ArkApi::IApiUtils::GetCheatManagerByPC ( AShooterPlayerController * SPC )

inlinestatic

Get UShooterCheatManager* of player controller.

Definition at line 665 of file ArkApiUtils.h.

◆ GetCheatManagerByPC() [2/2]

static UShooterCheatManager * ArkApi::IApiUtils::GetCheatManagerByPC ( AShooterPlayerController * SPC )

inlinestatic

Get UShooterCheatManager* of player controller.

Definition at line 678 of file AtlasApiUtils.h.

Here is the call graph for this function:

◆ GetClassBlueprint() [1/2]

static FORCEINLINE FString ArkApi::IApiUtils::GetClassBlueprint ( UClass * the_class )

inlinestatic

Returns blueprint path from any UClass.

Definition at line 642 of file ArkApiUtils.h.

◆ GetClassBlueprint() [2/2]

static FORCEINLINE FString ArkApi::IApiUtils::GetClassBlueprint ( UClass * the_class )

inlinestatic

Returns blueprint path from any UClass.

Definition at line 645 of file AtlasApiUtils.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetGameData() [1/2]

FORCEINLINE UPrimalGameData * ArkApi::IApiUtils::GetGameData ( )

inline

Returns pointer to Primal Game Data.

Definition at line 712 of file ArkApiUtils.h.

◆ GetGameData() [2/2]

UPrimalGameData * ArkApi::IApiUtils::GetGameData ( )

inline

Returns pointer to Primal Game Data.

Definition at line 695 of file AtlasApiUtils.h.

Here is the call graph for this function:

◆ GetGameState() [1/2]

FORCEINLINE AShooterGameState * ArkApi::IApiUtils::GetGameState ( )

inline

Get Shooter Game State.

Definition at line 657 of file ArkApiUtils.h.

◆ GetGameState() [2/2]

AShooterGameState * ArkApi::IApiUtils::GetGameState ( )

inline

Get Shooter Game State.

Definition at line 670 of file AtlasApiUtils.h.

Here is the call graph for this function:

◆ GetInventoryItemCount() [1/2]

static FORCEINLINE int ArkApi::IApiUtils::GetInventoryItemCount	(	AShooterPlayerController *	player_controller,
		const FString &	item_name )

inlinestatic

Counts a specific items quantity.

Parameters

player_controller	Player
item_name	The name of the item you want to count the quantity of

Returns: On success, the function returns amount of items player has. Returns -1 if the function has failed.

Definition at line 531 of file ArkApiUtils.h.

◆ GetInventoryItemCount() [2/2]

static int ArkApi::IApiUtils::GetInventoryItemCount	(	AShooterPlayerController *	player_controller,
		const FString &	item_name )

inlinestatic

Counts a specific items quantity.

Parameters

player_controller	Player
item_name	The name of the item you want to count the quantity of

Returns: On success, the function returns amount of items player has. Returns -1 if the function has failed.

Definition at line 526 of file AtlasApiUtils.h.

Here is the call graph for this function:

◆ GetIPAddress() [1/2]

static FORCEINLINE FString ArkApi::IApiUtils::GetIPAddress ( AShooterPlayerController * player )

inlinestatic

Returns IP address of player.

Definition at line 564 of file ArkApiUtils.h.

◆ GetIPAddress() [2/2]

static FString ArkApi::IApiUtils::GetIPAddress ( AShooterPlayerController * player_controller )

inlinestatic

Returns IP address of player.

Definition at line 559 of file AtlasApiUtils.h.

Here is the call graph for this function:

◆ GetItemBlueprint() [1/2]

static FORCEINLINE FString ArkApi::IApiUtils::GetItemBlueprint ( UPrimalItem * item )

inlinestatic

Returns blueprint from UPrimalItem.

Definition at line 572 of file ArkApiUtils.h.

◆ GetItemBlueprint() [2/2]

static FORCEINLINE FString ArkApi::IApiUtils::GetItemBlueprint ( UPrimalItem * item )

inlinestatic

Returns blueprint from UPrimalItem.

Definition at line 569 of file AtlasApiUtils.h.

Here is the call graph for this function:

◆ GetPlayerID() [1/4]

static FORCEINLINE uint64 ArkApi::IApiUtils::GetPlayerID ( AController * controller )

inlinestatic

Definition at line 598 of file ArkApiUtils.h.

◆ GetPlayerID() [2/4]

static uint64 ArkApi::IApiUtils::GetPlayerID ( AController * controller )

inlinestatic

Definition at line 600 of file AtlasApiUtils.h.

Here is the call graph for this function:

◆ GetPlayerID() [3/4]

static FORCEINLINE uint64 ArkApi::IApiUtils::GetPlayerID ( APrimalCharacter * character )

inlinestatic

Definition at line 590 of file ArkApiUtils.h.

◆ GetPlayerID() [4/4]

static uint64 ArkApi::IApiUtils::GetPlayerID ( APrimalCharacter * character )

inlinestatic

Definition at line 592 of file AtlasApiUtils.h.

Here is the call graph for this function:

◆ GetPosition() [1/2]

static FORCEINLINE FVector ArkApi::IApiUtils::GetPosition ( APlayerController * player_controller )

inlinestatic

Returns the position of a player.

Parameters

player_controller Player

Returns: FVector

Definition at line 468 of file ArkApiUtils.h.

◆ GetPosition() [2/2]

static FVector ArkApi::IApiUtils::GetPosition ( APlayerController * player_controller )

inlinestatic

Returns the position of a player.

Parameters

player_controller Player

Returns: FVector

Definition at line 459 of file AtlasApiUtils.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetRidingDino() [1/2]

static FORCEINLINE APrimalDinoCharacter * ArkApi::IApiUtils::GetRidingDino ( AShooterPlayerController * player_controller )

inlinestatic

Returns the dino the character is riding.

Parameters

player_controller Player

Returns: APrimalDinoCharacter*

Definition at line 456 of file ArkApiUtils.h.

◆ GetRidingDino() [2/2]

static APrimalDinoCharacter * ArkApi::IApiUtils::GetRidingDino ( AShooterPlayerController * player_controller )

inlinestatic

Returns the dino the character is riding.

Parameters

player_controller Player

Returns: APrimalDinoCharacter*

Definition at line 447 of file AtlasApiUtils.h.

Here is the call graph for this function:

◆ GetShooterGameMode() [1/2]

virtual AShooterGameMode * ArkApi::IApiUtils::GetShooterGameMode ( ) const

pure virtual

Returns a pointer to AShooterGameMode.

Implemented in ArkApi::ApiUtils, and AtlasApi::ApiUtils.

◆ GetShooterGameMode() [2/2]

virtual AShooterGameMode * ArkApi::IApiUtils::GetShooterGameMode ( ) const

pure virtual

Returns a pointer to AShooterGameMode.

Implemented in ArkApi::ApiUtils, and AtlasApi::ApiUtils.

Here is the caller graph for this function:

◆ GetStatus() [1/2]

virtual ServerStatus ArkApi::IApiUtils::GetStatus ( ) const

pure virtual

Returns the current server status.

Implemented in ArkApi::ApiUtils, and AtlasApi::ApiUtils.

◆ GetStatus() [2/2]

virtual ServerStatus ArkApi::IApiUtils::GetStatus ( ) const

pure virtual

Returns the current server status.

Implemented in ArkApi::ApiUtils, and AtlasApi::ApiUtils.

◆ GetSteamIDForPlayerID() [1/2]

FORCEINLINE uint64 ArkApi::IApiUtils::GetSteamIDForPlayerID ( int player_id ) const

inline

Definition at line 604 of file ArkApiUtils.h.

◆ GetSteamIDForPlayerID() [2/2]

uint64 ArkApi::IApiUtils::GetSteamIDForPlayerID ( int player_id ) const

inline

Definition at line 606 of file AtlasApiUtils.h.

Here is the call graph for this function:

◆ GetSteamIdFromController() [1/2]

static FORCEINLINE uint64 ArkApi::IApiUtils::GetSteamIdFromController ( AController * controller )

inlinestatic

Returns Steam ID from player controller.

Definition at line 197 of file ArkApiUtils.h.

◆ GetSteamIdFromController() [2/2]

static uint64 ArkApi::IApiUtils::GetSteamIdFromController ( AController * controller )

inlinestatic

Returns Steam ID from player controller.

Definition at line 190 of file AtlasApiUtils.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetSteamName() [1/2]

static FORCEINLINE FString ArkApi::IApiUtils::GetSteamName ( AController * player_controller )

inlinestatic

Returns the steam name of player.

Parameters

player_controller Player

Definition at line 306 of file ArkApiUtils.h.

◆ GetSteamName() [2/2]

static FString ArkApi::IApiUtils::GetSteamName ( AController * player_controller )

inlinestatic

Returns the steam name of player.

Parameters

player_controller Player

Definition at line 331 of file AtlasApiUtils.h.

Here is the call graph for this function:

◆ GetTribeID() [1/2]

static FORCEINLINE int ArkApi::IApiUtils::GetTribeID ( AShooterCharacter * player_character )

inlinestatic

Get Tribe ID of character.

Definition at line 697 of file ArkApiUtils.h.

◆ GetTribeID() [2/2]

static FORCEINLINE int ArkApi::IApiUtils::GetTribeID ( AShooterPlayerController * player_controller )

inlinestatic

Get Tribe ID of player controller.

Definition at line 682 of file ArkApiUtils.h.

◆ GetWorld() [1/2]

virtual UWorld * ArkApi::IApiUtils::GetWorld ( ) const

pure virtual

Returns a pointer to UWorld.

Implemented in ArkApi::ApiUtils, and AtlasApi::ApiUtils.

◆ GetWorld() [2/2]

virtual UWorld * ArkApi::IApiUtils::GetWorld ( ) const

pure virtual

Returns a pointer to UWorld.

Implemented in ArkApi::ApiUtils, and AtlasApi::ApiUtils.

Here is the caller graph for this function:

◆ IsPlayerDead() [1/2]

static FORCEINLINE bool ArkApi::IApiUtils::IsPlayerDead ( AShooterPlayerController * player )

inlinestatic

Returns true if player is dead, false otherwise.

Definition at line 580 of file ArkApiUtils.h.

◆ IsPlayerDead() [2/2]

static bool ArkApi::IApiUtils::IsPlayerDead ( AShooterPlayerController * player )

inlinestatic

Returns true if player is dead, false otherwise.

Definition at line 582 of file AtlasApiUtils.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ IsRidingDino() [1/2]

static FORCEINLINE bool ArkApi::IApiUtils::IsRidingDino ( AShooterPlayerController * player_controller )

inlinestatic

Returns true if character is riding a dino, false otherwise.

Parameters

player_controller Player

Definition at line 445 of file ArkApiUtils.h.

◆ IsRidingDino() [2/2]

static bool ArkApi::IApiUtils::IsRidingDino ( AShooterPlayerController * player_controller )

inlinestatic

Returns true if character is riding a dino, false otherwise.

Parameters

player_controller Player

Definition at line 436 of file AtlasApiUtils.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ RunHiddenCommand()

void ArkApi::IApiUtils::RunHiddenCommand	(	AShooterPlayerController *	_this,
		FString *	Command )

inline

Definition at line 796 of file ArkApiUtils.h.

◆ SendChatMessage() [1/2]

template<typename T , typename... Args>

FORCEINLINE void ArkApi::IApiUtils::SendChatMessage	(	AShooterPlayerController *	player_controller,
		const FString &	sender_name,
		const T *	msg,
		Args &&...	args )

inline

Sends chat message to the specific player. Using fmt::format.

Template Parameters

T	Either a a char or wchar_t
Args	Optional arguments types

Parameters

player_controller	Player
sender_name	Name of the sender
msg	Message
args	Optional arguments

Definition at line 97 of file ArkApiUtils.h.

◆ SendChatMessage() [2/2]

template<typename T , typename... Args>

void ArkApi::IApiUtils::SendChatMessage	(	AShooterPlayerController *	player_controller,
		const FString &	sender_name,
		const T *	msg,
		Args &&...	args )

inline

Sends chat message to the specific player. Using fmt::format.

Template Parameters

T	Either a a char or wchar_t
Args	Optional arguments types

Parameters

player_controller	Player
sender_name	Name of the sender
msg	Message
args	Optional arguments

Definition at line 90 of file AtlasApiUtils.h.

◆ SendChatMessageToAll() [1/2]

template<typename T , typename... Args>

FORCEINLINE void ArkApi::IApiUtils::SendChatMessageToAll	(	const FString &	sender_name,
		const T *	msg,
		Args &&...	args )

inline

Sends chat message to all players. Using fmt::format.

Template Parameters

T	Either a a char or wchar_t
Args	Optional arguments types

Parameters

sender_name	Name of the sender
msg	Message
args	Optional arguments

Definition at line 175 of file ArkApiUtils.h.

◆ SendChatMessageToAll() [2/2]

template<typename T , typename... Args>

void ArkApi::IApiUtils::SendChatMessageToAll	(	const FString &	sender_name,
		const T *	msg,
		Args &&...	args )

inline

Sends chat message to all players. Using fmt::format.

Template Parameters

T	Either a a char or wchar_t
Args	Optional arguments types

Parameters

sender_name	Name of the sender
msg	Message
args	Optional arguments

Definition at line 168 of file AtlasApiUtils.h.

◆ SendNotification() [1/2]

template<typename T , typename... Args>

FORCEINLINE void ArkApi::IApiUtils::SendNotification	(	AShooterPlayerController *	player_controller,
		FLinearColor	color,
		float	display_scale,
		float	display_time,
		UTexture2D *	icon,
		const T *	msg,
		Args &&...	args )

inline

Sends notification (on-screen message) to the specific player. Using fmt::format.

Template Parameters

T	Either a a char or wchar_t
Args	Optional arguments types

Parameters

player_controller	Player
color	Message color
display_scale	Size of text
display_time	Display time
icon	Message icon (optional)
msg	Message
args	Optional arguments

Definition at line 75 of file ArkApiUtils.h.

◆ SendNotification() [2/2]

template<typename T , typename... Args>

void ArkApi::IApiUtils::SendNotification	(	AShooterPlayerController *	player_controller,
		FLinearColor	color,
		float	display_scale,
		float	display_time,
		UTexture2D *	icon,
		const T *	msg,
		Args &&...	args )

inline

Sends notification (on-screen message) to the specific player. Using fmt::format.

Template Parameters

T	Either a a char or wchar_t
Args	Optional arguments types

Parameters

player_controller	Player
color	Message color
display_scale	Size of text
display_time	Display time
icon	Message icon (optional)
msg	Message
args	Optional arguments

Definition at line 68 of file AtlasApiUtils.h.

◆ SendNotificationToAll() [1/2]

template<typename T , typename... Args>

FORCEINLINE void ArkApi::IApiUtils::SendNotificationToAll	(	FLinearColor	color,
		float	display_scale,
		float	display_time,
		UTexture2D *	icon,
		const T *	msg,
		Args &&...	args )

inline

Sends notification (on-screen message) to all players. Using fmt::format.

Template Parameters

T	Either a a char or wchar_t
Args	Optional arguments types

Parameters

color	Message color
display_scale	Size of text
display_time	Display time
icon	Message icon (optional)
msg	Message
args	Optional arguments

Definition at line 149 of file ArkApiUtils.h.

◆ SendNotificationToAll() [2/2]

template<typename T , typename... Args>

void ArkApi::IApiUtils::SendNotificationToAll	(	FLinearColor	color,
		float	display_scale,
		float	display_time,
		UTexture2D *	icon,
		const T *	msg,
		Args &&...	args )

inline

Sends notification (on-screen message) to all players. Using fmt::format.

Template Parameters

T	Either a a char or wchar_t
Args	Optional arguments types

Parameters

color	Message color
display_scale	Size of text
display_time	Display time
icon	Message icon (optional)
msg	Message
args	Optional arguments

Definition at line 142 of file AtlasApiUtils.h.

◆ SendServerMessage() [1/2]

template<typename T , typename... Args>

FORCEINLINE void ArkApi::IApiUtils::SendServerMessage	(	AShooterPlayerController *	player_controller,
		FLinearColor	msg_color,
		const T *	msg,
		Args &&...	args )

inline

Sends server message to the specific player. Using fmt::format.

Template Parameters

T	Either a a char or wchar_t
Args	Optional arguments types

Parameters

player_controller	Player
msg_color	Message color
msg	Message
args	Optional arguments

Definition at line 52 of file ArkApiUtils.h.

◆ SendServerMessage() [2/2]

template<typename T , typename... Args>

void ArkApi::IApiUtils::SendServerMessage	(	AShooterPlayerController *	player_controller,
		FLinearColor	msg_color,
		const T *	msg,
		Args &&...	args )

inline

Sends server message to the specific player. Using fmt::format.

Template Parameters

T	Either a a char or wchar_t
Args	Optional arguments types

Parameters

player_controller	Player
msg_color	Message color
msg	Message
args	Optional arguments

Definition at line 45 of file AtlasApiUtils.h.

◆ SendServerMessageToAll() [1/2]

template<typename T , typename... Args>

FORCEINLINE void ArkApi::IApiUtils::SendServerMessageToAll	(	FLinearColor	msg_color,
		const T *	msg,
		Args &&...	args )

inline

Sends server message to all players. Using fmt::format.

Template Parameters

T	Either a a char or wchar_t
Args	Optional arguments types

Parameters

msg_color	Message color
msg	Message
args	Optional arguments

Definition at line 121 of file ArkApiUtils.h.

◆ SendServerMessageToAll() [2/2]

template<typename T , typename... Args>

void ArkApi::IApiUtils::SendServerMessageToAll	(	FLinearColor	msg_color,
		const T *	msg,
		Args &&...	args )

inline

Sends server message to all players. Using fmt::format.

Template Parameters

T	Either a a char or wchar_t
Args	Optional arguments types

Parameters

msg_color	Message color
msg	Message
args	Optional arguments

Definition at line 114 of file AtlasApiUtils.h.

◆ SpawnDino() [1/2]

FORCEINLINE APrimalDinoCharacter * ArkApi::IApiUtils::SpawnDino	(	AShooterPlayerController *	player,
		FString	blueprint,
		FVector *	location,
		int	lvl,
		bool	force_tame,
		bool	neutered ) const

inline

Spawns a dino near player or at specific coordinates.

Parameters

player	Player. If null, random player will be chosen. At least one player should be on the map
blueprint	Blueprint path
location	Spawn position. If null, dino will be spawned near player
lvl	Level of the dino
force_tame	Force tame
neutered	Neuter dino

Returns: Spawned dino or null

Definition at line 387 of file ArkApiUtils.h.

◆ SpawnDino() [2/2]

APrimalDinoCharacter * ArkApi::IApiUtils::SpawnDino	(	AShooterPlayerController *	player,
		FString	blueprint,
		FVector *	location,
		int	lvl,
		bool	force_tame,
		bool	neutered ) const

inline

Spawns a dino near player or at specific coordinates.

Parameters

player	Player. If null, random player will be chosen. At least one player should be on the map
blueprint	Blueprint path
location	Spawn position. If null, dino will be spawned near player
lvl	Level of the dino
force_tame	Force tame
neutered	Neuter dino

Returns: Spawned dino or null

Definition at line 378 of file AtlasApiUtils.h.

Here is the call graph for this function:

◆ SpawnDrop()

FORCEINLINE bool ArkApi::IApiUtils::SpawnDrop	(	const wchar_t *	blueprint,
		FVector	pos,
		int	amount,
		float	item_quality = 0.0f,
		bool	force_blueprint = false,
		float	life_span = 0.0f ) const

inline

Spawns an item drop.

Parameters

blueprint	Item simplified BP Example: '/Game/PrimalEarth/CoreBlueprints/Items/Armor/Riot/PrimalItemArmor_RiotPants.PrimalItemArmor_RiotPants_C'
pos	Spawn position
amount	Quantity
item_quality	Quality
force_blueprint	Is blueprint
life_span	Life span

Returns: Returns true if drop was spawned, false otherwise

Definition at line 332 of file ArkApiUtils.h.

◆ TeleportToPlayer() [1/2]

static FORCEINLINE std::optional< FString > ArkApi::IApiUtils::TeleportToPlayer	(	AShooterPlayerController *	me,
		AShooterPlayerController *	him,
		bool	check_for_dino,
		float	max_dist )

inlinestatic

Teleport one player to another.

Parameters

me	Player
him	Other Player
check_for_dino	If set true prevents players teleporting with dino's or teleporting to a player on a dino
max_dist	Is the max distance the characters can be away from each other -1 is disabled

Definition at line 480 of file ArkApiUtils.h.

◆ TeleportToPlayer() [2/2]

static std::optional< FString > ArkApi::IApiUtils::TeleportToPlayer	(	AShooterPlayerController *	me,
		AShooterPlayerController *	him,
		bool	check_for_dino,
		float	max_dist )

inlinestatic

Teleport one player to another.

Parameters

me	Player
him	Other Player
check_for_dino	If set true prevents players teleporting with dino's or teleporting to a player on a dino
max_dist	Is the max distance the characters can be away from each other -1 is disabled

Definition at line 475 of file AtlasApiUtils.h.

Here is the call graph for this function:

◆ TeleportToPos() [1/2]

static FORCEINLINE bool ArkApi::IApiUtils::TeleportToPos	(	AShooterPlayerController *	player_controller,
		const FVector &	pos )

inlinestatic

Teleports player to the given position.

Parameters

player_controller	Player
pos	New position

Definition at line 514 of file ArkApiUtils.h.

◆ TeleportToPos() [2/2]

static bool ArkApi::IApiUtils::TeleportToPos	(	AShooterPlayerController *	player_controller,
		const FVector &	pos )

inlinestatic

Teleports player to the given position.

Parameters

player_controller	Player
pos	New position

Definition at line 509 of file AtlasApiUtils.h.

Here is the call graph for this function:

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

C:/Users/lachl/Downloads/ArkServerAPI_NEW/ASE/AseApi-main/version/Core/Public/Atlas/AtlasApiUtils.h
C:/Users/lachl/Downloads/ArkServerAPI_NEW/ASE/AseApi-main/version/Core/Public/Ark/ArkApiUtils.h

Public Member Functions

Static Public Member Functions

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~IApiUtils() [1/2]

◆ ~IApiUtils() [2/2]

Member Function Documentation

◆ FindControllerFromCharacter() [1/2]

◆ FindControllerFromCharacter() [2/2]

◆ FindPlayerFromCharacterName() [1/2]

◆ FindPlayerFromCharacterName() [2/2]

◆ FindPlayerFromSteamId() [1/2]

◆ FindPlayerFromSteamId() [2/2]

◆ FindPlayerFromSteamId_Internal() [1/2]

◆ FindPlayerFromSteamId_Internal() [2/2]

◆ FindPlayerFromSteamName() [1/2]

◆ FindPlayerFromSteamName() [2/2]

◆ FVectorToCoords()

◆ GetAllActorsInRange() [1/4]

◆ GetAllActorsInRange() [2/4]

◆ GetAllActorsInRange() [3/4]

◆ GetAllActorsInRange() [4/4]

◆ GetAttackerSteamID()

◆ GetBlueprint() [1/2]

◆ GetBlueprint() [2/2]

◆ GetCharacterName() [1/2]

◆ GetCharacterName() [2/2]

◆ GetCheatManager() [1/2]

◆ GetCheatManager() [2/2]

◆ GetCheatManagerByPC() [1/2]

◆ GetCheatManagerByPC() [2/2]

◆ GetClassBlueprint() [1/2]

◆ GetClassBlueprint() [2/2]

◆ GetGameData() [1/2]

◆ GetGameData() [2/2]

◆ GetGameState() [1/2]

◆ GetGameState() [2/2]

◆ GetInventoryItemCount() [1/2]

◆ GetInventoryItemCount() [2/2]

◆ GetIPAddress() [1/2]

◆ GetIPAddress() [2/2]

◆ GetItemBlueprint() [1/2]

◆ GetItemBlueprint() [2/2]

◆ GetPlayerID() [1/4]

◆ GetPlayerID() [2/4]

◆ GetPlayerID() [3/4]

◆ GetPlayerID() [4/4]

◆ GetPosition() [1/2]

◆ GetPosition() [2/2]

◆ GetRidingDino() [1/2]

◆ GetRidingDino() [2/2]

◆ GetShooterGameMode() [1/2]

◆ GetShooterGameMode() [2/2]

◆ GetStatus() [1/2]

◆ GetStatus() [2/2]

◆ GetSteamIDForPlayerID() [1/2]

◆ GetSteamIDForPlayerID() [2/2]

◆ GetSteamIdFromController() [1/2]

◆ GetSteamIdFromController() [2/2]

◆ GetSteamName() [1/2]

◆ GetSteamName() [2/2]

◆ GetTribeID() [1/2]

◆ GetTribeID() [2/2]

◆ GetWorld() [1/2]

◆ GetWorld() [2/2]

◆ IsPlayerDead() [1/2]

◆ IsPlayerDead() [2/2]

◆ IsRidingDino() [1/2]

◆ IsRidingDino() [2/2]

◆ RunHiddenCommand()

◆ SendChatMessage() [1/2]

◆ SendChatMessage() [2/2]

◆ SendChatMessageToAll() [1/2]

◆ SendChatMessageToAll() [2/2]

◆ SendNotification() [1/2]

◆ SendNotification() [2/2]

◆ SendNotificationToAll() [1/2]

◆ SendNotificationToAll() [2/2]

◆ SendServerMessage() [1/2]