inkcpp
Loading...
Searching...
No Matches
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 assoziated with this choice
 
const char * ink_choice_get_tag (const HInkChoice *self, int index)
 access tag.
 

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 tag.

Parameters
indextag id to fetch [0;num_tags())
self

◆ ink_choice_num_tags()

int ink_choice_num_tags ( const HInkChoice * self)

number of tags assoziated 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: