From a44ef2ff55b5d18767c82edc56a1cc9ee9ed1634 Mon Sep 17 00:00:00 2001 From: Vortex2Oblivion <73261680+Vortex2Oblivion@users.noreply.github.com> Date: Fri, 6 Dec 2024 23:03:47 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20Vortex2O?= =?UTF-8?q?blivion/LeatherEngine@e5923bb10b12e0ff62393bd5acc82d19ebf5e8f6?= =?UTF-8?q?=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- game/SoundGroup.html | 9 +++++++-- states/PlayState.html | 2 +- 2 files changed, 8 insertions(+), 3 deletions(-) diff --git a/game/SoundGroup.html b/game/SoundGroup.html index 77de779cbe..e50112a16f 100644 --- a/game/SoundGroup.html +++ b/game/SoundGroup.html @@ -7,7 +7,7 @@ float: none; text-shadow: 0 0 0 transparent; } -

Constructor

@:value({ maxSize : 0 })new(maxSize:Int = 0)

Variables

read onlymaxLength:Float

The length of the longest sound in the group

pitch:Float

The pitch of this group

read onlyplaying:Bool

Whether or not the sound group is currently playing.

time:Float

The position of this group in milliseconds. +

Constructor

new(?maxSize:Int)

Variables

read onlymaxLength:Float

The length of the longest sound in the group

pitch:Float

The pitch of this group

read onlyplaying:Bool

Whether or not the sound group is currently playing.

time:Float

The position of this group in milliseconds. If set while paused, changes only come into effect after a resume() call.

volume:Float

The volume of this group

Methods

@:value({ startTime : 0.0, forceRestart : false })play(forceRestart:Bool = false, startTime:Float = 0.0, ?endTime:Float):Void

Inherited Variables

Defined by FlxTypedGroup

@:value(0)read onlylength:Int = 0

The number of entries in the members array. For performance and safety you should check this variable instead of members.length unless you really know what you're doing!

maxSize:Int

The maximum capacity of this group. Default is 0, meaning no max capacity, and the group can just grow.

read onlymemberAdded:FlxTypedSignal<T ‑> Void>

A FlxSignal that dispatches when a child is added to this group.

Available since

4.4.0

.

read onlymemberRemoved:FlxTypedSignal<T ‑> Void>

A FlxSignal that dispatches when a child is removed from this group.

Available since

4.4.0

.

read onlymembers:Array<T>

Array of all the members in this group.

Defined by FlxBasic

@:value(idEnumerator++)ID:Int = idEnumerator++

A unique ID starting from 0 and increasing by 1 for each subsequent FlxBasic that is created.

@:value(true)active:Bool = true

Controls whether update() is automatically called by FlxState/FlxGroup.

@:value(true)alive:Bool = true

Useful state for many game objects - "dead" (!alive) vs alive. kill() and revive() both flip this switch (along with exists, but you can override that).

camera:FlxCamera

Gets or sets the first camera of this object.

cameras:Array<FlxCamera>

This determines on which FlxCameras this object will be drawn. If it is null / has not been @@ -17,7 +17,12 @@ Failing that, FlxGroup will add it to the end of the member array. WARNING: If the group has a maxSize that has already been met, the object will NOT be added to the group!

Parameters:

basic

The FlxBasic you want to add to the group.

Returns:

The same FlxBasic object that was passed in.

any(func:T ‑> Bool):Bool

Tests whether any member satisfies the function.

Parameters:

func

The function that tests the members

Available since

5.4.0

.

clear():Void

Remove all instances of FlxBasic subclasses (FlxSprite, FlxTileblock, etc) from the list. -WARNING: does not destroy() or kill() any of these objects!

countDead():Int

Call this function to find out how many members of the group are dead.

Returns:

The number of FlxBasics flagged as dead. Returns -1 if group is empty.

countLiving():Int

Call this function to find out how many members of the group are not dead.

Returns:

The number of FlxBasics flagged as not dead. Returns -1 if group is empty.

draw():Void

Automatically goes through and calls render on everything you added.

every(func:T ‑> Bool):Bool

Tests whether every member satisfies the function.

Parameters:

func

The function that tests the members

Available since

5.4.0

.

@:value({ recurse : false })forEach(func:T ‑> Void, recurse:Bool = false):Void

Applies a function to all members.

Parameters:

func

A function that modifies one element at a time.

recurse

Whether or not to apply the function to members of subgroups as well.

@:value({ recurse : false })forEachAlive(func:T ‑> Void, recurse:Bool = false):Void

Applies a function to all alive members.

Parameters:

func

A function that modifies one element at a time.

recurse

Whether or not to apply the function to members of subgroups as well.

@:value({ recurse : false })forEachDead(func:T ‑> Void, recurse:Bool = false):Void

Applies a function to all dead members.

Parameters:

func

A function that modifies one element at a time.

recurse

Whether or not to apply the function to members of subgroups as well.

@:value({ recurse : false })forEachExists(func:T ‑> Void, recurse:Bool = false):Void

Applies a function to all existing members.

Parameters:

func

