Namespace contaning all modules and classes from InkCPP. More...

Namespaces
namespace	compiler
	collection of functions to compile a story.json to story.bin

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

Classes
struct	list_flag
	Used to unique identify a list flag

Typedefs
typedef unsigned int	uint32_t
	define basic numeric type

typedef uint32_t	hash_t
	Name hash (used for temporary variables)

typedef unsigned char	byte_t
	Byte type.

typedef uint32_t	offset_t
	Used to identify an offset in a data table (like a string in the string table)

typedef const unsigned char *	ip_t
	Instruction pointer used for addressing within the story instructions.

typedef unsigned int	size_t
	Used for the size of arrays.

typedef uint32_t	container_t
	Used as the unique identifier for an ink container.

typedef uint32_t	thread_t
	Used to uniquely identify threads.

using	ink_exception = std::runtime_error
	exception type thrown if something goes wrong

template<typename T >
using	optional = std::optional<T>
	custom optional implementation for usage if STL is disabled

Functions
hash_t	hash_string (const char *string)
	Simple hash for serialization of strings.

Variables
const hash_t	InvalidHash = 0
	Invalid hash value.

constexpr list_flag	null_flag {-1, -1}
	value of an unset list_flag

constexpr list_flag	empty_flag {-1, 0}
	value representing an empty list

constexpr std::nullopt_t	nullopt = std::nullopt
	an empty optional

constexpr uint32_t	InkBinVersion = 1
	Supportet version of ink.bin files.

constexpr uint32_t	InkVersion = 21
	Supported version of ink.json files.

Detailed Description

Namespace contaning all modules and classes from InkCPP.

(Unreal Blueprint Classes Excluded, but there will not be there in a normal build)

Typedef Documentation

template<typename T >

using ink::optional = std::optional<T>

custom optional implementation for usage if STL is disabled

Template Parameters

T	type contaied in optional

typedef unsigned int ink::uint32_t

define basic numeric type