Skip to content

Latest commit

 

History

History
86 lines (81 loc) · 8.75 KB

kp.Utils.orig.md

File metadata and controls

86 lines (81 loc) · 8.75 KB

Utils

Version column description:
"-" Means this util was added from the start.
"5678" Means this util was introduced in revision 5678.
"-5678" Means this util was removed in revision 5678.


Ver
sion		 Utility function
description		 Parameters
and types		 Returns
5422 AbsI
Returns absolute value of specified integer		 aValue: Integer; Integer
5422 AbsS
Returns absolute value of specified single number		 aValue: Single; Single
5422 ArrayElementCount
Checks how many times specified string comes in requested array		 aElement: String;
aArray: array of String;		 Integer
5422 ArrayElementCountI
Checks how many times specified integer comes in requested array		 aElement: Integer;
aArray: array of Integer;		 Integer
5422 ArrayElementCountI
Checks how many times specified boolean comes in requested array		 aElement: Integer;
aArray: array of Integer;		 Integer
5422 ArrayElementCountS
Checks how many times specified single comes in requested array		 aElement: Single;
aArray: array of Single;		 Integer
5422 ArrayHasElement
Checks whether requested array has specified string		 aElement: String;
aArray: array of String;		 Boolean
5422 ArrayHasElementI
Checks whether requested array has specified integer		 aElement: Integer;
aArray: array of Integer;		 Boolean
5422 ArrayHasElementI
Checks whether requested array has specified boolean		 aElement: Integer;
aArray: array of Integer;		 Boolean
5422 ArrayHasElementS
Checks whether requested array has specified single number		 aElement: Single;
aArray: array of Single;		 Boolean
5422 EnsureRangeI
Returns the closest to aValue integer that is in interval [aMin..aMax]		 aValue: Integer;
aMin: Integer;
aMax: Integer;		 Integer
5422 EnsureRangeS
Returns the closest to aValue single number that is in interval [aMin..aMax]		 aValue: Single;
aMin: Single;
aMax: Single;		 Single
5422 Format
Wrapper for pascal Format function
Formats aFormat string with specified aArgs array of arguments		 aFormat: String;
aArgs: array of const;		 string
5422 HexToInt
Converts hex string into a number		 aHexString: String; //HexString should be in form "1234AB", without $ or 0x prefix Integer
5422 IfThen
Checks condition aBool and returns aTrue/aFalse string depending on check result		 aBool: Boolean;
aTrue: String;
aFalse: String;		 string
5422 IfThenI
Checks condition aBool and returns aTrue/aFalse integer depending on check result		 aBool: Boolean;
aTrue: Integer;
aFalse: Integer;		 Integer
5422 IfThenS
Checks condition aBool and returns aTrue/aFalse single number depending on check result		 aBool: Boolean;
aTrue: Single;
aFalse: Single;		 Single
5422 InAreaI
2D variant of InRange, can be used for unit locs checks		 aX: Integer;
aY: Integer;
aXMin: Integer;
aYMin: Integer;
aXMax: Integer;
aYMax: Integer;		 Boolean
5422 InAreaS
2D variant of InRange		 aX: Single;
aY: Single;
aXMin: Single;
aYMin: Single;
aXMax: Single;
aYMax: Single;		 Boolean
5422 InRangeI
Checks whether specified aValue is in interval [aMin..aMax]		 aValue: Integer;
aMin: Integer;
aMax: Integer;		 Boolean
5422 InRangeS
Checks whether specified aValue is in interval [aMin..aMax]		 aValue: Single;
aMin: Single;
aMax: Single;		 Boolean
5422 MaxI
Returns max number of two specified		 A: Integer;
B: Integer;		 Integer
5422 MaxInArrayI
Returns max number of array elements		 aArray: array of Integer; Integer
5422 MaxInArrayS
Returns max number of array elements		 aArray: array of Single; Single
5422 MaxS
Returns max number of two specified		 A: Single;
B: Single;		 Single
5422 MinI
Returns min number of two specified		 A: Integer;
B: Integer;		 Integer
5422 MinInArrayI
Returns min number of array elements		 aArray: array of Integer; Integer
5422 MinInArrayS
Returns min number of array elements		 aArray: array of Single; Single
5422 MinS
Returns min number of two specified		 A: Single;
B: Single;		 Single
5422 Power Base: Extended;
Exp: Extended; //xponentation, returns base "Base" raised to power "Exp". F.e. Power(3, 2) = 3^2 = 9		 Extended
6683 Random
Returns random float within 0..1		 Single
6683 RandomI
Returns random integer within 0..aMax-1		 aMax: Integer; Integer
5422 Sqr
Returns A^2 = A*A		 A: Extended; Extended
5422 SumI
Returns sum of the elements of requested array		 aArray: array of Integer; Integer
5422 SumS
Returns sum of the elements of requested array		 aArray: array of Single; Single
5422 TimeToString
Converts game ticks count into string: HH:MM:SS
Can be used for scripted timers		 aTicks: Integer; string