Static Functions
angleIsInSpikeThreshold(angle:Float):Bool
Description
Returns true if the angle is within the spike threshold.
Instance Functions
addDamage(dmg:Float):Float
Description
addStatusEffect(type:Int, value?:Float, options?:StatusEffectObjectOptions):StatusEffectObject
Description
applyGlobalBodyStatus(status:Int, duration:Int):BodyStatusTimer
Description
attemptGrab(foe:GameObject, options?:ForceGrabOptions):Bool
Description
Attempt to grab the foe.
Parameters:
- options - Instructions for the types of grab-safety checks to ignore
attemptHit(target:GameObject, hitboxStats:HitboxStats, collisionResult?:CollisionResult):Bool
Description
Initiates processing as though a hitbox=>hurtbox collision was detected. Due to validation checks during processing, a "hit" may not occur. Parameters:
- target - GameObject receiving the hit
- hitboxStats - Stats that determine the effect of the "hit"
- collisionResult - Optional object containing "boxes" that represent the positional information of any involved hitboxes during the hit. Can be useful for generating spatially aware hit effects, and will automatically adjust built-in hit effect positioning to the specified overlap box.
findStatusEffectObjectsByTag(type:Int, tag:String):Array<StatusEffectObject>
Description
forceStartHitstop(value:Int, shake:Bool):Void
Description
Forcibly starts a new set of hitstop. @see GameObjectEvent.HITSTOP_END @see GameObjectEvent.HITSTOP_START Parameters:
- value - Duration in frames
- shake - True if camera should shake
forceStartHitstun(value:Int):Void
Description
Forcibly starts a new set of hitstun. @see GameObjectEvent.ENTER_HITSTUN @see GameObjectEvent.EXIT_HITSTUN Parameters:
- value - Duration in frames
getAllGrabbedFoes():Array<GameObject>
Description
Returns all foes the grabbed foes array.
getAlpha():Float
Description
getAnimationStat(name:String):Dynamic
Description
getAnimationStatsMetadata():Dynamic
Description
getCostumeIndex():Int
Description
getCostumeShader():PaletteSwapShader
Description
getDamage():Float
Description
getDamageCounterContainer():Container
Description
getDamageCounterRenderSprite():Sprite
Description
getGameObjectStat(name:String):Dynamic
Description
getGameObjectStatsMetadata():Dynamic
Description
getGrabbedFoe():GameObject
Description
Returns the first grabbed foe in the grabbed foes array.
getHitstop():Int
Description
getHitstun():Int
Description
getOffscreenIndicator():OffscreenIndicator
Description
getOwner():GameObject
Description
getPlayerBorder():PlayerBorder
Description
getRootOwner():GameObject
Description
getScaleX():Float
Description
getScaleY():Float
Description
getSprite():Sprite
Description
getStatusEffectByType(type:Int):StatusEffect
Description
getTeam():Int
Description
getVisible():Bool
Description
hasBodyStatus(flags:Int):Bool
Description
pause():Void
Description
reactivateHitboxes():Void
Description
Refreshes the attack's UID allowing it to hit again.
releaseAllCharacters(grabReleaseKb?:Bool):Void
Description
releaseCharacter(character:Character, grabReleaseKb?:Bool):Void
Description
removeStatusEffect(type:Int, id:String):Bool
Description
resume():Void
Description
setAlpha(value:Float):Float
Description
setCostumeIndex(costumeIndex:Int):Void
Description
setCostumeShader(paletteSwapShader:PaletteSwapShader):Void
Description
setDamage(dmg:Float):Float
Description
setOwner(owner:GameObject):Void
Description
setPlayerBorder(playerBorder:PlayerBorder):Void
Description
setScaleX(scaleX:Float):Float
Description
setScaleY(scaleY:Float):Float
Description
setVisible(value:Bool):Bool
Description
setXVelocity(speed:Float):Float
Description
setYVelocity(speed:Float):Float
Description
startHitstop(value:Int, shake:Bool):Bool
Description
Attempts to start a new set of hitstop. Only starts a new set of hitstop if the new value is greater than the existing value. @see GameObjectEvent.HITSTOP_END @see GameObjectEvent.HITSTOP_START Parameters:
- value - Duration in frames
- shake - True if camera should shake
startHitstun(value:Int):Bool
Description
Attempts to start a new set of hitstun. Only starts a new set of hitstun if the new value is greater than the existing value. @see GameObjectEvent.ENTER_HITSTUN @see GameObjectEvent.EXIT_HITSTUN Parameters:
- value - Duration in frames