Pyrogenesis HEAD
Pyrogenesis, a RTS Engine
Public Member Functions | Static Public Member Functions | List of all members
ICmpAIManager Class Referenceabstract

#include <ICmpAIManager.h>

Inheritance diagram for ICmpAIManager:
Inheritance graph
[legend]
Collaboration diagram for ICmpAIManager:
Collaboration graph
[legend]

Public Member Functions

virtual void AddPlayer (const std::wstring &id, player_id_t player, uint8_t difficulty, const std::wstring &)=0
 Add a new AI player into the world, based on the AI script identified by id (corresponding to a subdirectory in simulation/ai/), to control player player. More...
 
virtual void SetRNGSeed (uint32_t seed)=0
 
virtual void TryLoadSharedComponent ()=0
 
virtual void RunGamestateInit ()=0
 
virtual void StartComputation ()=0
 Call this at the end of a turn, to trigger AI computation which will be ready for the next turn. More...
 
virtual void PushCommands ()=0
 Call this at the start of a turn, to push the computed AI commands into the command queue. More...
 
- Public Member Functions inherited from IComponent
virtual ~IComponent ()
 
virtual void Init (const CParamNode &paramNode)=0
 
virtual void Deinit ()=0
 
virtual void HandleMessage (const CMessage &msg, bool global)
 
CEntityHandle GetEntityHandle () const
 
void SetEntityHandle (CEntityHandle ent)
 
entity_id_t GetEntityId () const
 
CEntityHandle GetSystemEntity () const
 
const CSimContext & GetSimContext () const
 
void SetSimContext (const CSimContext &context)
 
virtual void Serialize (ISerializer &serialize)=0
 
virtual void Deserialize (const CParamNode &paramNode, IDeserializer &deserialize)=0
 
virtual bool NewJSObject (const ScriptInterface &scriptInterface, JS::MutableHandleObject out) const
 Returns false by default, indicating that a scripted wrapper of this IComponent is not supported. More...
 
virtual JS::Value GetJSInstance () const
 
virtual int GetComponentTypeId () const =0
 

Static Public Member Functions

static JS::Value GetAIs (const ScriptInterface &scriptInterface)
 Returns a vector of {"id":"value-for-AddPlayer", "name":"Human readable name"} objects, based on all the available AI scripts. More...
 
- Static Public Member Functions inherited from IComponent
static std::string GetSchema ()
 
static void RegisterComponentType (CComponentManager &mgr, EInterfaceId iid, EComponentTypeId cid, AllocFunc alloc, DeallocFunc dealloc, const char *name, const std::string &schema)
 
static void RegisterComponentTypeScriptWrapper (CComponentManager &mgr, EInterfaceId iid, EComponentTypeId cid, AllocFunc alloc, DeallocFunc dealloc, const char *name, const std::string &schema)
 
static u8 GetSerializationVersion ()
 

Additional Inherited Members

- Public Types inherited from IComponent
using AllocFunc = IComponent *(*)(const ScriptInterface &scriptInterface, JS::HandleValue ctor)
 
using DeallocFunc = void(*)(IComponent *)
 

Member Function Documentation

◆ AddPlayer()

virtual void ICmpAIManager::AddPlayer ( const std::wstring &  id,
player_id_t  player,
uint8_t  difficulty,
const std::wstring &   
)
pure virtual

Add a new AI player into the world, based on the AI script identified by id (corresponding to a subdirectory in simulation/ai/), to control player player.

Implemented in CCmpAIManager.

◆ GetAIs()

JS::Value ICmpAIManager::GetAIs ( const ScriptInterface &  scriptInterface)
static

Returns a vector of {"id":"value-for-AddPlayer", "name":"Human readable name"} objects, based on all the available AI scripts.

◆ PushCommands()

virtual void ICmpAIManager::PushCommands ( )
pure virtual

Call this at the start of a turn, to push the computed AI commands into the command queue.

Implemented in CCmpAIManager.

◆ RunGamestateInit()

virtual void ICmpAIManager::RunGamestateInit ( )
pure virtual

Implemented in CCmpAIManager.

◆ SetRNGSeed()

virtual void ICmpAIManager::SetRNGSeed ( uint32_t  seed)
pure virtual

Implemented in CCmpAIManager.

◆ StartComputation()

virtual void ICmpAIManager::StartComputation ( )
pure virtual

Call this at the end of a turn, to trigger AI computation which will be ready for the next turn.

Implemented in CCmpAIManager.

◆ TryLoadSharedComponent()

virtual void ICmpAIManager::TryLoadSharedComponent ( )
pure virtual

Implemented in CCmpAIManager.

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