funkin.game.Character - Codename Engine API

Like playSingAnimUnsafe but checks if the character has the animation with the suffix part, otherwise it plays the animation without the suffix part.

View on GitHub

`playSingAnimUnsafe(direction:Int, suffix:String = "", Context:PlayAnimContext = SING, Force:Bool = true, Reversed:Bool = false, Frame:Int = 0):Void`

View on GitHub

`postDraw():Void`

View on GitHub

`preDraw():Void`

View on GitHub

`prepareInfos(node:Access):XMLImportedScriptInfo`

View on GitHub

`swapLeftRightAnimations():Void`

View on GitHub

`tryDance():Void`

Inherited Variables

Defined by FunkinSprite

`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`

Inherited Methods

Defined by FunkinSprite

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

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

View on GitHub

`copyAtlasValues():Void`

View on GitHub

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

View on GitHub

`inlinegetAnimName():String`

View on GitHub

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

View on GitHub

`inlinegetNameList():Array<String>`

View on GitHub

`inlinehasAnim(AnimName:String):Bool`

View on GitHub

`inlinehasAnimation(AnimName:String):Bool`

View on GitHub

`inlineisAnimAtEnd():Bool`

View on GitHub

`inlineisAnimFinished():Bool`

View on GitHub

`inlineisAnimReversed():Bool`

View on GitHub

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

View on GitHub

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

View on GitHub

`inlineremoveAnim(name:String):Void`

View on GitHub

`inlineremoveAnimation(name:String):Void`

View on GitHub

`inlinestopAnim():Void`

View on GitHub

`inlinestopAnimation():Void`

View on GitHub

class Character

package funkin.game

extends FunkinSprite

implements IPrePostDraw, IOffsetCompatible, IBeatReceiver

extended by CharacterGhost

Static variables

staticFALLBACK_CHARACTER:String = Flags.DEFAULT_CHARACTER

staticFALLBACK_DEAD_CHARACTER:String = Flags.DEFAULT_GAMEOVER_CHARACTER

staticcharacterAnimProperties:Array<String> = ["name", "anim", "x", "y", "fps", "loop", "indices"]

staticcharacterProperties:Array<String> = ["x", "y", "sprite", "scale", "antialiasing", "flipX", "camx", "camy", "isPlayer", "icon", "color", "gameOverChar", "holdTime"]

Static methods

staticgetIconFromCharName(?character:String, ?defaultIcon:String):String

staticgetList(mods:Bool = false, includeFolders:Bool = false, folder:String = "data/characters/"):Array<String>

staticgetXMLFromCharName(character:OneOfTwo<String, Character>):Access

Constructor

new(x:Float, y:Float, ?character:String, isPlayer:Bool = false, switchAnims:Bool = true, disableScripts:Bool = false)

Variables

cameraOffset:FlxPoint = FlxPoint.get(0, 0)

curCharacter:String = Flags.DEFAULT_CHARACTER

danceOnBeat:Bool = true

extraOffset:FlxPoint = FlxPoint.get(0, 0)

gameOverCharacter:String = Character.FALLBACK_DEAD_CHARACTER

ghostDraw:Bool = false

globalOffset:FlxPoint = FlxPoint.get(0, 0)

holdTime:Float = 4

icon:String = null

iconColor:Null<FlxColor> = null

idleSuffix:String = ""

isPlayer:Bool = false

lastHit:Float = Math.NEGATIVE_INFINITY

playerOffsets:Bool = false

script:Script

scripts:ScriptPack

singAnims:Array<String> = ["singLEFT", "singDOWN", "singUP", "singRIGHT"]

sprite:String = Flags.DEFAULT_CHARACTER

stunned:Bool = false

xml:Access

xmlImportedScripts:Array<XMLImportedScriptInfo> = []

Methods

dynamicafterTrailCache():Void

applyXML(xml:Access):Void

dynamicbeforeTrailCache():Void

inlinebuildCharacter(xml:Access):Void

inlinebuildXML(?animsOrder:Array<String>):Xml

dance():Void

fixChar(switchAnims:Bool = false, autoInterval:Bool = false):Void

getAnimOrder():Array<String>

