Description
Description
Represents a Roll / Roll group description.
Kind: global class
- Description
- new Description(text, [type])
- .text ⇒
string
- .text
- .type ⇒
string
- .type
- .toJSON() ⇒
Object
- .toString() ⇒
string
new Description(text, [type])
Create a Description
instance.
Param | Type | Default |
---|---|---|
text | string | |
[type] | string | "inline" |
string
description.text ⇒ The description text.
Kind: instance property of Description
description.text
Set the description text.
Kind: instance property of Description
Param | Type |
---|---|
text | string | number |
string
description.type ⇒ The description type.
Kind: instance property of Description
Returns: string
- "inline" or "multiline"
description.type
Set the description type.
Kind: instance property of Description
Param | Type |
---|---|
type | string |
Object
description.toJSON() ⇒ Return an object for JSON serialising.
This is called automatically when JSON encoding the object.
Kind: instance method of Description
string
description.toString() ⇒ Return the String representation of the object.
This is called automatically when casting the object to a string.
Kind: instance method of Description
See: text