Skip to content

Commit

Permalink
docs for the love of Fuck dont not work
Browse files Browse the repository at this point in the history
  • Loading branch information
poco0317 committed Aug 5, 2024
1 parent 9956bb2 commit c494afd
Show file tree
Hide file tree
Showing 9 changed files with 80 additions and 91 deletions.
11 changes: 5 additions & 6 deletions Themes/_fallback/docs/Actors/ComboGraph.luadoc
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
--- Combo Graph class
--[[
The ComboGraph will display the combos for a score on a graph.
Although, it's a bit more integrated with PlayerStageStats than one might desire...
A ComboGraph can be created directly with `Def.ComboGraph`
Its primary use is in ScreenEvaluation
--]]
--
-- The ComboGraph will display the combos for a score on a graph.
-- Although, it's a bit more integrated with PlayerStageStats than one might desire...
-- A ComboGraph can be created directly with `Def.ComboGraph`
-- Its primary use is in ScreenEvaluation
-- @classmod ComboGraph


Expand Down
9 changes: 4 additions & 5 deletions Themes/_fallback/docs/Actors/MusicWheel.luadoc
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
--- Music Wheel class
--[[
This class inherits methods from the @{WheelBase} class. A MusicWheel is the structure responsible for
allowing the user to scroll through songs and make a selection to play.
The easiest way to acquire the existing MusicWheel on a screen is `SCREENMAN:GetTopScreen():GetMusicWheel()`
--]]
--
-- This class inherits methods from the @{WheelBase} class. A MusicWheel is the structure responsible for
-- allowing the user to scroll through songs and make a selection to play.
-- The easiest way to acquire the existing MusicWheel on a screen is `SCREENMAN:GetTopScreen():GetMusicWheel()`
-- @classmod MusicWheel

--- Change the @{SortOrder} for the MusicWheel. This is the equivalent of pressing UpDown UpDown then making a choice.
Expand Down
7 changes: 3 additions & 4 deletions Themes/_fallback/docs/Actors/NoteField.luadoc
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
--- NoteField class
--[[
This class contains the components responsible for displaying notes in gameplay.
The simplest way to get the NoteField in gameplay is `SCREENMAN:GetTopScreen():GetChild("PlayerP1"):GetChild("NoteField")`
--]]
--
-- This class contains the components responsible for displaying notes in gameplay.
-- The simplest way to get the NoteField in gameplay is `SCREENMAN:GetTopScreen():GetChild("PlayerP1"):GetChild("NoteField")`
-- @classmod NoteField


Expand Down
11 changes: 5 additions & 6 deletions Themes/_fallback/docs/Actors/Player.luadoc
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
--- Player control class
--[[
This controls the user interaction with the current chart being played in gameplay.
One way to retrieve the Player in gameplay is `SCREENMAN:GetTopScreen():GetChild("PlayerP1")`
The Player owns the @{NoteField}, Combo, Tap Judgments, and Hold Judgments, among other things.
Most of these children can be found via GetChild by name, such as "Combo", "Judgment", "NoteField"
--]]
--
-- This controls the user interaction with the current chart being played in gameplay.
-- One way to retrieve the Player in gameplay is `SCREENMAN:GetTopScreen():GetChild("PlayerP1")`
-- The Player owns the @{NoteField}, Combo, Tap Judgments, and Hold Judgments, among other things.
-- Most of these children can be found via GetChild by name, such as "Combo", "Judgment", "NoteField"
-- @classmod Player

--- Set the Lifebar to a new given value.
Expand Down
7 changes: 3 additions & 4 deletions Themes/_fallback/docs/Actors/WheelBase.luadoc
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
--- Selection Wheel base class
--[[
This is the base class for other wheel classes such as @{MusicWheel} and @{RoomWheel}
The easiest way to acquire the existing Wheel on a screen is `SCREENMAN:GetTopScreen():GetMusicWheel()`
--]]
--
-- This is the base class for other wheel classes such as @{MusicWheel} and @{RoomWheel}
-- The easiest way to acquire the existing Wheel on a screen is `SCREENMAN:GetTopScreen():GetMusicWheel()`
-- @classmod WheelBase

