Class DialogueStandardLibrary
Standard invocations that ship with Ibralogue. These follow the same {{Name(args)}} syntax as the rest of the language and can be used inline in dialogue text.
Inherited Members
Namespace: Ibralogue
Assembly: .dll
Syntax
public static class DialogueStandardLibrary
Methods
| Edit this page View SourceAudio(DialogueEngineBase, string)
Plays an audio clip through the engine's audio provider.
[NPC]
Watch out! {{Audio(SFX/explosion)}}
Declaration
public static void Audio(DialogueEngineBase engine, string clipId)
Parameters
| Type | Name | Description |
|---|---|---|
| DialogueEngineBase | engine | |
| string | clipId |
Image(DialogueEngineBase, string)
Changes the speaker portrait. On its own line, fires at line start. Inline in text, fires at that position.
[NPC]
Hello! {{Image(Portraits/Surprised)}} Whoa!
Declaration
public static void Image(DialogueEngineBase engine, string path)
Parameters
| Type | Name | Description |
|---|---|---|
| DialogueEngineBase | engine | |
| string | path |
MarkVisited(string)
Marks a key as visited. Check from dialogue with
{{If(Visited("Tavern"))}} or from code with
VisitTracker.HasVisited("Tavern").
[NPC]
{{MarkVisited(Tavern)}}
Welcome to the tavern!
Declaration
public static void MarkVisited(string key)
Parameters
| Type | Name | Description |
|---|---|---|
| string | key |
PauseEngine(DialogueEngineBase)
Pauses the dialogue engine. The conversation halts until
ResumeConversation() is called from code. Use this to
hand control to an external system (cutscene, animation, minigame)
and resume when it finishes.
[NPC]
{{PauseEngine}}
Watch this!
Declaration
public static void PauseEngine(DialogueEngineBase engine)
Parameters
| Type | Name | Description |
|---|---|---|
| DialogueEngineBase | engine |
ResumeEngine(DialogueEngineBase)
Resumes a paused dialogue engine from within dialogue.
Typically not needed since external systems call
ResumeConversation() directly, but available for
cases where dialogue itself should trigger the resume
(e.g., after a timed wait).
Declaration
public static void ResumeEngine(DialogueEngineBase engine)
Parameters
| Type | Name | Description |
|---|---|---|
| DialogueEngineBase | engine |
Speed(DialogueEngineBase, float)
Changes the text reveal speed for the current line. A multiplier of 2 is twice as fast, 0.5 is half speed. Works with any animated view. Speed resets to the configured default on the next line.
[NPC]
This is normal. {{Speed(0.3)}} This... is... slow.
Declaration
public static void Speed(DialogueEngineBase engine, float multiplier)
Parameters
| Type | Name | Description |
|---|---|---|
| DialogueEngineBase | engine | |
| float | multiplier |
Visited(string)
Returns true if the given key has been marked as visited. Intended for use in conditionals.
{{If(Visited("Tavern"))}}
[NPC]
You've been here before.
{{EndIf}}
Declaration
public static bool Visited(string key)
Parameters
| Type | Name | Description |
|---|---|---|
| string | key |
Returns
| Type | Description |
|---|---|
| bool |
Wait(DialogueEngineBase, float)
Pauses the text animation for the given number of seconds.
[NPC]
And the winner is... {{Wait(2)}} you!
Declaration
public static void Wait(DialogueEngineBase engine, float seconds)
Parameters
| Type | Name | Description |
|---|---|---|
| DialogueEngineBase | engine | |
| float | seconds |