HInkChoice Class Reference

Handler for a ink choice. More...

#include <inkcpp.h>

Public Member Functions
const char *	ink_choice_text (const HInkChoice *self)
	Choice text.
int	ink_choice_num_tags (const HInkChoice *self)
	number of tags associated with this choice
const char *	ink_choice_get_tag (const HInkChoice *self, int index)
	Access a tag by index.

Detailed Description

Handler for a ink choice.

Contains all the data about a single choice being faced by an ink runner. Of primary concern is the index and the text.

See also

runner

Member Function Documentation

ink_choice_get_tag()

const char * ink_choice_get_tag	(	const HInkChoice *	self,
		int	index )

Access a tag by index.

Note that this method only allows the retrieval of tags attached to the current line. For tags at the top of the script, use get_global_tag()

Parameters

index

tag id to fetch [0;num_tags())

Returns

pointer to the tag string memory or nullptr if the index is invalid

See also

has_tags num_tags get_global_tag get_knot_tag

Parameters

self

ink_choice_num_tags()

int ink_choice_num_tags

(

const HInkChoice *

self

)

number of tags associated with this choice

See also

has_tags()

Parameters

self

ink_choice_text()

const char * ink_choice_text

(

const HInkChoice *

self

)

Choice text.

Text to display to the user for choosing this choice.

Returns

choice text as a string

Parameters

self

---

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

• inkcpp_c/include/inkcpp.h