FCMTextExpressionDef

Summary of Modifications

• Setters that accept FCString also accept a Lua string.
• FCString parameter in getters is optional and if omitted, the result will be returned as a Lua string.
• Methods that returned a boolean to indicate success/failure now throw an error instead.

Functions

• SaveNewTextBlock(self, str)
• AssignToCategory(self, cat_def)
• SetUseCategoryPos(self, enable)
• SetUseCategoryFont(self, enable)
• MakeRehearsalMark(self, str, measure)
• SaveTextString(self, str)
• DeleteTextBlock(self)
• SetDescription(self, str)
• GetDescription(self, str)
• DeepSaveAs(self, item_num)
• DeepDeleteData(self)

SaveNewTextBlock

fcmtextexpressiondef.SaveNewTextBlock(self, str)

View source

[Breaking Change] [Fluid] [Override]

Override Changes:

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

Input	Type	Description
self	FCMTextExpressionDef
str	`string	FCString`

AssignToCategory

fcmtextexpressiondef.AssignToCategory(self, cat_def)

View source

[Breaking Change] [Fluid] [Override]

Override Changes:

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

Input	Type	Description
self	FCMTextExpressionDef
cat_def	FCCategoryDef	the parent Category Definition

SetUseCategoryPos

fcmtextexpressiondef.SetUseCategoryPos(self, enable)

View source

[Breaking Change] [Fluid] [Override]

Override Changes:

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

Input	Type	Description
self	FCMTextExpressionDef
enable	boolean

SetUseCategoryFont

fcmtextexpressiondef.SetUseCategoryFont(self, enable)

View source

[Breaking Change] [Fluid] [Override]

Override Changes:

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

Input	Type	Description
self	FCMTextExpressionDef
enable	boolean

MakeRehearsalMark

fcmtextexpressiondef.MakeRehearsalMark(self, str, measure)

View source

[Breaking Change] [Fluid] [Override]

Override Changes:

• Throws an error instead of returning a boolean for success/failure.
• Passing an FCString is optional. If omitted, the result is returned as a Lua string. If passed, nothing is returned and the method is fluid.

Input	Type	Description
self	FCMTextExpressionDef
str (optional)	FCString
measure	integer

Return type	Description
string	If FCString is omitted.

SaveTextString

fcmtextexpressiondef.SaveTextString(self, str)

View source

[Breaking Change] [Fluid] [Override]

Override Changes:

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

Input	Type	Description
self	FCMTextExpressionDef
str	`string	FCString`

DeleteTextBlock

fcmtextexpressiondef.DeleteTextBlock(self)

View source

[Breaking Change] [Fluid] [Override]

Override Changes:

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

Input	Type	Description
self	FCMTextExpressionDef

SetDescription

fcmtextexpressiondef.SetDescription(self, str)

View source

[Fluid] [Override]

Override Changes:

• Accepts Lua string in addition to FCString.

Input	Type	Description
self	FCMTextExpressionDef
str	`string	FCString`

GetDescription

fcmtextexpressiondef.GetDescription(self, str)

View source

[?Fluid] [Override]

Override Changes:

• Passing an FCString is optional. If omitted, the result is returned as a Lua string. If passed, nothing is returned and the method is fluid.

Input	Type	Description
self	FCMTextExpressionDef
str (optional)	FCString

Return type	Description
string	Returned if str is omitted.

DeepSaveAs

fcmtextexpressiondef.DeepSaveAs(self, item_num)

View source

[Breaking Change] [Fluid] [Override]

Override Changes:

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

Input	Type	Description
self	FCMTextExpressionDef
item_num	integer

DeepDeleteData

fcmtextexpressiondef.DeepDeleteData(self)

View source

[Breaking Change] [Fluid] [Override]

Override Changes:

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

Input	Type	Description
self	FCMTextExpressionDef