A function that modifies one element at a time.

recurse

Whether or not to apply the function to members of subgroups as well.

@:value({ recurse : false })forEachOfType<K>(objectClass:Class<K>, func:K ‑> Void, recurse:Bool = false):Void

Applies a function to all members of type Class<K>.

Parameters:

objectClass

A class that objects will be checked against before Function is applied, ex: FlxSprite.

func

A function that modifies one element at a time.

recurse

Whether or not to apply the function to members of subgroups as well.

getFirst(func:T ‑> Bool):Null<T>

Searches for, and returns the first member that satisfies the function.

Parameters:

func

The function that tests the members

Available since

5.4.0

.

getFirstAlive():Null<T>

Call this function to retrieve the first object with dead == false in the group. +WARNING: does not destroy() or kill() any of these objects!

countDead():Int

Call this function to find out how many members of the group are dead.

Returns:

The number of FlxBasics flagged as dead. Returns -1 if group is empty.

countLiving():Int

Call this function to find out how many members of the group are not dead.

Returns:

The number of FlxBasics flagged as not dead. Returns -1 if group is empty.

destroy():Void

WARNING: A destroyed FlxBasic can't be used anymore. +It may even cause crashes if it is still part of a group or state. +You may want to use kill() instead if you want to disable the object temporarily only and revive() it later.

+

This function is usually not called manually (Flixel calls it automatically during state switches for all add()ed objects).

+

Override this function to null out variables manually or call destroy() on class members if necessary. +Don't forget to call super.destroy()!

draw():Void

Automatically goes through and calls render on everything you added.

every(func:T ‑> Bool):Bool

Tests whether every member satisfies the function.

Parameters:

func

The function that tests the members

Available since

5.4.0

.

@:value({ recurse : false })forEach(func:T ‑> Void, recurse:Bool = false):Void

Applies a function to all members.

Parameters:

func

A function that modifies one element at a time.

recurse

Whether or not to apply the function to members of subgroups as well.

@:value({ recurse : false })forEachAlive(func:T ‑> Void, recurse:Bool = false):Void

Applies a function to all alive members.

Parameters:

func

A function that modifies one element at a time.

recurse

Whether or not to apply the function to members of subgroups as well.

@:value({ recurse : false })forEachDead(func:T ‑> Void, recurse:Bool = false):Void

Applies a function to all dead members.

Parameters:

func

A function that modifies one element at a time.

recurse

Whether or not to apply the function to members of subgroups as well.

@:value({ recurse : false })forEachExists(func:T ‑> Void, recurse:Bool = false):Void

Applies a function to all existing members.

Parameters:

func

A function that modifies one element at a time.

recurse

Whether or not to apply the function to members of subgroups as well.

@:value({ recurse : false })forEachOfType<K>(objectClass:Class<K>, func:K ‑> Void, recurse:Bool = false):Void

Applies a function to all members of type Class<K>.

Parameters:

objectClass

A class that objects will be checked against before Function is applied, ex: FlxSprite.

func

A function that modifies one element at a time.

recurse

Whether or not to apply the function to members of subgroups as well.

getFirst(func:T ‑> Bool):Null<T>

Searches for, and returns the first member that satisfies the function.

Parameters:

func

The function that tests the members

Available since

5.4.0

.

getFirstAlive():Null<T>

Call this function to retrieve the first object with dead == false in the group. This is handy for checking if everything's wiped out, or choosing a squad leader, etc.

Returns:

A FlxBasic currently flagged as not dead.

@:value({ force : false })getFirstAvailable(?objectClass:Class<T>, force:Bool = false):Null<T>

Call this function to retrieve the first object with exists == false in the group. This is handy for recycling in general, e.g. respawning enemies.

Parameters:

objectClass

An optional parameter that lets you narrow the results to instances of this particular class.

force

Force the object to be an ObjectClass and not a super class of ObjectClass.

Returns:

A FlxBasic currently flagged as not existing.

getFirstDead():Null<T>

Call this function to retrieve the first object with dead == true in the group. diff --git a/states/PlayState.html b/states/PlayState.html index 532ca3dd2b..6b98d6e027 100644 --- a/states/PlayState.html +++ b/states/PlayState.html @@ -20,7 +20,7 @@

1 = Every Beat,
 2 = Every Other Beat,
 etc.
-

@:value(1)health:Float = 1

Current health of the player (stored as a range from minHealth to maxHealth, which is by default 0 to 2).

healthBar:FlxBar

The health bar.

healthBarBG:FlxSprite

Background sprite for the health bar.

@:value(1)healthShown:Float = 1

Current health being shown on the healthBar. (Is inverted from normal when playing as opponent)

@:value(0.0)hitNotes:Float = 0.0

