cf_text_effect_get_string¶
Category: text
GitHub: cute_draw.h
Returns the text parameter as a string.
const char* cf_text_effect_get_string(const CF_TextEffect* fx, const char* key, const char* default_val);
| Parameters | Description |
|---|---|
| fx | The text effect state. |
| key | The name of the text code parameter |
| default_val | A default value for the text code parameter if doesn't exist in the text. |
Return Value¶
Returns the value of the text code parameter.
Remarks¶
You may place a string inside of markups by wrapped quotes. Example: <my_effect metadata=\"Here's the metadata.\">Hello world!</my_effect>.
This string can be fetched from within your CF_TextEffectFn callback by calling cf_text_effect_get_string.
Related Pages¶
CF_TextEffect
CF_TextEffectFn
cf_text_effect_register
cf_text_effect_get_number
cf_text_effect_get_color