inlinegetCameraPosition():FlxPoint

inlinegetIcon():String

inlinegetSingAnim(direction:Int, suffix:String = ""):String

isFlippedOffsets():Bool

playSingAnim(direction:Int, suffix:String = "", Context:PlayAnimContext = SING, ?Force:Bool, Reversed:Bool = false, Frame:Int = 0):Void

playSingAnimUnsafe(direction:Int, suffix:String = "", Context:PlayAnimContext = SING, Force:Bool = true, Reversed:Bool = false, Frame:Int = 0):Void

postDraw():Void

preDraw():Void

prepareInfos(node:Access):XMLImportedScriptInfo

swapLeftRightAnimations():Void

tryDance():Void

Inherited Variables

Defined by FunkinSprite

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

Inherited Methods

Defined by FunkinSprite

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

`staticFALLBACK_CHARACTER:String = Flags.DEFAULT_CHARACTER`

`staticFALLBACK_DEAD_CHARACTER:String = Flags.DEFAULT_GAMEOVER_CHARACTER`

`staticcharacterAnimProperties:Array<String> = ["name", "anim", "x", "y", "fps", "loop", "indices"]`

`staticcharacterProperties:Array<String> = ["x", "y", "sprite", "scale", "antialiasing", "flipX", "camx", "camy", "isPlayer", "icon", "color", "gameOverChar", "holdTime"]`

`staticgetIconFromCharName(?character:String, ?defaultIcon:String):String`

`staticgetList(mods:Bool = false, includeFolders:Bool = false, folder:String = "data/characters/"):Array<String>`

`staticgetXMLFromCharName(character:OneOfTwo<String, Character>):Access`

`new(x:Float, y:Float, ?character:String, isPlayer:Bool = false, switchAnims:Bool = true, disableScripts:Bool = false)`

`cameraOffset:FlxPoint = FlxPoint.get(0, 0)`

`curCharacter:String = Flags.DEFAULT_CHARACTER`

`danceOnBeat:Bool = true`

`extraOffset:FlxPoint = FlxPoint.get(0, 0)`

`gameOverCharacter:String = Character.FALLBACK_DEAD_CHARACTER`

`ghostDraw:Bool = false`

`globalOffset:FlxPoint = FlxPoint.get(0, 0)`

`holdTime:Float = 4`

`icon:String = null`

`iconColor:Null<FlxColor> = null`

`idleSuffix:String = ""`

`isPlayer:Bool = false`

`lastHit:Float = Math.NEGATIVE_INFINITY`

`playerOffsets:Bool = false`

`script:Script`

`scripts:ScriptPack`

`singAnims:Array<String> = ["singLEFT", "singDOWN", "singUP", "singRIGHT"]`

`sprite:String = Flags.DEFAULT_CHARACTER`

`stunned:Bool = false`

`xml:Access`

`xmlImportedScripts:Array<XMLImportedScriptInfo> = []`

`dynamicafterTrailCache():Void`

`applyXML(xml:Access):Void`

`dynamicbeforeTrailCache():Void`

`inlinebuildCharacter(xml:Access):Void`

`inlinebuildXML(?animsOrder:Array<String>):Xml`

`dance():Void`

`fixChar(switchAnims:Bool = false, autoInterval:Bool = false):Void`

`getAnimOrder():Array<String>`

`inlinegetCameraPosition():FlxPoint`

`inlinegetIcon():String`

`inlinegetSingAnim(direction:Int, suffix:String = ""):String`

`isFlippedOffsets():Bool`

`playSingAnim(direction:Int, suffix:String = "", Context:PlayAnimContext = SING, ?Force:Bool, Reversed:Bool = false, Frame:Int = 0):Void`

`playSingAnimUnsafe(direction:Int, suffix:String = "", Context:PlayAnimContext = SING, Force:Bool = true, Reversed:Bool = false, Frame:Int = 0):Void`

`postDraw():Void`

`preDraw():Void`

`prepareInfos(node:Access):XMLImportedScriptInfo`

`swapLeftRightAnimations():Void`

`tryDance():Void`

`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`

`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`

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

`inlineremoveAnim(name:String):Void`

`inlineremoveAnimation(name:String):Void`