funkin.util

Friday Night Funkin' API Reference

..
assets
file
flixel
logging
macro
plugins
tools
AbstractUtil

Class for scripts to use to use various abstracts. TODO: Remove this once Polymod supports instances of abstract classes.

AnsiCode

Enum abstract representing ANSI codes for text colors, background colors, and text styles. TODO: Add more colors?

AnsiUtil

This class provides functionality for applying ANSI codes to strings for terminal output.

BezierUtil

Utilities for performing math with bezier curves.

BitmapUtil

CLIChartParams

CLIParams

CLISongParams

CLIStageParams

CLIUtil

Utilties for interpreting command line arguments.

ClipboardUtil

Utility functions for working with the system clipboard. On platforms that don't support interacting with the clipboard, an internal clipboard is used (neat!).

Constants

A store of unchanging, globally relevant values.

ControllerName

DateUtil

Utilities for performing operations on dates.

DeviceUtil

EaseUtil

FileUtil

Utilities for reading and writing files on various platforms.

FileUtilSandboxed

Utilities for reading and writing files on various platforms. Wrapper for FileUtil that sanitizes paths for script safety.

FileWriteMode

FlxColorUtil

Non inline FlxColor functions for use in hscript files

FlxGamepadUtil

Utilities for working with Flixel gamepads.

FlxTweenUtil

FramesJSFLFrame

FramesJSFLInfo

FramesJSFLParser

See funScripts/jsfl/frames.jsfl for more information in the art repo/folder! Homemade dipshit proprietary format to get simple animation info out of flash! Pure convienience!

GRhythmUtil

GRhythmUtil A utility class for processing hit windows, and calculating the y-position of notes.

HapticUtil

Utility class for extra vibration functions.

HapticsMode

An abstract for vibrations preference.

HaxeUIUtil

HitWindow

A structure to hold the hit window values.

HitWindowRes

A structure to hold the result of a hit window check for botplay.

HostPlatform

Represents a host platform.

InputUtil

Utilities for working with inputs.

MathUtil

Utilities for performing mathematical operations.

MemoryUtil

Utilities for working with the garbage collector.

MouseUtil

Utility functions related to the mouse.

PlatformUtil

Utility functions related to specific platforms.

ReflectUtil

Provides sanitized and blacklisted access to haxe's Reflection functions. Used for sandboxing in scripts.

SRTParser

ScoreInput

Sequence

A timer-based event sequence.

SequenceEvent

A data structure representing a sequence event.

SerializerUtil

Functions dedicated to serializing and deserializing data. NOTE: Use json2object wherever possible, it's way more efficient.

SongSequence

A song-based event sequence.

SortUtil

Utility functions related to sorting.

SubtitleEntry

SubtitleUtils

Utility helpers for using subtitles at runtime

SwipeUtil

Utility class for handling swipe gestures in HaxeFlixel and dispatching signals for different swipe directions.

TouchUtil

Utility class for handling touch input within the FlxG context.

TrackerToolButtonUtil

the name is a bit of a mouthful, but this adds a button to the FlxDebugger Interaction window, which when pressed will open a tracking window corresponding to whatever currently selected objects are

TrackerUtil

Utility class that helps manage adding profiles to the flixel debugger tracker

VersionUtil

Utility functions for operating on semantic versions.

VibrationPreset

A typedef containing data needed for vibrate function call.

WindowUtil

Utilities for operating on the current window, such as changing the title.