--- Move the wheel a given amount of choices in some direction.
Expand Down
18 changes: 8 additions & 10 deletions Themes/_fallback/docs/Enums/HoldNoteScore.luadoc
Original file line number Diff line number Diff line change
@@ -1,12 +1,10 @@
--- HoldNoteScore enum
--[[
HoldNoteScore is the enum representing the score for a hold or roll.
The simplest way to pass them around in Lua is by directly referencing as a string.
Valid HoldNoteScores:
"HoldNoteScore_None" (The lack of a score)
"HoldNoteScore_LetGo" (The hold was dropped after hitting the head)
"HoldNoteScore_Held" (The hold was completed)
"HoldNoteScore_Missed" (The hold was completely missed, including the head)

--]]
--
-- HoldNoteScore is the enum representing the score for a hold or roll.
-- The simplest way to pass them around in Lua is by directly referencing as a string.
-- Valid HoldNoteScores:
-- "HoldNoteScore_None" (The lack of a score)
-- "HoldNoteScore_LetGo" (The hold was dropped after hitting the head)
-- "HoldNoteScore_Held" (The hold was completed)
-- "HoldNoteScore_Missed" (The hold was completely missed, including the head)
-- @classmod HoldNoteScore
49 changes: 24 additions & 25 deletions Themes/_fallback/docs/Enums/SortOrder.luadoc
Original file line number Diff line number Diff line change
@@ -1,27 +1,26 @@
--- SortOrder enum
--[[
SortOrder is the enum representing a SortOrder for Songs.
The simplest way to pass them around in Lua is by directly referencing as a string.
Valid SortOrders:
"SortOrder_Group"
"SortOrder_Title"
"SortOrder_BPM"
"SortOrder_TopGrades"
"SortOrder_Artist"
"SortOrder_Genre"
"SortOrder_ModeMenu"
"SortOrder_Length"
"SortOrder_DateAdded"
"SortOrder_Favorites"
"SortOrder_Overall"
"SortOrder_Stream"
"SortOrder_Jumpstream"
"SortOrder_Handstream"
"SortOrder_Stamina"
"SortOrder_JackSpeed"
"SortOrder_Chordjack"
"SortOrder_Technical"
"SortOrder_Author"
"SortOrder_Ungrouped"
--]]
--
-- SortOrder is the enum representing a SortOrder for Songs.
-- The simplest way to pass them around in Lua is by directly referencing as a string.
-- Valid SortOrders:
-- "SortOrder_Group"
-- "SortOrder_Title"
-- "SortOrder_BPM"
-- "SortOrder_TopGrades"
-- "SortOrder_Artist"
-- "SortOrder_Genre"
-- "SortOrder_ModeMenu"
-- "SortOrder_Length"
-- "SortOrder_DateAdded"
-- "SortOrder_Favorites"
-- "SortOrder_Overall"
-- "SortOrder_Stream"
-- "SortOrder_Jumpstream"
-- "SortOrder_Handstream"
-- "SortOrder_Stamina"
-- "SortOrder_JackSpeed"
-- "SortOrder_Chordjack"
-- "SortOrder_Technical"
-- "SortOrder_Author"
-- "SortOrder_Ungrouped"
-- @classmod SortOrder
32 changes: 15 additions & 17 deletions Themes/_fallback/docs/Enums/TapNoteScore.luadoc
Original file line number Diff line number Diff line change
@@ -1,19 +1,17 @@
--- TapNoteScore enum
--[[
TapNoteScore is the enum representing the score for a tap.
The simplest way to pass them around in Lua is by directly referencing as a string.
Valid TapNoteScores:
"TapNoteScore_None" (The lack of a score)
"TapNoteScore_HitMine"
"TapNoteScore_AvoidMine" (Did not hit a mine)
"TapNoteScore_CheckpointMiss" (deprecated)
"TapNoteScore_Miss"
"TapNoteScore_W5" (Bad)
"TapNoteScore_W4" (Good)
"TapNoteScore_W3" (Great)
"TapNoteScore_W2" (Perfect)
"TapNoteScore_W1" (Marvelous)
"TapNoteScore_CheckpointHit" (deprecated)

--]]
--
-- TapNoteScore is the enum representing the score for a tap.
-- The simplest way to pass them around in Lua is by directly referencing as a string.
-- Valid TapNoteScores:
-- "TapNoteScore_None" (The lack of a score)
-- "TapNoteScore_HitMine"
-- "TapNoteScore_AvoidMine" (Did not hit a mine)
-- "TapNoteScore_CheckpointMiss" (deprecated)
-- "TapNoteScore_Miss"
-- "TapNoteScore_W5" (Bad)
-- "TapNoteScore_W4" (Good)
-- "TapNoteScore_W3" (Great)
-- "TapNoteScore_W2" (Perfect)
-- "TapNoteScore_W1" (Marvelous)
-- "TapNoteScore_CheckpointHit" (deprecated)
-- @classmod TapNoteScore
27 changes: 13 additions & 14 deletions Themes/_fallback/docs/Enums/WheelItemDataType.luadoc
Original file line number Diff line number Diff line change
@@ -1,16 +1,15 @@
--- WheelItemDataType enum
--[[
WheelItemDataType is the enum representing the type for a WheelItem.
The simplest way to pass them around in Lua is by directly referencing as a string.
Valid WheelItemDataTypes:
"WheelItemDataType_Generic"
"WheelItemDataType_Section"
"WheelItemDataType_Song"
"WheelItemDataType_Roulette"
"WheelItemDataType_Random"
"WheelItemDataType_Portal"
"WheelItemDataType_Course"
"WheelItemDataType_Sort"
"WheelItemDataType_Custom"
--]]
--
-- WheelItemDataType is the enum representing the type for a WheelItem.
-- The simplest way to pass them around in Lua is by directly referencing as a string.
-- Valid WheelItemDataTypes:
-- "WheelItemDataType_Generic"
-- "WheelItemDataType_Section"
-- "WheelItemDataType_Song"
-- "WheelItemDataType_Roulette"
-- "WheelItemDataType_Random"
-- "WheelItemDataType_Portal"
-- "WheelItemDataType_Course"
-- "WheelItemDataType_Sort"
-- "WheelItemDataType_Custom"
-- @classmod WheelItemDataType

0 comments on commit c494afd

Please sign in to comment.