FCMStrings

Summary of Modifications

• Setters that accept FCString also accept a Lua string.
• Methods that returned a boolean to indicate success/failure now throw an error instead.
• Added polyfill for CopyFromStringTable.
• Added CreateStringTable method.

Functions

• AddCopy(self, str)
• AddCopies(self)
• Find(self, str)
• FindNocase(self, str)
• LoadFolderFiles(self, folderstring)
• LoadSubfolders(self, folderstring)
• LoadSymbolFonts(self)
• LoadSystemFontNames(self)
• InsertStringAt(self, str, index)
• CopyFromStringTable(self, strings)
• CreateStringTable(self)

AddCopy

fcmstrings.AddCopy(self, str)

View source

[Breaking Change] [Fluid] [Override]

Override Changes:

• Accepts Lua string and number in addition to FCString.
• Throws an error instead of returning a boolean for success/failure.

Input	Type	Description
self	FCMStrings
str	`FCString	string

AddCopies

fcmstrings.AddCopies(self)

View source

Same as AddCopy, but accepts multiple arguments so that multiple values can be added at a time.

@ … (FCStrings | FCString | string | number) numbers will be cast to string

Input	Type	Description
self	FCMStrings

Find

fcmstrings.Find(self, str)

View source

[Override]

Override Changes:

• Accepts Lua string and number in addition to FCString.

Input	Type	Description
self	FCMStrings
str	`FCString	string

Return type	Description
FCMString | nil

FindNocase

fcmstrings.FindNocase(self, str)

View source

[Override]

Override Changes:

• Accepts Lua string and number in addition to FCString.

Input	Type	Description
self	FCMStrings
str	`FCString	string

Return type	Description
FCMString | nil

LoadFolderFiles

fcmstrings.LoadFolderFiles(self, folderstring)

View source

[Breaking Change] [Fluid] [Override]

Override Changes:

• Accepts Lua string in addition to FCString.
• Throws an error instead of returning a boolean for success/failure.

Input	Type	Description
self	FCMStrings
folderstring	`FCString	string`

LoadSubfolders

fcmstrings.LoadSubfolders(self, folderstring)

View source

[Breaking Change] [Fluid] [Override]

Override Changes:

• Accepts Lua string in addition to FCString.
• Throws an error instead of returning a boolean for success/failure.

Input	Type	Description
self	FCMStrings
folderstring	`FCString	string`

LoadSymbolFonts

fcmstrings.LoadSymbolFonts(self)

View source

[Breaking Change] [Fluid] [Override]

Override Changes:

• Throws an error instead of returning a boolean for success/failure.

Input	Type	Description
self	FCMStrings

LoadSystemFontNames

fcmstrings.LoadSystemFontNames(self)

View source

[Breaking Change] [Fluid] [Override]

Override Changes:

• Throws an error instead of returning a boolean for success/failure.

Input	Type	Description
self	FCMStrings

InsertStringAt

fcmstrings.InsertStringAt(self, str, index)

View source

[>= v0.59] [Fluid] [Override]

Override Changes:

• Accepts Lua string and number in addition to FCString.

Input	Type	Description
self	FCMStrings
str	`FCString	string
index	number

CopyFromStringTable

fcmstrings.CopyFromStringTable(self, strings)

View source

[Fluid] [Polyfill]

Polyfills FCStrings.CopyFromStringTable for earlier RGP/JWLua versions.

Note: This method can also be called statically with a non-mixin FCStrings object.

Input	Type	Description
self	`FCMStrings	FCStrings`
strings	table

CreateStringTable

fcmstrings.CreateStringTable(self)

View source

Creates a table of Lua strings from the FCStrings in this collection.

Note: This method can also be called statically with a non-mixin FCStrings object.

Input	Type	Description
self	`FCMStrings	FCStrings`

Return type	Description
table