funkin.game.HealthIcon - Codename Engine API

Constructor

View in GitHub

`new(?char:String, isPlayer:Bool = false)`

Variables

`animated:Bool = false`

Whenever or not the icon is animated or not

`curAnimState:OneOfTwo<String, Int> = -1`

Current animation state

`curCharacter:String = null`

The currently showing icon

`defaultScale:Float = 1`

The Default Scale For The Icon

This is what scale the icon should return to when its bump animation is finished

`extraOffsets:FlxPoint = FlxPoint.get()`

Extra offsets to add when updating the hitbox

`healthSteps:Map<Int, OneOfTwo<String, Int>> = null`

Health steps in this format:

Min Percentage => Frame Index / Animation Name

`isPlayer:Bool`

If the character is for the player

`sprTracker:FlxSprite`

Attaches the icon to a sprite, following it's position

`sprTrackerAlignment:TrackerAlignment = RIGHT`

Where to place the icon in relation to the sprite

LEFT: Left of the sprite

CENTER: Center of the sprite

RIGHT: Right of the sprite

`sprTrackerOffset:FlxPoint = new FlxPoint(10, -30)`

Offset of the icon in relation to the sprite

By default it is set to (10, -30) and is intended to be used with Alphabet

`xmlData:Xml`

XML Animated Icon data

null if the icon is not animated or its invalid

Methods

View in GitHub

`dynamicbump():Void`

Called every beat, and causes the icon to become bigger

View in GitHub

`dynamicgetIconAnim(health:Float):IconAnimData`

Gets the animation data for a specific health percentage

Parameters:

`health`	Health percentage

Returns:

Animation data (-1 if invalid)

View in GitHub

`setIcon(char:String, allowAnimated:Bool = true):Void`

Sets the icon to the specified character

Parameters:

`char`	Character to set the icon to
`allowAnimated`	Whenever the icon can be animated

View in GitHub

`dynamicupdateBump():Void`

Called every frame and causes the icon to become smaller

Inherited Variables

Defined by FunkinSprite

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

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

`animateAtlas:FlxAnimate`

`beatAnims:Array<BeatAnim> = []`

`beatInterval:Int = 2`

ODD interval -> asynced; EVEN interval -> synced

`beatOffset:Int = 0`

`debugMode:Bool = false`

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

`initialZoom:Float = 1`

`lastAnimContext:PlayAnimContext = DANCE`

`name:String`

`skipNegativeBeats:Bool = false`

`spriteAnimType:XMLAnimType = NONE`

`zoomFactor:Float = 1`

Inherited Methods

Defined by FunkinSprite

View in 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 in GitHub

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

View in GitHub

`inlineremoveAnim(name:String):Void`

View in GitHub

`inlineremoveAnimation(name:String):Void`

View in GitHub

`stepHit(curBeat:Int):Void`

View in GitHub

`inlinestopAnim():Void`

View in GitHub

`inlinestopAnimation():Void`

View in GitHub

class HealthIcon

package funkin.game

extends FunkinSprite

Constructor

new(?char:String, isPlayer:Bool = false)

Variables

animated:Bool = false

curAnimState:OneOfTwo<String, Int> = -1

curCharacter:String = null

defaultScale:Float = 1

extraOffsets:FlxPoint = FlxPoint.get()

healthSteps:Map<Int, OneOfTwo<String, Int>> = null

isPlayer:Bool

sprTracker:FlxSprite

sprTrackerAlignment:TrackerAlignment = RIGHT

sprTrackerOffset:FlxPoint = new FlxPoint(10, -30)

xmlData:Xml

Methods

dynamicbump():Void

dynamicgetIconAnim(health:Float):IconAnimData

setIcon(char:String, allowAnimated:Bool = true):Void

dynamicupdateBump():Void

Inherited Variables

Defined by FunkinSprite

animDatas:Map<String, AnimData> = []

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> = []

initialZoom:Float = 1

lastAnimContext:PlayAnimContext = DANCE

name:String

skipNegativeBeats:Bool = false

spriteAnimType:XMLAnimType = NONE

zoomFactor:Float = 1

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

beatHit(curBeat:Int):Void

copyAtlasValues():Void

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

inlinegetAnimName():Null<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):Void

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

`new(?char:String, isPlayer:Bool = false)`

`animated:Bool = false`

`curAnimState:OneOfTwo<String, Int> = -1`

`curCharacter:String = null`

`defaultScale:Float = 1`

`extraOffsets:FlxPoint = FlxPoint.get()`

`healthSteps:Map<Int, OneOfTwo<String, Int>> = null`

`isPlayer:Bool`

`sprTracker:FlxSprite`

`sprTrackerAlignment:TrackerAlignment = RIGHT`

`sprTrackerOffset:FlxPoint = new FlxPoint(10, -30)`

`xmlData:Xml`

`dynamicbump():Void`

`dynamicgetIconAnim(health:Float):IconAnimData`

`setIcon(char:String, allowAnimated:Bool = true):Void`

`dynamicupdateBump():Void`

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

`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> = []`

`initialZoom:Float = 1`

`lastAnimContext:PlayAnimContext = DANCE`

`name:String`

`skipNegativeBeats:Bool = false`

`spriteAnimType:XMLAnimType = NONE`

`zoomFactor:Float = 1`

`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():Null<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):Void`

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