Skip to content

Commit

Permalink
generously explain that some actors inherit others
Browse files Browse the repository at this point in the history
  • Loading branch information
poco0317 committed Aug 5, 2024
1 parent 0c69535 commit f1c5398
Show file tree
Hide file tree
Showing 73 changed files with 208 additions and 2 deletions.
2 changes: 2 additions & 0 deletions Themes/_fallback/docs/Actors/Actor.luadoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
--- Basic Actor class
--
-- This class inherits no methods from superclasses.
-- @classmod Actor

--[[--
Expand Down
3 changes: 3 additions & 0 deletions Themes/_fallback/docs/Actors/ActorFrame.luadoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
--- Actor container/composite
--
-- This class inherits all methods from these classes:
-- @{Actor}
-- @classmod ActorFrame


Expand Down
6 changes: 5 additions & 1 deletion Themes/_fallback/docs/Actors/ActorFrameTexture.luadoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
--- ActorFrameTexture (Inherits ActorFrame)
--- ActorFrameTexture
--
-- This class inherits all methods from these classes:
-- @{ActorFrame}
-- @{Actor}
-- @classmod ActorFrameTexture

--[[--
Expand Down
5 changes: 4 additions & 1 deletion Themes/_fallback/docs/Actors/ActorMultiVertex.luadoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
--- ActorMultiVertex (Inherits `Actor`)
--- ActorMultiVertex
--
-- This class inherits all methods from these classes:
-- @{Actor}
-- @classmod ActorMultiVertex

--[[--
Expand Down
3 changes: 3 additions & 0 deletions Themes/_fallback/docs/Actors/ActorProxy.luadoc
Original file line number Diff line number Diff line change
@@ -1,2 +1,5 @@
--- ActorProxy class
--
-- This class inherits all methods from these classes:
-- @{Actor}
-- @classmod ActorProxy
3 changes: 3 additions & 0 deletions Themes/_fallback/docs/Actors/ActorSound.luadoc
Original file line number Diff line number Diff line change
@@ -1,2 +1,5 @@
--- ActorSound class
--
-- This class inherits all methods from these classes:
-- @{Actor}
-- @classmod ActorSound
4 changes: 4 additions & 0 deletions Themes/_fallback/docs/Actors/BPMDisplay.luadoc
Original file line number Diff line number Diff line change
@@ -1,2 +1,6 @@
--- BPM Display class
--
-- This class inherits all methods from these classes:
-- @{BitmapText}
-- @{Actor}
-- @classmod BPMDisplay
3 changes: 3 additions & 0 deletions Themes/_fallback/docs/Actors/BitmapText.luadoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
--- Font actor
--
-- This class inherits all methods from these classes:
-- @{Actor}
-- @classmod BitmapText


Expand Down
4 changes: 4 additions & 0 deletions Themes/_fallback/docs/Actors/ColorBitmapText.luadoc
Original file line number Diff line number Diff line change
@@ -1,2 +1,6 @@
--- Colored BitmapText class
--
-- This class inherits all methods from these classes:
-- @{BitmapText}
-- @{Actor}
-- @classmod ColorBitmapText
4 changes: 4 additions & 0 deletions Themes/_fallback/docs/Actors/ComboGraph.luadoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@
-- 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.
--
-- This class inherits all methods from these classes:
-- @{ActorFrame}
-- @{Actor}
-- @classmod ComboGraph


Expand Down
4 changes: 4 additions & 0 deletions Themes/_fallback/docs/Actors/ControllerStateDisplay.luadoc
Original file line number Diff line number Diff line change
@@ -1,2 +1,6 @@
--- Controller information display class
--
-- This class inherits all methods from these classes:
-- @{ActorFrame}
-- @{Actor}
-- @classmod ControllerStateDisplay
4 changes: 4 additions & 0 deletions Themes/_fallback/docs/Actors/GraphDisplay.luadoc
Original file line number Diff line number Diff line change
@@ -1,2 +1,6 @@
--- Life graph display class
--
-- This class inherits all methods from these classes:
-- @{ActorFrame}
-- @{Actor}
-- @classmod GraphDisplay
4 changes: 4 additions & 0 deletions Themes/_fallback/docs/Actors/HoldJudgment.luadoc
Original file line number Diff line number Diff line change
@@ -1,2 +1,6 @@
--- Hold Judgment class
--
-- This class inherits all methods from these classes:
-- @{ActorFrame}
-- @{Actor}
-- @classmod HoldJudgment
4 changes: 4 additions & 0 deletions Themes/_fallback/docs/Actors/LifeMeter.luadoc
Original file line number Diff line number Diff line change
@@ -1,2 +1,6 @@
--- Life meter bar class
--
-- This class inherits all methods from these classes:
-- @{ActorFrame}
-- @{Actor}
-- @classmod LifeMeter
4 changes: 4 additions & 0 deletions Themes/_fallback/docs/Actors/MenuTimer.luadoc
Original file line number Diff line number Diff line change
@@ -1,2 +1,6 @@
--- Menu Timer class
--
-- This class inherits all methods from these classes:
-- @{ActorFrame}
-- @{Actor}
-- @classmod MenuTimer
4 changes: 4 additions & 0 deletions Themes/_fallback/docs/Actors/MeterDisplay.luadoc
Original file line number Diff line number Diff line change
@@ -1,2 +1,6 @@
--- MeterDisplay class for difficulty display
--
-- This class inherits all methods from these classes:
-- @{ActorFrame}
-- @{Actor}
-- @classmod MeterDisplay
4 changes: 4 additions & 0 deletions Themes/_fallback/docs/Actors/ModIconRow.luadoc
Original file line number Diff line number Diff line change
@@ -1,2 +1,6 @@
--- Mod Icon Row class
--
-- This class inherits all methods from these classes:
-- @{ActorFrame}
-- @{Actor}
-- @classmod ModIconRow
3 changes: 3 additions & 0 deletions Themes/_fallback/docs/Actors/Model.luadoc
Original file line number Diff line number Diff line change
@@ -1,2 +1,5 @@
--- Model class
--
-- This class inherits all methods from these classes:
-- @{Actor}
-- @classmod Model
5 changes: 5 additions & 0 deletions Themes/_fallback/docs/Actors/MusicWheel.luadoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,11 @@
-- 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 all methods from these classes:
-- @{WheelBase}
-- @{ActorFrame}
-- @{Actor}
-- @classmod MusicWheel

--- Change the @{SortOrder} for the MusicWheel. This is the equivalent of pressing UpDown UpDown then making a choice.
Expand Down
3 changes: 3 additions & 0 deletions Themes/_fallback/docs/Actors/NoteColumnRenderer.luadoc
Original file line number Diff line number Diff line change
@@ -1,2 +1,5 @@
--- Notefield Column Renderer class
--
-- This class inherits all methods from these classes:
-- @{Actor}
-- @classmod NoteColumnRenderer
4 changes: 4 additions & 0 deletions Themes/_fallback/docs/Actors/NoteField.luadoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@
--
-- 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 inherits all methods from these classes:
-- @{ActorFrame}
-- @{Actor}
-- @classmod NoteField


Expand Down
5 changes: 5 additions & 0 deletions Themes/_fallback/docs/Actors/NoteFieldPreview.luadoc
Original file line number Diff line number Diff line change
@@ -1,2 +1,7 @@
--- Preview NoteField class
--
-- This class inherits all methods from these classes:
-- @{NoteField}
-- @{ActorFrame}
-- @{Actor}
-- @classmod NoteFieldPreview
4 changes: 4 additions & 0 deletions Themes/_fallback/docs/Actors/OptionRow.luadoc
Original file line number Diff line number Diff line change
@@ -1,2 +1,6 @@
--- Option Row class
--
-- This class inherits all methods from these classes:
-- @{ActorFrame}
-- @{Actor}
-- @classmod OptionRow
4 changes: 4 additions & 0 deletions Themes/_fallback/docs/Actors/Player.luadoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@
-- 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 class inherits all methods from these classes:
-- @{ActorFrame}
-- @{Actor}
-- @classmod Player

--- Set the Lifebar to a new given value.
Expand Down
4 changes: 4 additions & 0 deletions Themes/_fallback/docs/Actors/RollingNumbers.luadoc
Original file line number Diff line number Diff line change
@@ -1,2 +1,6 @@
--- Rolling number display class
--
-- This class inherits all methods from these classes:
-- @{BitmapText}
-- @{Actor}
-- @classmod RollingNumbers
5 changes: 5 additions & 0 deletions Themes/_fallback/docs/Actors/RoomWheel.luadoc
Original file line number Diff line number Diff line change
@@ -1,2 +1,7 @@
--- Multiplayer room musicwheel class
--
-- This class inherits all methods from these classes:
-- @{WheelBase}
-- @{ActorFrame}
-- @{Actor}
-- @classmod RoomWheel
3 changes: 3 additions & 0 deletions Themes/_fallback/docs/Actors/Sprite.luadoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
--- Sprite
--
-- This class inherits all methods from these classes:
-- @{Actor}
-- @classmod Sprite

--[[-- Returns the length of the animation in seconds.
Expand Down
4 changes: 4 additions & 0 deletions Themes/_fallback/docs/Actors/StepsDisplay.luadoc
Original file line number Diff line number Diff line change
@@ -1,2 +1,6 @@
--- Difficulty display class
--
-- This class inherits all methods from these classes:
-- @{ActorFrame}
-- @{Actor}
-- @classmod StepsDisplay
4 changes: 4 additions & 0 deletions Themes/_fallback/docs/Actors/StepsDisplayList.luadoc
Original file line number Diff line number Diff line change
@@ -1,2 +1,6 @@
--- Difficulty display list class
--
-- This class inherits all methods from these classes:
-- @{ActorFrame}
-- @{Actor}
-- @classmod StepsDisplayList
4 changes: 4 additions & 0 deletions Themes/_fallback/docs/Actors/TextBanner.luadoc
Original file line number Diff line number Diff line change
@@ -1,2 +1,6 @@
--- Song info text display
--
-- This class inherits all methods from these classes:
-- @{ActorFrame}
-- @{Actor}
-- @classmod TextBanner
4 changes: 4 additions & 0 deletions Themes/_fallback/docs/Actors/WheelBase.luadoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@
--
-- 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 class inherits all methods from these classes:
-- @{ActorFrame}
-- @{Actor}
-- @classmod WheelBase

--- Move the wheel a given amount of choices in some direction.
Expand Down
4 changes: 4 additions & 0 deletions Themes/_fallback/docs/Actors/WheelItemBase.luadoc
Original file line number Diff line number Diff line change
@@ -1,2 +1,6 @@
--- Selection Wheel item base class
--
-- This class inherits all methods from these classes:
-- @{ActorFrame}
-- @{Actor}
-- @classmod WheelItemBase
2 changes: 2 additions & 0 deletions Themes/_fallback/docs/ModelClasses/Chart.luadoc
Original file line number Diff line number Diff line change
@@ -1,2 +1,4 @@
--- Chart class for charts within Playlists
--
-- -- This class inherits no methods from superclasses.
-- @classmod Chart
2 changes: 2 additions & 0 deletions Themes/_fallback/docs/ModelClasses/ChartRequest.luadoc
Original file line number Diff line number Diff line change
@@ -1,2 +1,4 @@
--- ChartRequest class for multiplayer chart requests
--
-- This class inherits no methods from superclasses.
-- @classmod ChartRequest
2 changes: 2 additions & 0 deletions Themes/_fallback/docs/ModelClasses/CubicSplineN.luadoc
Original file line number Diff line number Diff line change
@@ -1,2 +1,4 @@
--- Cubic Spline class
--
-- This class inherits no methods from superclasses.
-- @classmod CubicSplineN
2 changes: 2 additions & 0 deletions Themes/_fallback/docs/ModelClasses/DisplayMode.luadoc
Original file line number Diff line number Diff line change
@@ -1,2 +1,4 @@
--- Display Mode class
--
-- This class inherits no methods from superclasses.
-- @classmod DisplayMode
2 changes: 2 additions & 0 deletions Themes/_fallback/docs/ModelClasses/DisplaySpec.luadoc
Original file line number Diff line number Diff line change
@@ -1,2 +1,4 @@
--- Display Specifications class
--
-- This class inherits no methods from superclasses.
-- @classmod DisplaySpec
2 changes: 2 additions & 0 deletions Themes/_fallback/docs/ModelClasses/Download.luadoc
Original file line number Diff line number Diff line change
@@ -1,2 +1,4 @@
--- Representation of a downloading pack
--
-- This class inherits no methods from superclasses.
-- @classmod Download
2 changes: 2 additions & 0 deletions Themes/_fallback/docs/ModelClasses/DownloadablePack.luadoc
Original file line number Diff line number Diff line change
@@ -1,2 +1,4 @@
--- Downloadable pack class
--
-- This class inherits no methods from superclasses.
-- @classmod DownloadablePack
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
--- Downloadable Pack Pagination class
--
-- This class inherits no methods from superclasses.
-- @classmod DownloadablePackPagination
2 changes: 2 additions & 0 deletions Themes/_fallback/docs/ModelClasses/Game.luadoc
Original file line number Diff line number Diff line change
@@ -1,2 +1,4 @@
--- Game class
--
-- This class inherits no methods from superclasses.
-- @classmod Game
2 changes: 2 additions & 0 deletions Themes/_fallback/docs/ModelClasses/GameCommand.luadoc
Original file line number Diff line number Diff line change
@@ -1,2 +1,4 @@
--- GameCommand class
--
-- This class inherits no methods from superclasses.
-- @classmod GameCommand
2 changes: 2 additions & 0 deletions Themes/_fallback/docs/ModelClasses/HighScore.luadoc
Original file line number Diff line number Diff line change
@@ -1,2 +1,4 @@
--- HighScore class
--
-- This class inherits no methods from superclasses.
-- @classmod HighScore
2 changes: 2 additions & 0 deletions Themes/_fallback/docs/ModelClasses/HoldNoteResult.luadoc
Original file line number Diff line number Diff line change
@@ -1,2 +1,4 @@
--- HoldNoteResult info class
--
-- This class inherits no methods from superclasses.
-- @classmod HoldNoteResult
2 changes: 2 additions & 0 deletions Themes/_fallback/docs/ModelClasses/InputDataEvent.luadoc
Original file line number Diff line number Diff line change
@@ -1,2 +1,4 @@
--- InputDataEvent replay info class
--
-- This class inherits no methods from superclasses.
-- @classmod InputDataEvent
2 changes: 2 additions & 0 deletions Themes/_fallback/docs/ModelClasses/NCSplineHandler.luadoc
Original file line number Diff line number Diff line change
@@ -1,2 +1,4 @@
--- Notefield Column Spline Handler class
--
-- This class inherits no methods from superclasses.
-- @classmod NCSplineHandler
2 changes: 2 additions & 0 deletions Themes/_fallback/docs/ModelClasses/PlayerInfo.luadoc
Original file line number Diff line number Diff line change
@@ -1,2 +1,4 @@
--- Player stats class
--
-- This class inherits no methods from superclasses.
-- @classmod PlayerInfo
2 changes: 2 additions & 0 deletions Themes/_fallback/docs/ModelClasses/PlayerOptions.luadoc
Original file line number Diff line number Diff line change
@@ -1,2 +1,4 @@
--- Player mods class
--
-- This class inherits no methods from superclasses.
-- @classmod PlayerOptions
2 changes: 2 additions & 0 deletions Themes/_fallback/docs/ModelClasses/PlayerStageStats.luadoc
Original file line number Diff line number Diff line change
@@ -1,2 +1,4 @@
--- Player stats for current song
--
-- This class inherits no methods from superclasses.
-- @classmod PlayerStageStats
2 changes: 2 additions & 0 deletions Themes/_fallback/docs/ModelClasses/PlayerState.luadoc
Original file line number Diff line number Diff line change
@@ -1,2 +1,4 @@
--- Player game state class
--
-- This class inherits no methods from superclasses.
-- @classmod PlayerState
2 changes: 2 additions & 0 deletions Themes/_fallback/docs/ModelClasses/Playlist.luadoc
Original file line number Diff line number Diff line change
@@ -1,2 +1,4 @@
--- Playlist of Charts
--
-- This class inherits no methods from superclasses.
-- @classmod Playlist
2 changes: 2 additions & 0 deletions Themes/_fallback/docs/ModelClasses/Profile.luadoc
Original file line number Diff line number Diff line change
@@ -1,2 +1,4 @@
--- User profile class
--
-- This class inherits no methods from superclasses.
-- @classmod Profile
2 changes: 2 additions & 0 deletions Themes/_fallback/docs/ModelClasses/RadarValues.luadoc
Original file line number Diff line number Diff line change
@@ -1,2 +1,4 @@
--- Radar Value collection class
--
-- This class inherits no methods from superclasses.
-- @classmod RadarValues
Loading

0 comments on commit f1c5398

Please sign in to comment.