Total notes hit (is a Float because it's used for accuracy calculations).

@:value(Options.getData("hitsound"))hitSoundString:String = Options.getData("hitsound")

The current hitsound the player is using. (By default is 'none')

@:value([])hscriptEvents:Map<String, HScript> = []

iconP1:HealthIcon

The icon for the player character (bf).

iconP2:HealthIcon

The icon for the opponent character (dad).

@:value("")iconRPC:String = ""

Small Icon to use in RPC.

@:value(false)inCutscene:Bool = false

Whether or not you are currently in a cutscene.

@:value(false)invincible:Bool = false

@:value([])luaScriptArray:Array<ModchartUtilities> = []

Array of Lua scripts.

@:value([])maniaChanges:Array<Dynamic> = []

@:value(Options.getData("marvelousRatings"))marvelousRatings:Bool = Options.getData("marvelousRatings")

@:value(0)maxCombo:Int = 0

Current combo (or amount of notes hit in a row without a combo break).

@:value(2)maxHealth:Float = 2

Maximum health value. (Defaults to 2)

@:value(0)minHealth:Float = 0

Minimum health value. (Defaults to 0)

@:value([])missSounds:Array<FlxSound> = []

Array of cached miss sounds.

@:value(0)misses:Int = 0

Current miss count for the player.

noteBG:FlxSprite

The note underlay colored black. +

@:value(1)health:Float = 1

Current health of the player (stored as a range from minHealth to maxHealth, which is by default 0 to 2).

healthBar:FlxBar

The health bar.

healthBarBG:FlxSprite

Background sprite for the health bar.

@:value(1)healthShown:Float = 1

Current health being shown on the healthBar. (Is inverted from normal when playing as opponent)

@:value(0.0)hitNotes:Float = 0.0

Total notes hit (is a Float because it's used for accuracy calculations).

@:value(Options.getData("hitsound"))hitSoundString:String = Options.getData("hitsound")

The current hitsound the player is using. (By default is 'none')

@:value([])hscriptEvents:Map<String, HScript> = []

iconP1:HealthIcon

The icon for the player character (bf).

iconP2:HealthIcon

The icon for the opponent character (dad).

@:value("")iconRPC:String = ""

Small Icon to use in RPC.

@:value(false)inCutscene:Bool = false

Whether or not you are currently in a cutscene.

@:value(false)invincible:Bool = false

@:value([])luaScriptArray:Array<ModchartUtilities> = []

Array of Lua scripts.

@:value([])maniaChanges:Array<Dynamic> = []

@:value(Options.getData("marvelousRatings"))marvelousRatings:Bool = Options.getData("marvelousRatings")

@:value(0)maxCombo:Int = 0

Current combo (or amount of notes hit in a row without a combo break).

@:value(2)maxHealth:Float = 2

Maximum health value. (Defaults to 2)

@:value(0)minHealth:Float = 0

Minimum health value. (Defaults to 0)

@:value([])missSounds:Array<FlxSound> = []

Array of cached miss sounds.

@:value(0)misses:Int = 0

Current miss count for the player.

noteBG:FlxSprite

The note underlay colored black. Turned off by default.

notes:FlxTypedGroup<Note>

FlxTypedGroup of all currently active notes in the game.

@:value([])number_Tweens:Array<VarTween> = []

@:value([])numbers:Array<FlxSprite> = []

@:value(4)ogKeyCount:Int = 4

Keeps track of the original opponent (or both if not specified for player) key count.

(Used when playing as opponent).

@:value(4)ogPlayerKeyCount:Int = 4

Keeps track of the original player key count.

(Used when playing as opponent).

@:value(Options.getData("opponentNoteSplashes"))opponentNoteSplashes:Bool = Options.getData("opponentNoteSplashes")

Should the opponent spawn a notesplash on a sick or marvelous rating?

@:value(false)paused:Bool = false

@:value(Options.getData("playerNoteSplashes"))playerNoteSplashes:Bool = Options.getData("playerNoteSplashes")

Should the player spawn a notesplash on a sick or marvelous rating?

@:value([])prevEnemyXVals:Map<String, Float> = []

@:value([])prevPlayerXVals:Map<String, Float> = []

@:value(new FlxSprite())rating:FlxSprite = new FlxSprite()

@:value("")ratingStr:String = ""

ratingText:FlxText

Current text that displays your ratings (plus misses and MA/PA).

@:value(["marvelous" => 0, "sick" => 0, "good" => 0, "bad" => 0, "shit" => 0])ratings:Map<String, Int> = ["marvelous" => 0, "sick" => 0, "good" => 0, "bad" => 0, "shit" => 0]

A Map of the String names of the ratings to the amount of times you got them.

@:value(new FlxSpriteGroup())ratingsGroup:FlxSpriteGroup = new FlxSpriteGroup()

scoreTxt:FlxText

Current text under the health bar (displays score and other stats).

@:value([])scripts:Array<HScript> = []

@:value(0)songLength:Float = 0

Length of the current song's instrumental track in milliseconds.

@:value(0)songScore:Int = 0

Current score for the player.

@:value(0.0)song_info_timer:Float = 0.0

@:value(1.0)speed:Float = 1.0

@:value(new FlxTypedSpriteGroup<NoteSplash>())splash_group:FlxTypedSpriteGroup<NoteSplash> = new FlxTypedSpriteGroup<NoteSplash>()

FlxTypedGroup of NoteSplashs used to contain all note splashes