ArkApi::ICommands Class Reference

#include <ICommands.h>

Inheritance diagram for ArkApi::ICommands:

Public Member Functions
virtual	~ICommands ()=default
virtual void	AddChatCommand (const FString &command, const std::function< void(AShooterPlayerController *, FString *, EChatSendMode::Type)> &callback)=0
	Adds a chat command.
virtual void	AddConsoleCommand (const FString &command, const std::function< void(APlayerController *, FString *, bool)> &callback)=0
	Adds a console command.
virtual void	AddRconCommand (const FString &command, const std::function< void(RCONClientConnection *, RCONPacket *, UWorld *)> &callback)=0
	Adds a rcon command.
virtual void	AddOnTickCallback (const FString &id, const std::function< void(float)> &callback)=0
	Added function will be called every frame.
virtual void	AddOnTimerCallback (const FString &id, const std::function< void()> &callback)=0
	Added function will be called every second.
virtual void	AddOnChatMessageCallback (const FString &id, const std::function< bool(AShooterPlayerController *, FString *, EChatSendMode::Type, bool, bool)> &callback)=0
	Added function will be called for AShooterPlayerController->ServerSendChatMessage events.
virtual bool	RemoveChatCommand (const FString &command)=0
	Removes a chat command.
virtual bool	RemoveConsoleCommand (const FString &command)=0
	Removes a console command.
virtual bool	RemoveRconCommand (const FString &command)=0
	Removes a rcon command.
virtual bool	RemoveOnTickCallback (const FString &id)=0
	Removes a on-tick callback.
virtual bool	RemoveOnTimerCallback (const FString &id)=0
	Removes an on-timer callback.
virtual bool	RemoveOnChatMessageCallback (const FString &id)=0
	Removes an on-chat-message callback.

Detailed Description

Definition at line 13 of file ICommands.h.

Constructor & Destructor Documentation

~ICommands()

virtual ArkApi::ICommands::~ICommands ( )

virtualdefault

Member Function Documentation

AddChatCommand()

virtual void ArkApi::ICommands::AddChatCommand ( const FString & command, const std::function< void(AShooterPlayerController *, FString *, EChatSendMode::Type)> & callback )

pure virtual

Adds a chat command.

Parameters

command	Command name
callback	Callback function

Implemented in ArkApi::Commands.

AddConsoleCommand()

virtual void ArkApi::ICommands::AddConsoleCommand ( const FString & command, const std::function< void(APlayerController *, FString *, bool)> & callback )

pure virtual

Adds a console command.

Parameters

command	Command name
callback	Callback function

Implemented in ArkApi::Commands.

Here is the caller graph for this function:

AddOnChatMessageCallback()

virtual void ArkApi::ICommands::AddOnChatMessageCallback ( const FString & id, const std::function< bool(AShooterPlayerController *, FString *, EChatSendMode::Type, bool, bool)> & callback )

pure virtual

Added function will be called for AShooterPlayerController->ServerSendChatMessage events.

Parameters

id	Unique ID
callback	Callback function

Implemented in ArkApi::Commands.

AddOnTickCallback()

virtual void ArkApi::ICommands::AddOnTickCallback ( const FString & id, const std::function< void(float)> & callback )

pure virtual

Added function will be called every frame.

Parameters

id	Unique ID
callback	Callback function

Implemented in ArkApi::Commands.

AddOnTimerCallback()

virtual void ArkApi::ICommands::AddOnTimerCallback ( const FString & id, const std::function< void()> & callback )

pure virtual

Added function will be called every second.

Parameters

id	Unique ID
callback	Callback function

Implemented in ArkApi::Commands.

Here is the caller graph for this function:

AddRconCommand()

virtual void ArkApi::ICommands::AddRconCommand ( const FString & command, const std::function< void(RCONClientConnection *, RCONPacket *, UWorld *)> & callback )

pure virtual

Adds a rcon command.

Parameters

command	Command name
callback	Callback function

Implemented in ArkApi::Commands.

Here is the caller graph for this function:

RemoveChatCommand()

virtual bool ArkApi::ICommands::RemoveChatCommand ( const FString & command )

pure virtual

Removes a chat command.

Parameters

command

Command name

Returns

true if success, false otherwise

Implemented in ArkApi::Commands.

RemoveConsoleCommand()

virtual bool ArkApi::ICommands::RemoveConsoleCommand ( const FString & command )

pure virtual

Removes a console command.

Parameters

command

Command name

Returns

true if success, false otherwise

Implemented in ArkApi::Commands.

RemoveOnChatMessageCallback()

virtual bool ArkApi::ICommands::RemoveOnChatMessageCallback ( const FString & id )

pure virtual

Removes an on-chat-message callback.

Parameters

id	Callback ID

Returns

true if success, false otherwise

Implemented in ArkApi::Commands.

RemoveOnTickCallback()

virtual bool ArkApi::ICommands::RemoveOnTickCallback ( const FString & id )

pure virtual

Removes a on-tick callback.

Parameters

id	Callback ID

Returns

true if success, false otherwise

Implemented in ArkApi::Commands.

Here is the caller graph for this function:

RemoveOnTimerCallback()

virtual bool ArkApi::ICommands::RemoveOnTimerCallback ( const FString & id )

pure virtual

Removes an on-timer callback.

Parameters

id	Callback ID

Returns

true if success, false otherwise

Implemented in ArkApi::Commands.

Here is the caller graph for this function:

RemoveRconCommand()

virtual bool ArkApi::ICommands::RemoveRconCommand ( const FString & command )

pure virtual

Removes a rcon command.

Parameters

command

Command name

Returns

true if success, false otherwise

Implemented in ArkApi::Commands.

---

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

• C:/Users/lachl/Downloads/ArkServerAPI_NEW/ASE/AseApi-main/version/Core/Public/ICommands.h