10 lines
16 KiB
HTML
Vendored
10 lines
16 KiB
HTML
Vendored
<!DOCTYPE html>
|
|
<html lang="en"><!-- use theme color or fallback -->
|
|
<!--use textcolor from settings, otherwise create a contrasting color to theme color-->
|
|
<head><meta charset="utf-8"/><link href="../../../bootstrap/css/bootstrap.min.css" rel="stylesheet"/><link href="../../../bootstrap/css/bootstrap-responsive.min.css" rel="stylesheet"/><link href="../../../bootstrap/css/bootstrap-select.min.css" rel="stylesheet"/><link href="https://fonts.googleapis.com/css?family=Open+Sans:400,700,700italic,400italic" rel="stylesheet" type="text/css"/><link href="https://fonts.googleapis.com/css?family=Source+Sans+Pro:200,600,600italic,400" rel="stylesheet" type="text/css"/><link href="https://netdna.bootstrapcdn.com/font-awesome/4.1.0/css/font-awesome.css" rel="stylesheet" type="text/css"/><script src="../../../jquery-1.9.1.min.js"></script><script src="../../../bootstrap/js/bootstrap.min.js"></script><script src="../../../bootstrap/js/bootstrap-select.min.js"></script><link href="../../../styles.css" rel="stylesheet"/><link href="../../../extra-styles.css" rel="stylesheet"/><link href="../../../haxe-nav.css" rel="stylesheet"/><link href="../../../dark-mode.css" rel="stylesheet"/><script>var dox = {rootPath: "../../../",platforms: ["doc"]};</script><script src="../../../nav.js"></script><script src="../../../index.js"></script><link rel="icon" href="../../../favicon.ico" type="image/x-icon"/><title>funkin.cutscenes.dialogue.DialogueBox</title></head><body><script>/* Here to prevent flash of unstyled content */let systemDarkMode = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches;if ((!localStorage.theme && systemDarkMode) || localStorage.theme == "dark") {document.body.style.backgroundColor = "#111";document.body.style.opacity = "0";document.addEventListener("DOMContentLoaded", function(event) {toggleTheme();document.body.style.backgroundColor = "";document.body.style.opacity = "";});}</script><style>
|
|
.navbar .brand {
|
|
display: inline-block;
|
|
float: none;
|
|
text-shadow: 0 0 0 transparent;
|
|
}
|
|
</style><nav class="nav"><div class="navbar"><div class="navbar-inner" style="background:#FAFAFA; border-bottom:1px solid rgba(0,0,0,.09)"><div class="container"><a class="brand" style="color:#000000" href="../../../">API Documentation</a><a href="#" id="theme-toggle" class="brand" style="color:#000000" onclick="toggleTheme()" title="Toggle Dark Mode"><i class="fa fa-moon-o"></i></a></div></div></div></nav><div class="container main-content"><div class="row-fluid"><div class="span3"><div class="well sidebar-nav"><form class="form-search" id="searchForm"><div class="input-prepend input-block-level"><span class="add-on"><i class="fa fa-search"></i></span><input id="search" type="text" placeholder="Filter (Ctrl+P)" autocomplete="off"/></div></form></div><div class="well sidebar-nav" id="explorer"><div id="nav"></div></div></div><div class="span9"><div class="page-header"><h1><small>class</small> DialogueBox</h1><h4><small>package <a href="../../../funkin/cutscenes/dialogue/index.html">funkin.cutscenes.dialogue</a></small></h4><h4><small>extends <a class="type" title="funkin.system.FunkinSprite" href="../../../funkin/system/FunkinSprite.html">FunkinSprite</a></small></h4> <span class="label label-meta label-meta-directlyUsed" title="Marks types that are directly referenced by non-extern code.">@:directlyUsed</span></div><div class="body"><div class="doc doc-main"><p></p></div><h3 class="section">Constructor</h3><div class="fields"><div class="field "><a name="new"></a><h3 class="anchor"><code><a href="#new"><span class="identifier">new</span></a>(<span style="white-space:nowrap">name:<span class="type">String</span></span>)</code></h3><div class="doc"><p></p></div></div></div><h3 class="section">Variables</h3><div class="fields"><div class="field "><a name="dialogueBoxData"></a><h3 class="anchor"><code><a href="#dialogueBoxData"><span class="identifier">dialogueBoxData</span></a>:<span class="type">Access</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="nextSFX"></a><h3 class="anchor"><code><span class="label label-meta label-meta-value" title="Used to store default values for fields and function arguments.">@:value(Paths.sound("dialogue/next"))</span><a href="#nextSFX"><span class="identifier">nextSFX</span></a>:<span class="type">String</span><span> = Paths.sound("dialogue/next")</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="positions"></a><h3 class="anchor"><code><span class="label label-meta label-meta-value" title="Used to store default values for fields and function arguments.">@:value([])</span><a href="#positions"><span class="identifier">positions</span></a>:<span class="type">Map</span><<span class="type">String</span>, <a class="type" title="funkin.cutscenes.dialogue.CharPosDef" href="../../../funkin/cutscenes/dialogue/CharPosDef.html">CharPosDef</a>><span> = []</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="text"></a><h3 class="anchor"><code><a href="#text"><span class="identifier">text</span></a>:<span class="type">FlxTypeText</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="textTypeSFX"></a><h3 class="anchor"><code><span class="label label-meta label-meta-value" title="Used to store default values for fields and function arguments.">@:value(Paths.sound("dialogue/text"))</span><a href="#textTypeSFX"><span class="identifier">textTypeSFX</span></a>:<span class="type">String</span><span> = Paths.sound("dialogue/text")</span></code></h3><div class="doc"><p></p></div></div></div><h3 class="section">Methods</h3><div class="fields"><div class="field "><a name="playBubbleAnim"></a><h3 class="anchor"><code><span class="label label-meta label-meta-value" title="Used to store default values for fields and function arguments.">@:value({ speed : 0.05 })</span><a href="#playBubbleAnim"><span class="identifier">playBubbleAnim</span></a>(<span style="white-space:nowrap">bubble:<span class="type">String</span>,</span> <span style="white-space:nowrap">text:<span class="type">String</span>,</span> <span style="white-space:nowrap">speed:<span class="type">Float</span> = 0.05</span>):<span class="type">Void</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="popupChar"></a><h3 class="anchor"><code><a href="#popupChar"><span class="identifier">popupChar</span></a>(<span style="white-space:nowrap">char:<a class="type" title="funkin.cutscenes.dialogue.DialogueCharacter" href="../../../funkin/cutscenes/dialogue/DialogueCharacter.html">DialogueCharacter</a></span>):<span class="type">Void</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="setText"></a><h3 class="anchor"><code><span class="label label-meta label-meta-value" title="Used to store default values for fields and function arguments.">@:value({ speed : 0.02 })</span><a href="#setText"><span class="identifier">setText</span></a>(<span style="white-space:nowrap">text:<span class="type">String</span>,</span> <span style="white-space:nowrap">speed:<span class="type">Float</span> = 0.02</span>):<span class="type">Void</span></code></h3><div class="doc"><p></p></div></div></div> <div class="inherited-fields well"><h3 class="section">Inherited Variables</h3><div class="fields"><h4><a href="#" class="expand-button"><i class="fa fa-arrow-circle-o-right"></i></a> Defined by <a class="type" title="funkin.system.FunkinSprite" href="../../../funkin/system/FunkinSprite.html">FunkinSprite</a></h4><div style="display:none"><div class="field "><a name="animOffsets"></a><h3 class="anchor"><code><span class="label label-meta label-meta-value" title="Used to store default values for fields and function arguments.">@:value(new Map<String,FlxPoint>())</span><a href="#animOffsets"><span class="identifier">animOffsets</span></a>:<span class="type">Map</span><<span class="type">String</span>, <span class="type">FlxPoint</span>><span> = new Map<String,FlxPoint>()</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="animateAtlas"></a><h3 class="anchor"><code><a href="#animateAtlas"><span class="identifier">animateAtlas</span></a>:<a class="type" title="funkin.system.FlxAnimate" href="../../../funkin/system/FlxAnimate.html">FlxAnimate</a></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="beatAnims"></a><h3 class="anchor"><code><span class="label label-meta label-meta-value" title="Used to store default values for fields and function arguments.">@:value([])</span><a href="#beatAnims"><span class="identifier">beatAnims</span></a>:<span class="type">Array</span><<span class="type">String</span>><span> = []</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="initialZoom"></a><h3 class="anchor"><code><span class="label label-meta label-meta-value" title="Used to store default values for fields and function arguments.">@:value(1)</span><a href="#initialZoom"><span class="identifier">initialZoom</span></a>:<span class="type">Float</span><span> = 1</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="lastAnimContext"></a><h3 class="anchor"><code><span class="label label-meta label-meta-value" title="Used to store default values for fields and function arguments.">@:value(DANCE)</span><a href="#lastAnimContext"><span class="identifier">lastAnimContext</span></a>:<a class="type" title="funkin.scripting.events.PlayAnimContext - Contains all contexts possible for PlayAnimEvent." href="../../../funkin/scripting/events/PlayAnimContext.html">PlayAnimContext</a><span> = DANCE</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="name"></a><h3 class="anchor"><code><a href="#name"><span class="identifier">name</span></a>:<span class="type">String</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="spriteAnimType"></a><h3 class="anchor"><code><span class="label label-meta label-meta-value" title="Used to store default values for fields and function arguments.">@:value(NONE)</span><a href="#spriteAnimType"><span class="identifier">spriteAnimType</span></a>:<a class="type" title="funkin.system.XMLAnimType" href="../../../funkin/system/XMLAnimType.html">XMLAnimType</a><span> = NONE</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="zoomFactor"></a><h3 class="anchor"><code><span class="label label-meta label-meta-value" title="Used to store default values for fields and function arguments.">@:value(1)</span><a href="#zoomFactor"><span class="identifier">zoomFactor</span></a>:<span class="type">Float</span><span> = 1</span></code></h3><div class="doc"><p></p></div></div></div></div><h3 class="section">Inherited Methods</h3><div class="fields"><h4><a href="#" class="expand-button"><i class="fa fa-arrow-circle-o-right"></i></a> Defined by <a class="type" title="funkin.system.FunkinSprite" href="../../../funkin/system/FunkinSprite.html">FunkinSprite</a></h4><div style="display:none"><div class="field "><a name="addOffset"></a><h3 class="anchor"><code><span class="label label-meta label-meta-value" title="Used to store default values for fields and function arguments.">@:value({ y : 0, x : 0 })</span><a href="#addOffset"><span class="identifier">addOffset</span></a>(<span style="white-space:nowrap">name:<span class="type">String</span>,</span> <span style="white-space:nowrap">x:<span class="type">Float</span> = 0,</span> <span style="white-space:nowrap">y:<span class="type">Float</span> = 0</span>):<span class="type">Void</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="beatHit"></a><h3 class="anchor"><code><a href="#beatHit"><span class="identifier">beatHit</span></a>(<span style="white-space:nowrap">curBeat:<span class="type">Int</span></span>):<span class="type">Void</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="copyAtlasValues"></a><h3 class="anchor"><code><a href="#copyAtlasValues"><span class="identifier">copyAtlasValues</span></a>():<span class="type">Void</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="getAnimName"></a><h3 class="anchor"><code><span class="label label-inline">inline</span><a href="#getAnimName"><span class="identifier">getAnimName</span></a>():<span class="type">String</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="getAnimOffset"></a><h3 class="anchor"><code><span class="label label-inline">inline</span><a href="#getAnimOffset"><span class="identifier">getAnimOffset</span></a>(<span style="white-space:nowrap">name:<span class="type">String</span></span>):<span class="type">Null</span><<span class="type">FlxPoint</span>></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="hasAnimation"></a><h3 class="anchor"><code><span class="label label-inline">inline</span><a href="#hasAnimation"><span class="identifier">hasAnimation</span></a>(<span style="white-space:nowrap">AnimName:<span class="type">String</span></span>):<span class="type">Bool</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="isAnimFinished"></a><h3 class="anchor"><code><span class="label label-inline">inline</span><a href="#isAnimFinished"><span class="identifier">isAnimFinished</span></a>():<span class="type">Bool</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="loadSprite"></a><h3 class="anchor"><code><span class="label label-meta label-meta-value" title="Used to store default values for fields and function arguments.">@:value({ Key : null, Unique : false })</span><a href="#loadSprite"><span class="identifier">loadSprite</span></a>(<span style="white-space:nowrap">path:<span class="type">String</span>,</span> <span style="white-space:nowrap">Unique:<span class="type">Bool</span> = false,</span> <span style="white-space:nowrap">?Key:<span class="type">String</span></span>):<span class="type">Void</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="measureHit"></a><h3 class="anchor"><code><a href="#measureHit"><span class="identifier">measureHit</span></a>(<span style="white-space:nowrap">curMeasure:<span class="type">Int</span></span>):<span class="type">Void</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="playAnim"></a><h3 class="anchor"><code><span class="label label-meta label-meta-value" title="Used to store default values for fields and function arguments.">@:value({ Frame : 0, Reversed : false, Context : NONE, Force : false })</span><a href="#playAnim"><span class="identifier">playAnim</span></a>(<span style="white-space:nowrap">AnimName:<span class="type">String</span>,</span> <span style="white-space:nowrap">Force:<span class="type">Bool</span> = false,</span> <span style="white-space:nowrap">Context:<a class="type" title="funkin.scripting.events.PlayAnimContext - Contains all contexts possible for PlayAnimEvent." href="../../../funkin/scripting/events/PlayAnimContext.html">PlayAnimContext</a> = NONE,</span> <span style="white-space:nowrap">Reversed:<span class="type">Bool</span> = false,</span> <span style="white-space:nowrap">Frame:<span class="type">Int</span> = 0</span>):<span class="type">Void</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="stepHit"></a><h3 class="anchor"><code><a href="#stepHit"><span class="identifier">stepHit</span></a>(<span style="white-space:nowrap">curBeat:<span class="type">Int</span></span>):<span class="type">Void</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="switchOffset"></a><h3 class="anchor"><code><a href="#switchOffset"><span class="identifier">switchOffset</span></a>(<span style="white-space:nowrap">anim1:<span class="type">String</span>,</span> <span style="white-space:nowrap">anim2:<span class="type">String</span></span>):<span class="type">Void</span></code></h3><div class="doc"><p></p></div></div></div></div></div></div></div></div></div><footer class="section site-footer" style="background:#FAFAFA"><div class="container"><div class="copyright"><p style="color:#000000">© 2023 </p></div></div></footer><script src="../../..//highlighter.js"></script><link href="../../../highlighter.css" rel="stylesheet"/></body></html> |