Module nwcOptGroup

A nwcItem supporting object class for option groups.

An object of this type is actually a Lua table containing key/value pairs representing the options and their values. Options can be retrieved from it like any other Lua table. You can use the standard table methods on nwcOptGroup objects.

Type nwcOptGroup

nwcOptGroup.ID

Contains the name of the object type (nwcOptGroup)

nwcOptGroup:WriteUsing(writeFunc)

Standard output function with a user specified write function.

nwcOptGroup:__tostring()

Provides an automatic converting to string.

nwcOptGroup.new(fieldtxt)

Constructs a new nwcOptGroup object.

Type nwcOptGroup

Field(s)

#string nwcOptGroup.ID

Contains the name of the object type (nwcOptGroup)

nwcOptGroup:WriteUsing(writeFunc)

Standard output function with a user specified write function.

Parameter

  • writeFunc : The function that will be used to write the pieces that constitute the reconstructed text.

nwcOptGroup:__tostring()

Provides an automatic converting to string.

Return value

#string: the raw string representation of the object.

nwcOptGroup.new(fieldtxt)

Constructs a new nwcOptGroup object.

Parameter

  • #string fieldtxt : The raw option field text.

Return value

#nwcOptGroup: A new nwcOptGroup object.

Copyright © 2020 NoteWorthy Software™, Inc.
All Rights Reserved.