funkin.backend.FunkinSprite - Codename Engine API

Static methods

View on GitHub

`staticcopyFrom(source:FlxSprite):FunkinSprite`

Gets the graphics and copies other properties from another sprite (Works both for FlxSprite and FunkinSprite!).

Constructor

View on GitHub

`new(X:Float = 0, Y:Float = 0, ?SimpleGraphic:Null<FlxGraphicAsset>)`

Variables

`animDatas:Map<String, AnimData> = []`

`animEnabled:Bool = true`

`animOffsets:Map<String, FlxPoint> = new Map<String,FlxPoint>()`

`animateAtlas:FlxAnimate`

`beatAnims:Array<BeatAnim> = []`

`beatInterval:Int = 2`

ODD interval -> not aligned to beats EVEN interval -> aligned to beats

`beatOffset:Int = 0`

`debugMode:Bool = false`

`extra:Map<String, Dynamic> = []`

`globalCurFrame:Int`

`lastAnimContext:PlayAnimContext = DANCE`

`name:String`

`skipNegativeBeats:Bool = false`

`spriteAnimType:XMLAnimType = NONE`

`zoomFactor:Float = 1`

`zoomFactorEnabled:Bool = true`

Methods

View on GitHub

`inlineaddAnim(name:String, prefix:String, frameRate:Float = 24, ?looped:Bool, ?forced:Bool, ?indices:Array<Int>, x:Float = 0, y:Float = 0, animType:XMLAnimType = NONE):ErrorCode`

View on GitHub

`playAnim(AnimName:String, ?Force:Bool, Context:PlayAnimContext = NONE, Reversed:Bool = false, Frame:Int = 0):Void`

View on GitHub

`inlineremoveAnim(name:String):Void`

View on GitHub

`inlineremoveAnimation(name:String):Void`

View on GitHub

`stepHit(curBeat:Int):Void`

View on GitHub

`inlinestopAnim():Void`

View on GitHub

`inlinestopAnimation():Void`

View on GitHub

class FunkinSprite

package funkin.backend

extends FlxSkewedSprite

implements IXMLEvents, IOffsetCompatible, IBeatReceiver

extended by DialogueBox, DialogueCharacter, Character, HealthIcon, Splash

Static methods

staticcopyFrom(source:FlxSprite):FunkinSprite

Constructor

new(X:Float = 0, Y:Float = 0, ?SimpleGraphic:Null<FlxGraphicAsset>)

Variables

animDatas:Map<String, AnimData> = []

animEnabled:Bool = true

animOffsets:Map<String, FlxPoint> = new Map<String,FlxPoint>()

animateAtlas:FlxAnimate

beatAnims:Array<BeatAnim> = []

beatInterval:Int = 2

beatOffset:Int = 0

debugMode:Bool = false

extra:Map<String, Dynamic> = []

globalCurFrame:Int

lastAnimContext:PlayAnimContext = DANCE

name:String

skipNegativeBeats:Bool = false

spriteAnimType:XMLAnimType = NONE

zoomFactor:Float = 1

zoomFactorEnabled:Bool = true

Methods

inlineaddAnim(name:String, prefix:String, frameRate:Float = 24, ?looped:Bool, ?forced:Bool, ?indices:Array<Int>, x:Float = 0, y:Float = 0, animType:XMLAnimType = NONE):ErrorCode

addOffset(name:String, x:Float = 0, y:Float = 0):Void

beatHit(curBeat:Int):Void

copyAtlasValues():Void

getAnim(name:String):OneOfTwo<FlxAnimation, FlxSymbolAnimation>

inlinegetAnimName():String

inlinegetAnimOffset(name:String):Null<FlxPoint>

inlinegetNameList():Array<String>

inlinehasAnim(AnimName:String):Bool

inlinehasAnimation(AnimName:String):Bool

inlineisAnimAtEnd():Bool

inlineisAnimFinished():Bool

inlineisAnimReversed():Bool

loadSprite(path:String, Unique:Bool = false, ?Key:String):FunkinSprite

measureHit(curMeasure:Int):Void

onPropertySet(property:String, value:Dynamic):Void

playAnim(AnimName:String, ?Force:Bool, Context:PlayAnimContext = NONE, Reversed:Bool = false, Frame:Int = 0):Void

inlineremoveAnim(name:String):Void

inlineremoveAnimation(name:String):Void

stepHit(curBeat:Int):Void

inlinestopAnim():Void

inlinestopAnimation():Void

switchOffset(anim1:String, anim2:String):Void

`staticcopyFrom(source:FlxSprite):FunkinSprite`

`new(X:Float = 0, Y:Float = 0, ?SimpleGraphic:Null<FlxGraphicAsset>)`

`animDatas:Map<String, AnimData> = []`

`animEnabled:Bool = true`

`animOffsets:Map<String, FlxPoint> = new Map<String,FlxPoint>()`

`animateAtlas:FlxAnimate`

`beatAnims:Array<BeatAnim> = []`

`beatInterval:Int = 2`

`beatOffset:Int = 0`

`debugMode:Bool = false`

`extra:Map<String, Dynamic> = []`

`globalCurFrame:Int`

`lastAnimContext:PlayAnimContext = DANCE`

`name:String`

`skipNegativeBeats:Bool = false`

`spriteAnimType:XMLAnimType = NONE`

`zoomFactor:Float = 1`

`zoomFactorEnabled:Bool = true`

`inlineaddAnim(name:String, prefix:String, frameRate:Float = 24, ?looped:Bool, ?forced:Bool, ?indices:Array<Int>, x:Float = 0, y:Float = 0, animType:XMLAnimType = NONE):ErrorCode`

`addOffset(name:String, x:Float = 0, y:Float = 0):Void`

`beatHit(curBeat:Int):Void`

`copyAtlasValues():Void`

`getAnim(name:String):OneOfTwo<FlxAnimation, FlxSymbolAnimation>`

`inlinegetAnimName():String`

`inlinegetAnimOffset(name:String):Null<FlxPoint>`

`inlinegetNameList():Array<String>`

`inlinehasAnim(AnimName:String):Bool`

`inlinehasAnimation(AnimName:String):Bool`

`inlineisAnimAtEnd():Bool`

`inlineisAnimFinished():Bool`

`inlineisAnimReversed():Bool`

`loadSprite(path:String, Unique:Bool = false, ?Key:String):FunkinSprite`

`measureHit(curMeasure:Int):Void`

`onPropertySet(property:String, value:Dynamic):Void`

`playAnim(AnimName:String, ?Force:Bool, Context:PlayAnimContext = NONE, Reversed:Bool = false, Frame:Int = 0):Void`

`inlineremoveAnim(name:String):Void`

`inlineremoveAnimation(name:String):Void`

`stepHit(curBeat:Int):Void`

`inlinestopAnim():Void`

`inlinestopAnimation():Void`

`switchOffset(anim1:String, anim2:String):Void`