Peoplemon  0.1.0
Peoplemon 3 game source documentation
Public Types | Public Member Functions | Protected Member Functions | List of all members
core::script::ConversationContext Class Reference

Special script context for conversation scripts. Adds the default Peoplemon built-ins and the conversation dependent built-ins. More...

#include <ConversationContext.hpp>

+ Inheritance diagram for core::script::ConversationContext:

Public Types

using StatusCb = std::function< bool(bl::ecs::Entity)>
 Special callback type for reporting conversation state. More...
 

Public Member Functions

 ConversationContext (system::Systems &systems, bl::ecs::Entity entity, const StatusCb &cb)
 Construct a new ConversationContext. More...
 

Protected Member Functions

virtual void addCustomSymbols (bl::script::SymbolTable &table) const override
 

Detailed Description

Special script context for conversation scripts. Adds the default Peoplemon built-ins and the conversation dependent built-ins.

Definition at line 23 of file ConversationContext.hpp.

Member Typedef Documentation

◆ StatusCb

using core::script::ConversationContext::StatusCb = std::function<bool(bl::ecs::Entity)>

Special callback type for reporting conversation state.

Parameters
entityThe entity to check status for
Returns
bool True if conversation completed, false if ongoing

Definition at line 32 of file ConversationContext.hpp.

Constructor & Destructor Documentation

◆ ConversationContext()

core::script::ConversationContext::ConversationContext ( system::Systems systems,
bl::ecs::Entity  entity,
const StatusCb cb 
)

Construct a new ConversationContext.

Parameters
systemsThe primary systems object
entityThe entity being conversed with
cbCallback that can be used to query the conversation state

Definition at line 33 of file ConversationContext.cpp.

Member Function Documentation

◆ addCustomSymbols()

void core::script::ConversationContext::addCustomSymbols ( bl::script::SymbolTable &  table) const
overrideprotectedvirtual

Definition at line 39 of file ConversationContext.cpp.


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