andreas/DSTEngine
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

fix doc comment

Browse Source
This commit is contained in:
Andreas Schaafsma 2025-03-15 01:25:08 +01:00
parent 9ade50e55f
commit 6420554df2
1 changed files with 14 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
hGameTest/src/engine/ConVar.hx
View File

@ -14,19 +14,20 @@ class ConVar{
static var CVarMap:Map<String, CVar> = []; static var CVarMap:Map<String, CVar> = [];
static var CCmdMap:Map<String, CCmd> = []; static var CCmdMap:Map<String, CCmd> = [];
/**
* Registers a new CVar /** Registers a new CVar
* @param _name The name of the CVar. This is the way it is called in the console or referred to in code. @param _name The name of the CVar. This is the way it is called in the console or referred to in code.
* @param _type CVar type as defined in the CVarType enum. @param _type CVar type as defined in the CVarType enum.
* @param _value The default value for this CVar. This needs to be in line with its CVarType. @param _value The default value for this CVar. This needs to be in line with its CVarType.
* @param _flags CVar flags as defined in the CVarFlags enum. @param _flags CVar flags as defined in the CVarFlags enum.
* @param _helpString Help string that gets printed out in console when no value is specified. @param _helpString Help string that gets printed out in console when no value is specified.
* @param _callback The function that gets called when the CVar is set. Calls empty Void when left undefined. @param _callback The function that gets called when the CVar is set. Calls empty Void when left undefined.
* @param _callOnCreate Whether the callback function gets called or not after registering. @param _callOnCreate Whether the callback function gets called or not after registering.
* @param _bMin Specifies if the CVar has a minimum numeric value. @param _bMin Specifies if the CVar has a minimum numeric value.
* @param _fMin Specifies the minimum numeric value. @param _fMin Specifies the minimum numeric value.
* @param _fMax Specifies the maximum numeric value. @param _fMax Specifies the maximum numeric value.
* @param _bMax Specifies if the CVar has a maximum numeric value. @param _bMax Specifies if the CVar has a maximum numeric value.
@return The registered CVar object.
*/ */
public static inline function registerCVar(_name:String, _type:CVarType, _value:Dynamic, ?_flags:CVarFlag, ?_helpString:String = "", ?_callback:Void->Void, ?_callOnCreate:Bool=false, _bMin:Bool=false, _fMin:Float=0, _fMax:Float=0, _bMax:Bool = false):CVar public static inline function registerCVar(_name:String, _type:CVarType, _value:Dynamic, ?_flags:CVarFlag, ?_helpString:String = "", ?_callback:Void->Void, ?_callOnCreate:Bool=false, _bMin:Bool=false, _fMin:Float=0, _fMax:Float=0, _bMax:Bool = false):CVar
{ {