settings

Registers settings used by Ink in the Foundry, which can be accessed in the Module Settings tab of Foundry's Configure Settings Window.

Members

(inner) chatRender

Properties:
Name Type Description
name String

ChatMessage Renderer
hint String

Enabling this renderer will output ink stories to the chat window.
default Boolean

true

(inner) consoleRender

Properties:
Name Type Description
name String

Console Renderer
hint String

Enabling this renderer will output ink stories to the F12 debug console.
default Boolean

false

(inner) dialogueSyntax

Properties:
Name Type Description
name String

Dialogue Indication Syntax
hint String

If your ink script uses a common syntax to indicate speakers of dialogue, then you can use this drop down to select it.
default String

None
choices Array

A dropdown selector

Properties
Name Type Description
None String

None
inline String

Inline (<SPEAKER>: ...)
tag String

Tag (... #Dialogue: <SPEAKER>)

(inner) hookSyntax

Properties:
Name Type Description
name String

Use Hook Registration Syntax
hint String

Enabling this turns on hook syntax in the text of choices.
default Boolean

true

(inner) useDefaultBindings

Properties:
Name Type Description
name String

Bind Foundry External Functions
hint String

Enabling this lets you use some premade helper functions in your ink script. Declare them using the EXTERNAL keyword.