Project OutFox Wiki
Project OutFox home View the OutFox Wiki source on GitHub Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto mode Back to homepage

StepsDisplay

Displays the data for a given chart. Can show difficulty number, description, credit, if it’s autogen and steps type. Currently, all setings are done through metrics.

Def.StepsDisplay{}

Attributes

There are no special atributes for this actor class. It inherits the atributes from ActorFrame. All special actions are performed with its functions.

Metrics Loading

When using the Load command, the following metrics are read to generate the StepsDisplay.

NameTypeAction
NumTicksnumberAmount of ticks to show all the time.
MaxTicksnumberThe max ammount of ticks to draw.
ShowTicksboolEnables the ticks. These are graphics that indicate the number of difficulty in individual blocks.
ShowMeterboolEnables the meter number.
ShowDescriptionboolEnables the chart description (if available).
ShowCreditboolEnables the chart credit for the steps (if available).
ShowAutogenboolEnables an icon to indicate this chart has been auto-generated.
ShowStepsTypeboolEnables the Steps type to the StepsDisplay.
ZeroMeterStringstringThe string to show when the value is 0.
MeterFormatStringstringThe string to format the value for the difficulty meter.
The display frame, Autogen and StepsType are AutoActors; while Ticks, Meter, Description and Credit are BitmapText. All of these actors contain their own On, Load and Set commands.
[StepsDisplay]
FrameX=0
FrameY=0
FrameOnCommand=
FrameLoadCommand=%function(self,param) local bFlip = param.PlayerState and param.PlayerState:GetPlayerNumber() ~= PLAYER_1; self:zoomx(bFlip and -1 or 1); end
FrameSetCommand=%function(self,param) if param.CustomDifficulty and param.CustomDifficulty ~= "" then self:diffuse(CustomDifficultyToColor(param.CustomDifficulty)) end end
NumTicks=10
MaxTicks=14
TicksX=0
TicksY=0
TicksOnCommand=shadowlength,0;
TicksSetCommand=%function(self,param) if param.CustomDifficulty and param.CustomDifficulty ~= "" then  self:diffuse(CustomDifficultyToColor(param.CustomDifficulty)) if param.Meter > 9 then self:glowshift() else self:stopeffect() end end end
ShowTicks=false
ShowMeter=true
MeterFormatString="%i"
ZeroMeterString="?"
MeterX=30
MeterY=0
MeterOnCommand=shadowlength,0
MeterSetCommand=%function(self,param) if param.CustomDifficulty and param.CustomDifficulty ~= "" then self:diffuse(CustomDifficultyToLightColor(param.CustomDifficulty)); self:strokecolor(CustomDifficultyToDarkColor(param.CustomDifficulty)); end end
ShowDescription=true
DescriptionX=-10
DescriptionY=0
DescriptionOnCommand=shadowlength,0;uppercase,true;
DescriptionSetCommand=%function(self,param) if param.CustomDifficulty and param.CustomDifficulty ~= "" then self:diffuse(CustomDifficultyToLightColor(param.CustomDifficulty)); self:strokecolor(CustomDifficultyToDarkColor(param.CustomDifficulty)); end end
ShowCredit=false
CreditX=0
CreditY=0
CreditOnCommand=
CreditSetCommand=
ShowAutogen=true
AutogenX=40
AutogenY=0
AutogenOnCommand=
AutogenSetCommand=
ShowStepsType=false
StepsTypeX=0
StepsTypeY=0
StepsTypeOnCommand=

Updating information

When an update occurs to the StepsDisplay, the Set command is triggered, which contains a parameters table with the following information:

NameTypeDescription
CustomDifficultystringThe difficulty for this item. The reason why it’s called CustomDifficulty is due to it using the CustomDifficulty metrics table, which allows you to customize the name of the difficulties in the theme to your liking.
MeternumberThe chart meter for this item.
DisplayDescriptionstringThe description for the chart. Can be empty.
StepsStepsThe whole steps object. This object contains the information for Meter. Not available in Course Mode.
TrailTrailThe whole trail object. Not available in Regular Mode.
StepsTypeStepsTypeThe steps type that corresponds to this item.

Functions

Load

(string sMetricsGroup)

Loads the settings from the sMetricsGroup in the theme’s metrics.ini.

SetFromSteps

(Steps steps)

Load the data for the StepsDisplay with the steps provided.

SetFromTrail

(Trail trail)

Load the data for the StepsDisplay with the trail provided.

SetFromGameState

Loads the data for the StepsDisplay with the currently available data from GameState.