Add missing documentation in vscript

This commit is contained in:
samisalreadytaken 2021-10-01 16:20:24 +03:00
parent bf24798ee8
commit 690299b39c

View File

@ -11,58 +11,78 @@ function clamp(val,min,max)
{
if ( max < min )
return max;
else if( val < min )
if ( val < min )
return min;
else if( val > max )
if ( val > max )
return max;
else
return val;
}
function max(a,b) return a > b ? a : b
function max( a, b )
{
if ( a > b )
return a;
return b;
}
function min(a,b) return a < b ? a : b
function min( a, b )
{
if ( a < b )
return a;
return b;
}
function RemapVal( val, A, B, C, D )
{
if ( A == B )
return val >= B ? D : C;
{
if ( val >= B )
return D;
return C;
};
return C + (D - C) * (val - A) / (B - A);
}
function RemapValClamped( val, A, B, C, D )
{
if ( A == B )
return val >= B ? D : C;
{
if ( val >= B )
return D;
return C;
};
local cVal = (val - A) / (B - A);
cVal = (cVal < 0.0) ? 0.0 : (1.0 < cVal) ? 1.0 : cVal;
if ( cVal <= 0.0 )
return C;
if ( cVal >= 1.0 )
return D;
return C + (D - C) * cVal;
}
function Approach( target, value, speed )
{
local delta = target - value
local delta = target - value;
if ( delta > speed )
value += speed
else if( delta < (-speed) )
value -= speed
else
value = target
return value
return value + speed;
if ( -speed > delta )
return value - speed;
return target;
}
function AngleDistance( next, cur )
{
local delta = next - cur
if ( delta < (-180.0) )
delta += 360.0
else if ( delta > 180.0 )
delta -= 360.0
return delta
if ( delta > 180.0 )
return delta - 360.0;
if ( -180.0 > delta )
return delta + 360.0;
return delta;
}
function FLerp( f1, f2, i1, i2, x )
@ -83,7 +103,7 @@ function SimpleSpline( f )
function printl( text )
{
return ::print(text + "\n");
return print(text + "\n");
}
class CSimpleCallChainer
@ -481,6 +501,8 @@ else
}
}
if (developer)
{
// Vector documentation
__Documentation.RegisterClassHelp( "Vector", "", "Basic 3-float Vector class." );
__Documentation.RegisterHelp( "Vector::Length", "float Vector::Length()", "Return the vector's length." );
@ -500,4 +522,15 @@ __Documentation.RegisterMemberHelp( "Vector.x", "float Vector.x", "The vector's
__Documentation.RegisterMemberHelp( "Vector.y", "float Vector.y", "The vector's Y coordinate on the cartesian Y axis." );
__Documentation.RegisterMemberHelp( "Vector.z", "float Vector.z", "The vector's Z coordinate on the cartesian Z axis." );
__Documentation.RegisterHelp( "clamp", "float clamp(float, float, float)", "" );
__Documentation.RegisterHelp( "max", "float max(float, float)", "" );
__Documentation.RegisterHelp( "min", "float min(float, float)", "" );
__Documentation.RegisterHelp( "RemapVal", "float RemapVal(float, float, float, float, float)", "" );
__Documentation.RegisterHelp( "RemapValClamped", "float RemapValClamped(float, float, float, float, float)", "" );
__Documentation.RegisterHelp( "Approach", "float Approach(float, float, float)", "" );
__Documentation.RegisterHelp( "AngleDistance", "float AngleDistance(float, float)", "" );
__Documentation.RegisterHelp( "FLerp", "float FLerp(float, float, float, float, float)", "" );
__Documentation.RegisterHelp( "Lerp", "float Lerp(float, float, float)", "" );
__Documentation.RegisterHelp( "SimpleSpline", "float SimpleSpline(float)", "" );
}
)vscript";