10 lines
14 KiB
HTML
10 lines
14 KiB
HTML
<!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.game.Character</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> Character</h1><h4><small>package <a href="../../funkin/game/index.html">funkin.game</a></small></h4><h4><small>extends <span class="type">FlxSprite</span></small></h4> <h4><small>implements <a class="type" title="funkin.interfaces.IOffsetCompatible" href="../../funkin/interfaces/IOffsetCompatible.html">IOffsetCompatible</a>, <a class="type" title="funkin.interfaces.IBeatReceiver" href="../../funkin/interfaces/IBeatReceiver.html">IBeatReceiver</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><span class="label label-meta label-meta-value" title="Used to store default values for fields and function arguments.">@:value({ isPlayer : false, character : "bf" })</span><a href="#new"><span class="identifier">new</span></a>(<span style="white-space:nowrap">x:<span class="type">Float</span>,</span> <span style="white-space:nowrap">y:<span class="type">Float</span>,</span> <span style="white-space:nowrap">character:<span class="type">String</span> = "bf",</span> <span style="white-space:nowrap">isPlayer:<span class="type">Bool</span> = false</span>)</code></h3><div class="doc"><p></p></div></div></div><h3 class="section">Variables</h3><div class="fields"><div class="field "><a name="animOffsets"></a><h3 class="anchor"><code><a href="#animOffsets"><span class="identifier">animOffsets</span></a>:<span class="type">Map</span><<span class="type">String</span>, <span class="type">FlxPoint</span>></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="cameraOffset"></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 FlxPoint(0, 0))</span><a href="#cameraOffset"><span class="identifier">cameraOffset</span></a>:<span class="type">FlxPoint</span><span> = new FlxPoint(0, 0)</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="curCharacter"></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("bf")</span><a href="#curCharacter"><span class="identifier">curCharacter</span></a>:<span class="type">String</span><span> = "bf"</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="debugMode"></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(false)</span><a href="#debugMode"><span class="identifier">debugMode</span></a>:<span class="type">Bool</span><span> = false</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="globalOffset"></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 FlxPoint(0, 0))</span><a href="#globalOffset"><span class="identifier">globalOffset</span></a>:<span class="type">FlxPoint</span><span> = new FlxPoint(0, 0)</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="holdTime"></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(4)</span><a href="#holdTime"><span class="identifier">holdTime</span></a>:<span class="type">Float</span><span> = 4</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="icon"></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(null)</span><a href="#icon"><span class="identifier">icon</span></a>:<span class="type">String</span><span> = null</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="isGF"></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(false)</span><a href="#isGF"><span class="identifier">isGF</span></a>:<span class="type">Bool</span><span> = false</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="isPlayer"></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(false)</span><a href="#isPlayer"><span class="identifier">isPlayer</span></a>:<span class="type">Bool</span><span> = false</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="lastHit"></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(-5000)</span><a href="#lastHit"><span class="identifier">lastHit</span></a>:<span class="type">Float</span><span> = -5000</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="playerOffsets"></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(false)</span><a href="#playerOffsets"><span class="identifier">playerOffsets</span></a>:<span class="type">Bool</span><span> = false</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="script"></a><h3 class="anchor"><code><a href="#script"><span class="identifier">script</span></a>:<a class="type" title="funkin.scripting.Script - Class used for scripting." href="../../funkin/scripting/Script.html">Script</a></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="stunned"></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(false)</span><a href="#stunned"><span class="identifier">stunned</span></a>:<span class="type">Bool</span><span> = false</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="xml"></a><h3 class="anchor"><code><a href="#xml"><span class="identifier">xml</span></a>:<span class="type">Access</span></code></h3><div class="doc"><p></p></div></div></div><h3 class="section">Methods</h3><div class="fields"><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="dance"></a><h3 class="anchor"><code><a href="#dance"><span class="identifier">dance</span></a>():<span class="type">Void</span></code></h3><div class="doc"><p>FOR GF DANCING SHIT</p></div></div><div class="field "><a name="getCameraPosition"></a><h3 class="anchor"><code><span class="label label-inline">inline</span><a href="#getCameraPosition"><span class="identifier">getCameraPosition</span></a>():<span class="type">FlxPoint</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="getIcon"></a><h3 class="anchor"><code><span class="label label-inline">inline</span><a href="#getIcon"><span class="identifier">getIcon</span></a>():<span class="type">String</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({ Context : NONE, Frame : 0, Reversed : false, 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">Reversed:<span class="type">Bool</span> = false,</span> <span style="white-space:nowrap">Frame:<span class="type">Int</span> = 0,</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 class="type">Void</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="playSingAnim"></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, suffix : "" })</span><a href="#playSingAnim"><span class="identifier">playSingAnim</span></a>(<span style="white-space:nowrap">direction:<span class="type">Int</span>,</span> <span style="white-space:nowrap">suffix:<span class="type">String</span> = "",</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">curStep:<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><footer class="section site-footer" style="background:#FAFAFA"><div class="container"><div class="copyright"><p style="color:#000000">© 2022 </p></div></div></footer><script src="../..//highlighter.js"></script><link href="../../highlighter.css" rel="stylesheet"/></body></html> |