![]() |
Ark Server API (ASA) - Wiki
|
#include <ArkApiUtils.h>
Inheritance diagram for AsaApi::IApiUtils:Private Member Functions | |
| virtual AShooterPlayerController * | FindPlayerFromEOSID_Internal (const FString &eos_id) const =0 |
| virtual std::shared_ptr< MessagingManager > | GetMessagingManagerInternal (const FString &forPlugin) const =0 |
| virtual void | SetMessagingManagerInternal (const FString &forPlugin, std::shared_ptr< MessagingManager > manager)=0 |
Definition at line 20 of file ArkApiUtils.h.
|
virtualdefault |
|
inlinestatic |
Create a new object of T, with the correct size.
| T | struct type. Must have ScriptStruct defined |
Definition at line 744 of file ArkApiUtils.h.
|
inline |
Finds player controller from the given player character.
| character | Player character |
Definition at line 182 of file ArkApiUtils.h.
Here is the call graph for this function:
|
inline |
Finds all matching players from the given character name.
| character_name | Character name |
| search | Type Defaulted To ESearchCase::Type::IgnoreCase |
| full_match | Will match the full length of the string if true |
Definition at line 199 of file ArkApiUtils.h.
Here is the call graph for this function:
|
inline |
Finds player from the given eos id.
| eos_id | EOS id |
Definition at line 250 of file ArkApiUtils.h.
Here is the call graph for this function:
|
privatepure virtual |
|
inline |
Finds player from the given platform name (can be steam, Playstation, Xbox, etc...)
| steam_name | Platform name |
Definition at line 158 of file ArkApiUtils.h.
Here is the call graph for this function:
|
inlinestatic |
Free a struct allocated.
| obj | Pointer to struct |
Definition at line 756 of file ArkApiUtils.h.
Here is the call graph for this function:
Here is the caller graph for this function:
|
inline |
Converts FVector into coords that are displayed when you view the ingame map.
Definition at line 691 of file ArkApiUtils.h.
Here is the call graph for this function:
|
inline |
Gets all actors in radius at location.
Definition at line 664 of file ArkApiUtils.h.
|
inline |
Gets all actors in radius at location, with ignore actors.
Definition at line 676 of file ArkApiUtils.h.
|
inline |
obtains the steam ID of an attacker, meant to be used in hooks such as TakeDamage
| tribe_check | if set to true will return NULL if the target is from the same tribe as the attacker |
Definition at line 718 of file ArkApiUtils.h.
Here is the call graph for this function:
|
inlinestatic |
Returns blueprint path from any UObject.
Definition at line 567 of file ArkApiUtils.h.
Here is the call graph for this function:
Here is the caller graph for this function:
|
inlinestatic |
Returns the character name of player.
| player_controller | Player |
Definition at line 224 of file ArkApiUtils.h.
Here is the call graph for this function:
|
pure virtual |
Returns a point to URCON CheatManager.
Implemented in AsaApi::ApiUtils.
|
inlinestatic |
Get UShooterCheatManager* of player controller.
Definition at line 608 of file ArkApiUtils.h.
|
inlinestatic |
Returns blueprint path from any UClass.
Definition at line 581 of file ArkApiUtils.h.
Here is the call graph for this function:
Here is the caller graph for this function:
|
inline |
Definition at line 532 of file ArkApiUtils.h.
Here is the call graph for this function:
Here is the caller graph for this function:
|
inlinestatic |
Returns EOS ID from player controller.
Definition at line 142 of file ArkApiUtils.h.
Here is the caller graph for this function:
|
inline |
Returns pointer to Primal Game Data.
Definition at line 655 of file ArkApiUtils.h.
Here is the call graph for this function:
|
inline |
Get Shooter Game State.
Definition at line 600 of file ArkApiUtils.h.
|
inlinestatic |
Counts a specific items quantity.
| player_controller | Player |
| item_name | The name of the item you want to count the quantity of |
Definition at line 456 of file ArkApiUtils.h.
|
inlinestatic |
Returns IP address of player.
Definition at line 489 of file ArkApiUtils.h.
Here is the call graph for this function:
|
inlinestatic |
Returns blueprint from UPrimalItem.
Definition at line 500 of file ArkApiUtils.h.
Here is the call graph for this function:
|
inline |
Gets the current messaging manager for the plugin, without casting.
Definition at line 778 of file ArkApiUtils.h.
|
inline |
Gets the current messaging manager for the plugin.
| T | MessagingManager type |
Definition at line 789 of file ArkApiUtils.h.
|
privatepure virtual |
Implemented in AsaApi::ApiUtils.
|
inlinestatic |
|
inlinestatic |
|
inlinestatic |
Returns the position of a player.
| player_controller | Player |
Definition at line 389 of file ArkApiUtils.h.
|
inlinestatic |
Returns the dino the character is riding.
| player_controller | Player |
Definition at line 377 of file ArkApiUtils.h.
|
pure virtual |
Returns a pointer to AShooterGameMode.
Implemented in AsaApi::ApiUtils.
Here is the caller graph for this function:
|
pure virtual |
Returns the current server status.
Implemented in AsaApi::ApiUtils.
|
inlinestatic |
Returns the steam name of player.
| player_controller | Player |
Definition at line 240 of file ArkApiUtils.h.
|
inlinestatic |
Get Tribe ID of character.
Definition at line 640 of file ArkApiUtils.h.
Here is the call graph for this function:
|
inlinestatic |
Get Tribe ID of player controller.
Definition at line 625 of file ArkApiUtils.h.
Here is the call graph for this function:Returns a pointer to UWorld.
Implemented in AsaApi::ApiUtils.
Here is the caller graph for this function:
|
inlinestatic |
Returns true if player is dead, false otherwise.
Definition at line 508 of file ArkApiUtils.h.
Here is the caller graph for this function:
|
inlinestatic |
Returns true if character is riding a dino, false otherwise.
| player_controller | Player |
Definition at line 366 of file ArkApiUtils.h.
Here is the caller graph for this function:
|
inline |
Runs a command that is not logged anywhere.
| _this | Player controller |
| Command | Command to run |
Definition at line 766 of file ArkApiUtils.h.
Here is the call graph for this function:
|
inline |
Sends chat message to the specific player. Using fmt::format.
| T | Either a a char or wchar_t |
| Args | Optional arguments types |
| player_controller | Player |
| sender_name | Name of the sender |
| msg | Message |
| args | Optional arguments |
Definition at line 87 of file ArkApiUtils.h.
|
inline |
Sends chat message to all players. Using fmt::format.
| T | Either a a char or wchar_t |
| Args | Optional arguments types |
| sender_name | Name of the sender |
| msg | Message |
| args | Optional arguments |
Definition at line 134 of file ArkApiUtils.h.
|
inline |
Sends notification (on-screen message) to the specific player. Using fmt::format.
| T | Either a a char or wchar_t |
| Args | Optional arguments types |
| 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 71 of file ArkApiUtils.h.
|
inline |
Sends notification (on-screen message) to all players. Using fmt::format.
| T | Either a a char or wchar_t |
| Args | Optional arguments types |
| color | Message color |
| display_scale | Size of text |
| display_time | Display time |
| icon | Message icon (optional) |
| msg | Message |
| args | Optional arguments |
Definition at line 119 of file ArkApiUtils.h.
|
inline |
Sends server message to the specific player. Using fmt::format.
| T | Either a a char or wchar_t |
| Args | Optional arguments types |
| player_controller | Player |
| msg_color | Message color |
| msg | Message |
| args | Optional arguments |
Definition at line 53 of file ArkApiUtils.h.
|
inline |
Sends server message to all players. Using fmt::format.
| T | Either a a char or wchar_t |
| Args | Optional arguments types |
| msg_color | Message color |
| msg | Message |
| args | Optional arguments |
Definition at line 102 of file ArkApiUtils.h.
Sets the messaging manager for the current plugin.
| T | MessagingManager type |
Definition at line 800 of file ArkApiUtils.h.
|
privatepure virtual |
Implemented in AsaApi::ApiUtils.
|
inline |
Spawns a dino near player or at specific coordinates.
| 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 |
Definition at line 309 of file ArkApiUtils.h.
Here is the call graph for this function:
|
inline |
Spawns an item drop.
| 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 |
Definition at line 266 of file ArkApiUtils.h.
Here is the call graph for this function:
|
inlinestatic |
Teleport one player to another.
| 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 401 of file ArkApiUtils.h.
Here is the call graph for this function:
|
inlinestatic |
Teleports player to the given position.
| player_controller | Player |
| pos | New position |
Definition at line 439 of file ArkApiUtils.h.
Here is the call graph for this function: