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, which can be migrated. 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

Enumerations
enum class	whitespace_mode { collapse , keep_runs }
	How runs of whitespace inside a line are treated. More...

Functions
template<>
const auto &	value::get< value::Type::Bool > () const
	access a ink::runtime::value::Type::Bool value
template<>
const auto &	value::get< value::Type::Uint32 > () const
	access a ink::runtime::value::Type::Uint32 value
template<>
const auto &	value::get< value::Type::Int32 > () const
	access ink::runtime::value::Type::Int32 value
template<>
const auto &	value::get< value::Type::String > () const
	access ink::runtime::value::Type::String value
template<>
const auto &	value::get< value::Type::Float > () const
	access ink::runtime::value::Type::Float value
template<>
const auto &	value::get< value::Type::List > () const
	access ink::runtime::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

Enumeration Type Documentation

whitespace_mode

enum class ink::runtime::whitespace_mode

strong

How runs of whitespace inside a line are treated.

Applies to all text a runner produces: lines, variables, choice text and tags.

See also

ink::runtime::runner_interface::set_whitespace_mode()

Enumerator
collapse	Collapse a run of spaces and tabs inside a line to a single space. The default, and what the reference ink runtime does for lines.
keep_runs	Keep runs of spaces and tabs inside a line, for text laid out for a fixed width display. Whitespace where two glued fragments meet still reads as a single character, and a run at the start or end of a line is still dropped.