Enigma String

• trim_first_enigma_font_tags
• change_first_string_font
• change_first_text_block_font
• change_string_font
• change_text_block_font
• remove_inserts
• expand_value_tag
• calc_text_advance_width

The following implements a hypothetical FCString.TrimFirstEnigmaFontTags() function that would preferably be in the PDK Framework. Trimming only first allows us to preserve style changes within the rest of the string, such as changes from plain to italic. Ultimately this seems more useful than trimming out all font tags. If the PDK Framework is ever changed, it might be even better to create replace font functions that can replace only font, only size, only style, or all three together.

trim_first_enigma_font_tags

enigma_string.trim_first_enigma_font_tags(string)

Trims the first font tags and returns the result as an instance of FCFontInfo.

Input	Type	Description
string	FCString	this is both the input and the trimmed output result

Output type	Description
`FCFontInfo	nil`

change_first_string_font

enigma_string.change_first_string_font (string, font_info)

Replaces the first enigma font tags of the input enigma string.

Input	Type	Description
string	FCString	this is both the input and the modified output result
font_info	FCFontInfo	replacement font info

Output type	Description
boolean	true if success

change_first_text_block_font

enigma_string.change_first_text_block_font (text_block, font_info)

Replaces the first enigma font tags of input text block.

Input	Type	Description
text_block	FCTextBlock	this is both the input and the modified output result
font_info	FCFontInfo	replacement font info

Output type	Description
boolean	true if success

change_string_font

enigma_string.change_string_font (string, font_info)

Changes the entire enigma string to have the input font info.

Input	Type	Description
string	FCString	this is both the input and the modified output result
font_info	FCFontInfo	replacement font info

change_text_block_font

enigma_string.change_text_block_font (text_block, font_info)

Changes the entire text block to have the input font info.

Input	Type	Description
text_block	FCTextBlock	this is both the input and the modified output result
font_info	FCFontInfo	replacement font info

remove_inserts

enigma_string.remove_inserts (fcstring, replace_with_generic)

Removes text inserts other than font commands and replaces them with

Input	Type	Description
fcstring	FCString	this is both the input and the modified output result
replace_with_generic	boolean	if true, replace the insert with the text of the enigma command

expand_value_tag

enigma_string.expand_value_tag(fcstring, value_num)

Expands the value tag to the input value_num.

Input	Type	Description
fcstring	FCString	this is both the input and the modified output result
value_num	number	the value number to replace the tag with

calc_text_advance_width

enigma_string.calc_text_advance_width(inp_string)

Calculates the advance width of the input string taking into account all font and style changes within the string.

Input	Type	Description
inp_string	FCString	this is an input-only value and is not modified

Output type	Description
number	the width of the string