Description

Description

Represents a Roll / Roll group description.

Kind: global class

new Description(text, [type])

Create a Description instance.

ParamTypeDefault
textstring
[type]string"inline"

description.text ⇒ string

The description text.

Kind: instance property of Description

description.text

Set the description text.

Kind: instance property of Description

ParamType
textstring | number

description.type ⇒ string

The description type.

Kind: instance property of Description
Returns: string - "inline" or "multiline"

description.type

Set the description type.

Kind: instance property of Description

ParamType
typestring

description.toJSON() ⇒ Object

Return an object for JSON serialising.

This is called automatically when JSON encoding the object.

Kind: instance method of Description

description.toString() ⇒ string

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