Olympe SDK

Class: RunnableDef

RunnableDef

Helper object that is returned when a runnable item is created.

new RunnableDef(databaseAgent, tag, parentTag)

Parameters:
Name Type Argument Description
databaseAgent olympe.dc.io.OSaveFileBuilder
tag string
parentTag string <nullable>

can be null only in disable mode in which case the parent must be set using setContainedIn.

Members

<protected, nullable> description :string

Type:
  • string

<protected, nullable> summary :string

Type:
  • string

Methods

addToFolder(folder)

Add a draw item to a parent folder.

Parameters:
Name Type Description
folder string

The folder to add this item to.
Returns:

This RunnableDef

Type
olympe.dc.io.RunnableDef

doneInternal()

setDeprecated()

Marks the brick as deprecated.

Returns:
Type
olympe.dc.io.RunnableDef

setDescription(desc)

Create a documentation object for the runnable def and set its description property

Parameters:
Name Type Description
desc string
Returns:
Type
olympe.dc.io.RunnableDef

setIcon(iconCode)

Parameters:
Name Type Description
iconCode string
Returns:
Type
olympe.dc.io.RunnableDef

setSummary(summary)

Create a documentation object for the runnable def and set its tooltip property

Parameters:
Name Type Description
summary string
Returns:
Type
olympe.dc.io.RunnableDef