inkcpp
Loading...
Searching...
No Matches
ink::runtime Namespace Reference

Contaning all modules and classes used for the inkles ink runtime. More...

Classes

class  choice
 An ink choice that is being presented to the user. More...
 
class  globals_interface
 Represents a global store to be shared amongst ink runners. More...
 
class  list_interface
 Interface for accessing a Ink list. More...
 
class  runner_interface
 A runner to execute ink script from a story. More...
 
class  snapshot
 Container for an InkCPP runtime snapshot. More...
 
class  story
 A loaded ink story. More...
 
class  story_ptr
 Pointer wrapper to an object whose lifetime is tied to a story object. More...
 
struct  value
 A Ink variable. More...
 

Typedefs

using globals = story_ptr<globals_interface>
 alias for an managed ink::runtime::globals_interface pointer
 
using runner = story_ptr<runner_interface>
 alias for an managed ink::runtime::runner_interface pointer
 
using list = list_interface*
 alias for ink::runtime::list_interface pointer
 

Functions

template<>
const auto & value::get< value::Type::Bool > () const
 access value::Type::Bool value
 
template<>
const auto & value::get< value::Type::Uint32 > () const
 access value::Type::Uint32 value
 
template<>
const auto & value::get< value::Type::Int32 > () const
 access value::Type::Int32 value
 
template<>
const auto & value::get< value::Type::String > () const
 access value::Type::String value
 
template<>
const auto & value::get< value::Type::Float > () const
 access value::Type::Float value
 
template<>
const auto & value::get< value::Type::List > () const
 access value::Type::List value
 

Detailed Description

Contaning all modules and classes used for the inkles ink runtime.

A minimal example can be found at main.cpp