Soldat Community Wiki - User contributions [en]

Exceptions

2014-05-31T23:01:10Z

Menturi: /* Enumerated values */

<table>

<tr style="font-weight: bold;">
<td>ExceptionType</td>
<td>ExceptionParam</td>
<td>ExceptionToString(ExceptionType, '$0')</td>
</tr>

<tr>
<td>12</td>
<td></td>
<td>Type Mismatch</td>
<td>Bar {Type: variant} := Foo {Type: refer to [[Data Types]], equivalent for all provided}</td>
</tr>

<tr>
<td>15</td>
<td></td>
<td>divide by Zero</td>
<td>0 / 0;</td>
</tr>

<tr>
<td>20</td>
<td>'$1' is not a valid integer value</td>
<td>Exception: $0</td>
<td>StrtoInt('$1');</td>
</tr>

<tr>
<td>20</td>
<td>Nil interface</td>
<td>Exception: $0</td>
<td>IDispatchInvoke(Foo {Type: variant or IDispatch}, false {or true}, 'Name', ['Par1', 'Par2']);</td>
</tr>

<tr>
<td>20</td>
<td>Invalid array</td>
<td>Exception: $0</td>
<td>Bar {Type: variant} := Foo {Type: array[0..10] of string};</td>
</tr>

<tr>
<td>20</td>
<td>Could not convert variant of type (Null) into type (Integer)</td>
<td>Exception: $0</td>
<td>Bar {Type: smallint} := Null;</td>
</tr>

<tr>
<td>20</td>
<td>Could not convert variant of type (Null) into type (Int64)</td>
<td>Exception: $0</td>
<td>Bar {Type: boolean or byte} := Null;</td>
</tr>

</table>

<code type="pascal">
procedure ThrowException(const ExType: integer; const ExParam: string);
var
Vnt: variant;
begin
Vnt := ExType;
RaiseException(Vnt, ExParam);
end;

procedure ActivateServer();
var
i: byte;
Bar: variant;
begin
for i := 1 to 25 do begin
WriteLn('<--- ' + InttoStr(i) + ' --->');
try
ThrowException(i, 'p' + InttoStr(i));
except
Bar := ExceptionType;
WriteLn('ExceptionType=' + Bar);
WriteLn('ExceptionParam=' + ExceptionParam);
WriteLn('ExceptionToString(...)=' + ExceptionToString(ExceptionType, '$0'));
end;
end;
end;
</code>

Results:
<--- 1 --->
ExceptionType=1
ExceptionParam=p1
ExceptionToString(...)=Cannot Import $0
<--- 2 --->
ExceptionType=2
ExceptionParam=p2
ExceptionToString(...)=Invalid Type
<--- 3 --->
ExceptionType=3
ExceptionParam=p3
ExceptionToString(...)=Internal error
<--- 4 --->
ExceptionType=4
ExceptionParam=p4
ExceptionToString(...)=Invalid Header
<--- 5 --->
ExceptionType=5
ExceptionParam=p5
ExceptionToString(...)=Invalid Opcode
<--- 6 --->
ExceptionType=6
ExceptionParam=p6
ExceptionToString(...)=Invalid Opcode Parameter
<--- 7 --->
ExceptionType=7
ExceptionParam=p7
ExceptionToString(...)=no Main Proc
<--- 8 --->
ExceptionType=8
ExceptionParam=p8
ExceptionToString(...)=Out of Global Vars range
<--- 9 --->
ExceptionType=9
ExceptionParam=p9
ExceptionToString(...)=Out of Proc Range
<--- 10 --->
ExceptionType=10
ExceptionParam=p10
ExceptionToString(...)=Out Of Range
<--- 11 --->
ExceptionType=11
ExceptionParam=p11
ExceptionToString(...)=Out Of Stack Range
<--- 12 --->
ExceptionType=12
ExceptionParam=p12
ExceptionToString(...)=Type Mismatch
<--- 13 --->
ExceptionType=13
ExceptionParam=p13
ExceptionToString(...)=Unexpected End Of File
<--- 14 --->
ExceptionType=14
ExceptionParam=p14
ExceptionToString(...)=Version error
<--- 15 --->
ExceptionType=15
ExceptionParam=p15
ExceptionToString(...)=divide by Zero
<--- 16 --->
ExceptionType=16
ExceptionParam=p16
ExceptionToString(...)=Math error
<--- 17 --->
ExceptionType=17
ExceptionParam=p17
ExceptionToString(...)=Could not call proc ($0)
<--- 18 --->
ExceptionType=18
ExceptionParam=p18
ExceptionToString(...)=Out of Record Fields Range
<--- 19 --->
ExceptionType=19
ExceptionParam=p19
ExceptionToString(...)=Out Of Memory
<--- 20 --->
ExceptionType=20
ExceptionParam=p20
ExceptionToString(...)=Exception: $0
<--- 21 --->
ExceptionType=21
ExceptionParam=p21
ExceptionToString(...)=Null Pointer Exception
<--- 22 --->
ExceptionType=22
ExceptionParam=p22
ExceptionToString(...)=Null variant error
<--- 23 --->
ExceptionType=23
ExceptionParam=p23
ExceptionToString(...)=Interface not supported
<--- 24 --->
ExceptionType=24
ExceptionParam=p24
ExceptionToString(...)=$0
<--- 25 --->
ExceptionType=25
ExceptionParam=p25
ExceptionToString(...)=Unknown error
Same results for 26-255 as 25; 0 has no exception thrown

==Enumerated values==

http://www.be-precision.com/products/precision-builder/express/webhelp/en/topics/PSSyntax.htm

TIFException = (ErNoError, erCannotImport, erInvalidType, ErInternalError, erInvalidHeader, erInvalidOpcode, erInvalidOpcodeParameter, erNoMainProc, erOutOfGlobalVarsRange, erOutOfProcRange, ErOutOfRange, erOutOfStackRange, ErTypeMismatch, erUnexpectedEof, erVersionError, ErDivideByZero, ErMathError,erCouldNotCallProc, erOutofRecordRange, erOutOfMemory, erException, erNullPointerException, erNullVariantError, erInterfaceNotSupported, erCustomError)

TIFException appears to be an enumeration of the following, with specified numeric equivalents. These should all be defined (but only the first few were tested):

<ol start="0">
<li>ErNoError
<li>ErCannotImport
<li>ErInvalidType
<li>ErInternalError
<li>ErInvalidHeader
<li>ErInvalidOpcode
<li>ErInvalidOpcodeParameter
<li>ErNoMainProc
<li>ErOutOfGlobalVarsRange
<li>ErOutOfProcRange
<li>ErOutOfRange
<li>ErOutOfStackRange
<li>ErTypeMismatch
<li>ErUnexpectedEof
<li>ErVersionError
<li>ErDivideByZero
<li>ErMathError
<li>ErCouldNotCallProc
<li>ErOutofRecordRange
<li>ErOutOfMemory
<li>ErException
<li>ErNullPointerException
<li>ErNullVariantError
<li>ErInterfaceNotSupported
<li>ErCustomError
</ol>

Exceptions

2014-05-31T22:59:11Z

Menturi: /* Enumerated values */

<table>

<tr style="font-weight: bold;">
<td>ExceptionType</td>
<td>ExceptionParam</td>
<td>ExceptionToString(ExceptionType, '$0')</td>
</tr>

<tr>
<td>12</td>
<td></td>
<td>Type Mismatch</td>
<td>Bar {Type: variant} := Foo {Type: refer to [[Data Types]], equivalent for all provided}</td>
</tr>

<tr>
<td>15</td>
<td></td>
<td>divide by Zero</td>
<td>0 / 0;</td>
</tr>

<tr>
<td>20</td>
<td>'$1' is not a valid integer value</td>
<td>Exception: $0</td>
<td>StrtoInt('$1');</td>
</tr>

<tr>
<td>20</td>
<td>Nil interface</td>
<td>Exception: $0</td>
<td>IDispatchInvoke(Foo {Type: variant or IDispatch}, false {or true}, 'Name', ['Par1', 'Par2']);</td>
</tr>

<tr>
<td>20</td>
<td>Invalid array</td>
<td>Exception: $0</td>
<td>Bar {Type: variant} := Foo {Type: array[0..10] of string};</td>
</tr>

<tr>
<td>20</td>
<td>Could not convert variant of type (Null) into type (Integer)</td>
<td>Exception: $0</td>
<td>Bar {Type: smallint} := Null;</td>
</tr>

<tr>
<td>20</td>
<td>Could not convert variant of type (Null) into type (Int64)</td>
<td>Exception: $0</td>
<td>Bar {Type: boolean or byte} := Null;</td>
</tr>

</table>

<code type="pascal">
procedure ThrowException(const ExType: integer; const ExParam: string);
var
Vnt: variant;
begin
Vnt := ExType;
RaiseException(Vnt, ExParam);
end;

procedure ActivateServer();
var
i: byte;
Bar: variant;
begin
for i := 1 to 25 do begin
WriteLn('<--- ' + InttoStr(i) + ' --->');
try
ThrowException(i, 'p' + InttoStr(i));
except
Bar := ExceptionType;
WriteLn('ExceptionType=' + Bar);
WriteLn('ExceptionParam=' + ExceptionParam);
WriteLn('ExceptionToString(...)=' + ExceptionToString(ExceptionType, '$0'));
end;
end;
end;
</code>

Results:
<--- 1 --->
ExceptionType=1
ExceptionParam=p1
ExceptionToString(...)=Cannot Import $0
<--- 2 --->
ExceptionType=2
ExceptionParam=p2
ExceptionToString(...)=Invalid Type
<--- 3 --->
ExceptionType=3
ExceptionParam=p3
ExceptionToString(...)=Internal error
<--- 4 --->
ExceptionType=4
ExceptionParam=p4
ExceptionToString(...)=Invalid Header
<--- 5 --->
ExceptionType=5
ExceptionParam=p5
ExceptionToString(...)=Invalid Opcode
<--- 6 --->
ExceptionType=6
ExceptionParam=p6
ExceptionToString(...)=Invalid Opcode Parameter
<--- 7 --->
ExceptionType=7
ExceptionParam=p7
ExceptionToString(...)=no Main Proc
<--- 8 --->
ExceptionType=8
ExceptionParam=p8
ExceptionToString(...)=Out of Global Vars range
<--- 9 --->
ExceptionType=9
ExceptionParam=p9
ExceptionToString(...)=Out of Proc Range
<--- 10 --->
ExceptionType=10
ExceptionParam=p10
ExceptionToString(...)=Out Of Range
<--- 11 --->
ExceptionType=11
ExceptionParam=p11
ExceptionToString(...)=Out Of Stack Range
<--- 12 --->
ExceptionType=12
ExceptionParam=p12
ExceptionToString(...)=Type Mismatch
<--- 13 --->
ExceptionType=13
ExceptionParam=p13
ExceptionToString(...)=Unexpected End Of File
<--- 14 --->
ExceptionType=14
ExceptionParam=p14
ExceptionToString(...)=Version error
<--- 15 --->
ExceptionType=15
ExceptionParam=p15
ExceptionToString(...)=divide by Zero
<--- 16 --->
ExceptionType=16
ExceptionParam=p16
ExceptionToString(...)=Math error
<--- 17 --->
ExceptionType=17
ExceptionParam=p17
ExceptionToString(...)=Could not call proc ($0)
<--- 18 --->
ExceptionType=18
ExceptionParam=p18
ExceptionToString(...)=Out of Record Fields Range
<--- 19 --->
ExceptionType=19
ExceptionParam=p19
ExceptionToString(...)=Out Of Memory
<--- 20 --->
ExceptionType=20
ExceptionParam=p20
ExceptionToString(...)=Exception: $0
<--- 21 --->
ExceptionType=21
ExceptionParam=p21
ExceptionToString(...)=Null Pointer Exception
<--- 22 --->
ExceptionType=22
ExceptionParam=p22
ExceptionToString(...)=Null variant error
<--- 23 --->
ExceptionType=23
ExceptionParam=p23
ExceptionToString(...)=Interface not supported
<--- 24 --->
ExceptionType=24
ExceptionParam=p24
ExceptionToString(...)=$0
<--- 25 --->
ExceptionType=25
ExceptionParam=p25
ExceptionToString(...)=Unknown error
Same results for 26-255 as 25; 0 has no exception thrown

==Enumerated values==

http://www.be-precision.com/products/precision-builder/express/webhelp/en/topics/PSSyntax.htm

TIFException = (ErNoError, erCannotImport, erInvalidType, ErInternalError, erInvalidHeader, erInvalidOpcode, erInvalidOpcodeParameter, erNoMainProc, erOutOfGlobalVarsRange, erOutOfProcRange, ErOutOfRange, erOutOfStackRange, ErTypeMismatch, erUnexpectedEof, erVersionError, ErDivideByZero, ErMathError,erCouldNotCallProc, erOutofRecordRange, erOutOfMemory, erException, erNullPointerException, erNullVariantError, erInterfaceNotSupported, erCustomError)

TIFException appears to be an enumeration of the following, with specified numeric equivalents. These should all be defined (but only the first few were tested):

<ol start="0">
<li>ErNoError
<li>ErCannotImport
<li>ErInvalidType
<li>ErInt<li>ErnalError
<li>ErInvalidHeader
<li>ErInvalidOpcode
<li>ErInvalidOpcodeParameter
<li>ErNoMainProc
<li>ErOutOfGlobalVarsRange
<li>ErOutOfProcRange
<li>ErOutOfRange
<li>ErOutOfStackRange
<li>ErTypeMismatch
<li>ErUnexpectedEof
<li>ErVersionError
<li>ErDivideByZero
<li>ErMathError
<li>ErCouldNotCallProc
<li>ErOutofRecordRange
<li>ErOutOfMemory
<li>ErException
<li>ErNullPointerException
<li>ErNullVariantError
<li>ErInterfaceNotSupported
<li>ErCustomError
</ol>

Exceptions

2014-05-31T22:49:47Z

Menturi:

<table>

<tr style="font-weight: bold;">
<td>ExceptionType</td>
<td>ExceptionParam</td>
<td>ExceptionToString(ExceptionType, '$0')</td>
</tr>

<tr>
<td>12</td>
<td></td>
<td>Type Mismatch</td>
<td>Bar {Type: variant} := Foo {Type: refer to [[Data Types]], equivalent for all provided}</td>
</tr>

<tr>
<td>15</td>
<td></td>
<td>divide by Zero</td>
<td>0 / 0;</td>
</tr>

<tr>
<td>20</td>
<td>'$1' is not a valid integer value</td>
<td>Exception: $0</td>
<td>StrtoInt('$1');</td>
</tr>

<tr>
<td>20</td>
<td>Nil interface</td>
<td>Exception: $0</td>
<td>IDispatchInvoke(Foo {Type: variant or IDispatch}, false {or true}, 'Name', ['Par1', 'Par2']);</td>
</tr>

<tr>
<td>20</td>
<td>Invalid array</td>
<td>Exception: $0</td>
<td>Bar {Type: variant} := Foo {Type: array[0..10] of string};</td>
</tr>

<tr>
<td>20</td>
<td>Could not convert variant of type (Null) into type (Integer)</td>
<td>Exception: $0</td>
<td>Bar {Type: smallint} := Null;</td>
</tr>

<tr>
<td>20</td>
<td>Could not convert variant of type (Null) into type (Int64)</td>
<td>Exception: $0</td>
<td>Bar {Type: boolean or byte} := Null;</td>
</tr>

</table>

<code type="pascal">
procedure ThrowException(const ExType: integer; const ExParam: string);
var
Vnt: variant;
begin
Vnt := ExType;
RaiseException(Vnt, ExParam);
end;

procedure ActivateServer();
var
i: byte;
Bar: variant;
begin
for i := 1 to 25 do begin
WriteLn('<--- ' + InttoStr(i) + ' --->');
try
ThrowException(i, 'p' + InttoStr(i));
except
Bar := ExceptionType;
WriteLn('ExceptionType=' + Bar);
WriteLn('ExceptionParam=' + ExceptionParam);
WriteLn('ExceptionToString(...)=' + ExceptionToString(ExceptionType, '$0'));
end;
end;
end;
</code>

Results:
<--- 1 --->
ExceptionType=1
ExceptionParam=p1
ExceptionToString(...)=Cannot Import $0
<--- 2 --->
ExceptionType=2
ExceptionParam=p2
ExceptionToString(...)=Invalid Type
<--- 3 --->
ExceptionType=3
ExceptionParam=p3
ExceptionToString(...)=Internal error
<--- 4 --->
ExceptionType=4
ExceptionParam=p4
ExceptionToString(...)=Invalid Header
<--- 5 --->
ExceptionType=5
ExceptionParam=p5
ExceptionToString(...)=Invalid Opcode
<--- 6 --->
ExceptionType=6
ExceptionParam=p6
ExceptionToString(...)=Invalid Opcode Parameter
<--- 7 --->
ExceptionType=7
ExceptionParam=p7
ExceptionToString(...)=no Main Proc
<--- 8 --->
ExceptionType=8
ExceptionParam=p8
ExceptionToString(...)=Out of Global Vars range
<--- 9 --->
ExceptionType=9
ExceptionParam=p9
ExceptionToString(...)=Out of Proc Range
<--- 10 --->
ExceptionType=10
ExceptionParam=p10
ExceptionToString(...)=Out Of Range
<--- 11 --->
ExceptionType=11
ExceptionParam=p11
ExceptionToString(...)=Out Of Stack Range
<--- 12 --->
ExceptionType=12
ExceptionParam=p12
ExceptionToString(...)=Type Mismatch
<--- 13 --->
ExceptionType=13
ExceptionParam=p13
ExceptionToString(...)=Unexpected End Of File
<--- 14 --->
ExceptionType=14
ExceptionParam=p14
ExceptionToString(...)=Version error
<--- 15 --->
ExceptionType=15
ExceptionParam=p15
ExceptionToString(...)=divide by Zero
<--- 16 --->
ExceptionType=16
ExceptionParam=p16
ExceptionToString(...)=Math error
<--- 17 --->
ExceptionType=17
ExceptionParam=p17
ExceptionToString(...)=Could not call proc ($0)
<--- 18 --->
ExceptionType=18
ExceptionParam=p18
ExceptionToString(...)=Out of Record Fields Range
<--- 19 --->
ExceptionType=19
ExceptionParam=p19
ExceptionToString(...)=Out Of Memory
<--- 20 --->
ExceptionType=20
ExceptionParam=p20
ExceptionToString(...)=Exception: $0
<--- 21 --->
ExceptionType=21
ExceptionParam=p21
ExceptionToString(...)=Null Pointer Exception
<--- 22 --->
ExceptionType=22
ExceptionParam=p22
ExceptionToString(...)=Null variant error
<--- 23 --->
ExceptionType=23
ExceptionParam=p23
ExceptionToString(...)=Interface not supported
<--- 24 --->
ExceptionType=24
ExceptionParam=p24
ExceptionToString(...)=$0
<--- 25 --->
ExceptionType=25
ExceptionParam=p25
ExceptionToString(...)=Unknown error
Same results for 26-255 as 25; 0 has no exception thrown

==Enumerated values==

http://www.be-precision.com/products/precision-builder/express/webhelp/en/topics/PSSyntax.htm

TIFException = (ErNoError, erCannotImport, erInvalidType, ErInternalError, erInvalidHeader, erInvalidOpcode, erInvalidOpcodeParameter, erNoMainProc, erOutOfGlobalVarsRange, erOutOfProcRange, ErOutOfRange, erOutOfStackRange, ErTypeMismatch, erUnexpectedEof, erVersionError, ErDivideByZero, ErMathError,erCouldNotCallProc, erOutofRecordRange, erOutOfMemory, erException, erNullPointerException, erNullVariantError, erInterfaceNotSupported, erCustomError)

Only a couple of these were tested, but this seems to exist and match with the first few tests.

TFileStream

2014-05-27T20:01:12Z

Menturi: Added whitespace to function definitions.

==Inheritance==
*[[TStream]]
**[[TFileStream]]
**[[TStringStream]]

==Description==
A binary stream to read/write from/to file

user constructable: '''NO'''
user destructable: '''YES'''

==Members==
{| class="wikitable"
|-
! Member declaration !! Access mode !! Inherited
|-
| procedure [[TFileStream.Clear|Clear]]
|
| align="center" | no
|-
| procedure [[TFileStream.LoadFromStream|LoadFromStream]](Stream: TStream)
|
| align="center" | no
|-
| procedure [[TFileStream.LoadFromFile|LoadFromFile]](FileName: String)
|
| align="center" | no
|-
| procedure [[TFileStream.SaveToStream|SaveToStream]](Stream: TStream)
|
| align="center" | no
|-
| procedure [[TFileStream.SaveToFile|SaveToFile]](FileName: String)
|
| align="center" | no
|-
| procedure [[TFileStream.SetSize|SetSize]](NewSize: LongInt)
|
| align="center" | no
|-
| procedure [[Destructor|Free]]
|
| align="center" | yes
|-
| function [[TStream.Read|Read]](Buffer: String; Count: LongInt): LongInt
|
| align="center" | yes
|-
| function [[TStream.Write|Write]](Buffer: String;Count: LongInt): LongInt
|
| align="center" | yes
|-
| function [[TStream.Seek|Seek]](Offset: LongInt; Origin: Word): LongInt
|
| align="center" | yes
|-
| procedure [[TStream.ReadBuffer|ReadBuffer]](Buffer: String; Count: LongInt)
|
| align="center" | yes
|-
| procedure [[TStream.WriteBuffer|WriteBuffer]](Buffer: String; Count: LongInt)
|
| align="center" | yes
|-
| function [[TStream.CopyFrom|CopyFrom]](Source: TStream; Count: Int64): LongInt
|
| align="center" | yes
|-
| colspan="3" |
|-
| property [[TStream.Position|Position]]: Int64
| align="center" | RW
| align="center" | yes
|-
| property [[TStream.Size|Size]]: Int64
| align="center" | RW
| align="center" | yes
|}

[[Category:Classes]][[Category: TStream]]

TActivePlayer.BigText

2013-09-02T13:24:21Z

Menturi: Changed time units from milliseconds to ticks

'''''procedure BigText(Layer: Byte; Text: string; Delay: Integer; Color: Longint; Scale: Single; X, Y: Integer)'''''
Layer: in which layer the text will be shown
Text: message to be shown
Delay: time in ticks for the message to remain on screen
Color: text's color
Scale: size of the text
X: X position on the screen to display text (1-640)
Y: Y position on the screen to display text (1-480)
==Description==
Displays a big text in a player's screen, like the "You Killed <Player>" text or so on.<br>
Note that the Y axis grows downwards.

== Example ==
<syntaxhighlight lang="pascal">
Players[1].BigText(2,'Booyeah!',200,$FFFF00,0.20,20,300); //displays "Booyeah!" to player 1
</syntaxhighlight>

[[Category:TActivePlayer]]

ScriptCore3.Now

2013-08-25T23:45:27Z

Menturi: Bolded definition, removed extra space, removed line break

'''function Now: [[TDateTime]]'''
Result: Current Date + Time (encoded)

==Description==
This function will return [[TDateTime]] representing current date and time

==Example==
Below example allows players to see the server's local time by saying !time
<syntaxhighlight lang="pascal">
var
i: ShortInt;

procedure OnSpeak(P: TActivePlayer; Text: string);
begin
if lowercase(Text) = '!time' then
Players.WriteConsole('Current local time: '+FormatDateTime('ddddd t',Now()),$FFFFFF);
end;

begin
for i:=1 to 32 do
Players[i].OnSpeak := @OnSpeak;
end.
</syntaxhighlight>

[[Category:Functions]]

TFile.CheckAccess

2013-08-11T14:30:30Z

Menturi: /* Path syntax */ Translated word

'''''function CheckAccess(const FilePath: string): Boolean'''''
FilePath: a path to a file to check access for
Result: Whenever file is accessible from script's sandbox or not
==Description==
This function checks whenever file pointed by FilePath can be opened by script's File API.

==Path syntax==
Path to a file should be passed in unix-like syntax (slashes, not backslashes) where first character determinates where is the start point:

* ''/'': if path begins from slash (/), it's assumed to start from hard disk root ("root / folder on unix, Disk on which soldatserver is located on windows (i.e. C:\). Script must be configured with [[Config|Sandboxed]] level 0 in order to be able to access entire host's harddrive.
* ''~'': if path begins from tilde (~), it's assumed to start from script's data directory (soldatserver/scripts/yourscriptname/data/).
* Any else character is assumed to be part of the path and start point is set to soldatserver's directory, i.e. 'soldat.ini' points to soldatserver/soldat.ini. Script must be configured with [[Config|Sandboxed]] level 1 or 0 in order to be able to access anything above it's data directory.

== Example ==
<syntaxhighlight lang="pascal">
begin
if File.CheckAccess('soldat.ini') then
WriteLn('soldat ini seems to be accessible!')
else
WriteLn('access to soldat.ini denied.');
end;
</syntaxhighlight>
[[Category:TFile]]

TFile.Exists

2013-07-29T15:05:13Z

Menturi: /* Example */ Removed invalid semicolon

'''''function Exists(const Source: string): Boolean'''''
Source: a path to a file to check access for
Result: Whenever file exists or not
==Description==
This function checks whenever file pointed by Source exists on hard drive. If the path is out of script's sandbox, [[EAccessViolation]] exception is thrown.

== Example ==
<syntaxhighlight lang="pascal">
procedure OnPlayerCommand(Player: TActivePlayer; Text: string);
begin
// Assuming config Sandboxed=2 (default)
Delete(Text, 1, 1); // remove command's slash
try
if File.Exists('~/' + Text + '.ini') then
Player.WriteConsole('Yup, config for that map exists', $FFFFFFFF)
else
Player.WriteConsole('Sorry, this config for this map doesn''t exist', $FFFFFFFF);
except
Player.WriteConsole('Wrong path (you added ../ a few times, didn''t you?)', $FFFFFFFF);
end;
end;
</syntaxhighlight>
[[Category:TFile]]

TFile.CreateFileStreamFromFile

2013-07-29T15:02:04Z

Menturi: /* Description */ Removed duplicate sentence

'''''function CreateFileStreamFromFile(const Path: string): [[TFileStream]]'''''
Path: path to file that should be opened
Result: [[TFileStream]] object
==Description==
This function creates a [[TFileStream]] object that is attached file pointed by path parameter. Might throw [[EAccessDenied]] exception if path is inaccessible from script's sandbox or access is denied by operating system. The file will be created if it doesn't exist yet.
[[Category:TFile]]

User:Menturi

2013-07-29T14:55:24Z

Menturi: Created page. Link to my SF profile.

Hello. My name is Curt. Some nicknames I am know by are DorkeyDear, Curt`, and menturi. If you wish to contact me, feel free to message me on [http://forums.soldat.pl/index.php?action=profile;u=856 Soldat Forums], or head to QuakeNet on IRC at [http://webchat.quakenet.org/?channels=#soldat.sgas #soldat.sgas] or [http://webchat.quakenet.org/?channels=#soldat.devs #soldat.devs].

TGame.Restart

2013-07-29T14:45:44Z

Menturi: /* Description */ Added period to the end of the sentence.

'''''procedure Restart'''''

==Description==
Restarts current map.<br>

[[Category:TGame]]

TGame.LoadWeap

2013-07-29T14:42:52Z

Menturi: Fixed typo `ot`

'''''function LoadWeap(WeaponMod: string): Boolean'''''
WeaponMod: path to the weapon mod file
Result: if it worked or not

==Description==
Changes the weapon mod<br>

==Example==
<syntaxhighlight lang="pascal">
Game.LoadWep('sctfl.txt');
</syntaxhighlight>

[[Category:TGame]]

TGame.LoadCon

2013-07-29T14:41:33Z

Menturi: /* Description */ Clarity for not kicking players when unsuccessfully loaded configuration

'''''function LoadCon(ConfigFile: string): Boolean'''''
ConfigFile: path to config file
Result: if it worked or not
==Description==
Changes game configuration<br>
Returns true if configuration has been loaded, false otherwise<br>
Players are kicked when executed if configuration successfully loaded<br>
LoadCon is '''not available''' with [[LockedMode|Locked Mode]] ON (according to SoldatServer ReadMe.txt)

==Example==
<syntaxhighlight lang="pascal">
Game.LoadCon('Teammatch_Config.ini');
</syntaxhighlight>

[[Category:TGame]]

TGame

2013-07-29T14:37:19Z

Menturi: /* Members */ Removed duplicate entry `GameStyle`

==Inheritance==
*[[TGame]]

==Description==
Represents a game state and configuration.

'''This class is assigned to global variable "Game"'''

user constructable: '''NO'''
user destructable: '''NO'''

==Members==
{| class="wikitable"
|-
! Member declaration !! Access mode
|-
| procedure [[TGame.Shutdown|Shutdown]]
| align="center" |
|-
| procedure [[TGame.StartVoteKick|StartVoteKick]](ID: Byte; Reason: string)
| align="center" |
|-
| procedure [[TGame.StartVoteMap|StartVoteMap]](Name: string)
| align="center" |
|-
| procedure [[TGame.Restart|Restart]]
| align="center" |
|-
| function [[TGame.LoadWeap|LoadWeap]](WeaponMod: string): Boolean
| align="center" |
|-
| function [[TGame.LoadCon|LoadCon]](ConfigFile: string): Boolean
| align="center" |
|-
| function [[TGame.LoadList|LoadList]](MapsList: string): Boolean
| align="center" |
|-
| procedure [[TGame.LobbyRegister|LobbyRegister]]
| align="center" |
|-
| colspan="3" |
|-
| property [[TGame.GameStyle|GameStyle]]: Byte
| align="center" | RW
|-
| property [[TGame.MaxPlayers|MaxPlayers]]: Byte
| align="center" | RW
|-
| property [[TGame.NextMap|NextMap]]: string
| align="center" | R
|-
| property [[TGame.NumBots|NumBots]]: Byte
| align="center" | R
|-
| property [[TGame.NumPlayers|NumPlayers]]: Byte
| align="center" | R
|-
| property [[TGame.Spectators|Spectators]]: Byte
| align="center" | R
|-
| property [[TGame.ScoreLimit|ScoreLimit]]: Byte
| align="center" | RW
|-
| property [[TGame.ServerIP|ServerIP]]: string
| align="center" | R
|-
| property [[TGame.ServerName|ServerName]]: string
| align="center" | R
|-
| property [[TGame.ServerPort|ServerPort]]: Word
| align="center" | R
|-
| property [[TGame.ServerVersion|ServerVersion]]: string
| align="center" | R
|-
| property [[TGame.ServerInfo|ServerInfo]]: string
| align="center" | R
|-
| property [[TGame.Gravity|Gravity]]: Single
| align="center" | RW
|-
| property [[TGame.Paused|Paused]]: Boolean
| align="center" | RW
|-
| property [[TGame.RespawnTime|RespawnTime]]: LongInt
| align="center" | RW
|-
| property [[TGame.MinRespawnTime|MinRespawnTime]]: LongInt
| align="center" | RW
|-
| property [[TGame.MaxRespawnTime|MaxRespawnTime]]: LongInt
| align="center" | RW
|-
| property [[TGame.MaxGrenades|MaxGrenades]]: Byte
| align="center" | RW
|-
| property [[TGame.Bonus|Bonus]]: Byte
| align="center" | RW
|-
| property [[TGame.TimeLimit|TimeLimit]]: LongInt
| align="center" | RW
|-
| property [[TGame.TimeLeft|TimeLeft]]: LongInt
| align="center" | R
|-
| property [[TGame.FriendlyFire|FriendlyFire]]: Boolean
| align="center" | RW
|-
| property [[TGame.Password|Password]]: string
| align="center" | RW
|-
| property [[TGame.VotePercent|VotePercent]]: Single
| align="center" | RW
|-
| property [[TGame.Realistic|Realistic]]: Boolean
| align="center" | RW
|-
| property [[TGame.Survival|Survival]]: Boolean
| align="center" | RW
|-
| property [[TGame.Advance|Advance]]: Boolean
| align="center" | RW
|-
| property [[TGame.Balance|Balance]]: Boolean
| align="center" | RW
|-
| property [[TGame.TickThreshold|TickThreshold]]: LongInt
| align="center" | RW
|-
| property [[TGame.Teams|Teams]][ID: Byte]: [[TTeam]]
| align="center" | R
|-
| property [[TGame.OnClockTick|OnClockTick]]: [[TOnClockTickEvent]]
| align="center" | RW
|-
| property [[TGame.OnJoin|OnJoin]]: [[TOnJoinGameEvent]]
| align="center" | RW
|-
| property [[TGame.OnLeave|OnLeave]]: [[TOnLeaveGameEvent]]
| align="center" | RW
|-
| property [[TGame.OnRequest|OnRequest]]: [[TOnRequestEvent]]
| align="center" | RW
|}

[[Category:Classes]][[Category:TGame]]

TGame

2013-07-29T14:36:22Z

Menturi: /* Members */ Removed duplicate word `property`

==Inheritance==
*[[TGame]]

==Description==
Represents a game state and configuration.

'''This class is assigned to global variable "Game"'''

user constructable: '''NO'''
user destructable: '''NO'''

==Members==
{| class="wikitable"
|-
! Member declaration !! Access mode
|-
| procedure [[TGame.Shutdown|Shutdown]]
| align="center" |
|-
| procedure [[TGame.StartVoteKick|StartVoteKick]](ID: Byte; Reason: string)
| align="center" |
|-
| procedure [[TGame.StartVoteMap|StartVoteMap]](Name: string)
| align="center" |
|-
| procedure [[TGame.Restart|Restart]]
| align="center" |
|-
| function [[TGame.LoadWeap|LoadWeap]](WeaponMod: string): Boolean
| align="center" |
|-
| function [[TGame.LoadCon|LoadCon]](ConfigFile: string): Boolean
| align="center" |
|-
| function [[TGame.LoadList|LoadList]](MapsList: string): Boolean
| align="center" |
|-
| procedure [[TGame.LobbyRegister|LobbyRegister]]
| align="center" |
|-
| colspan="3" |
|-
| property [[TGame.GameStyle|GameStyle]]: Byte
| align="center" | RW
|-
| property [[TGame.GameStyle|GameStyle]]: Byte
| align="center" | RW
|-
| property [[TGame.MaxPlayers|MaxPlayers]]: Byte
| align="center" | RW
|-
| property [[TGame.NextMap|NextMap]]: string
| align="center" | R
|-
| property [[TGame.NumBots|NumBots]]: Byte
| align="center" | R
|-
| property [[TGame.NumPlayers|NumPlayers]]: Byte
| align="center" | R
|-
| property [[TGame.Spectators|Spectators]]: Byte
| align="center" | R
|-
| property [[TGame.ScoreLimit|ScoreLimit]]: Byte
| align="center" | RW
|-
| property [[TGame.ServerIP|ServerIP]]: string
| align="center" | R
|-
| property [[TGame.ServerName|ServerName]]: string
| align="center" | R
|-
| property [[TGame.ServerPort|ServerPort]]: Word
| align="center" | R
|-
| property [[TGame.ServerVersion|ServerVersion]]: string
| align="center" | R
|-
| property [[TGame.ServerInfo|ServerInfo]]: string
| align="center" | R
|-
| property [[TGame.Gravity|Gravity]]: Single
| align="center" | RW
|-
| property [[TGame.Paused|Paused]]: Boolean
| align="center" | RW
|-
| property [[TGame.RespawnTime|RespawnTime]]: LongInt
| align="center" | RW
|-
| property [[TGame.MinRespawnTime|MinRespawnTime]]: LongInt
| align="center" | RW
|-
| property [[TGame.MaxRespawnTime|MaxRespawnTime]]: LongInt
| align="center" | RW
|-
| property [[TGame.MaxGrenades|MaxGrenades]]: Byte
| align="center" | RW
|-
| property [[TGame.Bonus|Bonus]]: Byte
| align="center" | RW
|-
| property [[TGame.TimeLimit|TimeLimit]]: LongInt
| align="center" | RW
|-
| property [[TGame.TimeLeft|TimeLeft]]: LongInt
| align="center" | R
|-
| property [[TGame.FriendlyFire|FriendlyFire]]: Boolean
| align="center" | RW
|-
| property [[TGame.Password|Password]]: string
| align="center" | RW
|-
| property [[TGame.VotePercent|VotePercent]]: Single
| align="center" | RW
|-
| property [[TGame.Realistic|Realistic]]: Boolean
| align="center" | RW
|-
| property [[TGame.Survival|Survival]]: Boolean
| align="center" | RW
|-
| property [[TGame.Advance|Advance]]: Boolean
| align="center" | RW
|-
| property [[TGame.Balance|Balance]]: Boolean
| align="center" | RW
|-
| property [[TGame.TickThreshold|TickThreshold]]: LongInt
| align="center" | RW
|-
| property [[TGame.Teams|Teams]][ID: Byte]: [[TTeam]]
| align="center" | R
|-
| property [[TGame.OnClockTick|OnClockTick]]: [[TOnClockTickEvent]]
| align="center" | RW
|-
| property [[TGame.OnJoin|OnJoin]]: [[TOnJoinGameEvent]]
| align="center" | RW
|-
| property [[TGame.OnLeave|OnLeave]]: [[TOnLeaveGameEvent]]
| align="center" | RW
|-
| property [[TGame.OnRequest|OnRequest]]: [[TOnRequestEvent]]
| align="center" | RW
|}

[[Category:Classes]][[Category:TGame]]

TGame

2013-07-29T14:33:36Z

Menturi: /* Members */ Reformatted table to be consistent with other tables

==Inheritance==
*[[TGame]]

==Description==
Represents a game state and configuration.

'''This class is assigned to global variable "Game"'''

user constructable: '''NO'''
user destructable: '''NO'''

==Members==
{| class="wikitable"
|-
! Member declaration !! Access mode
|-
| procedure [[TGame.Shutdown|Shutdown]]
| align="center" |
|-
| procedure [[TGame.StartVoteKick|StartVoteKick]](ID: Byte; Reason: string)
| align="center" |
|-
| procedure [[TGame.StartVoteMap|StartVoteMap]](Name: string)
| align="center" |
|-
| procedure [[TGame.Restart|Restart]]
| align="center" |
|-
| function [[TGame.LoadWeap|LoadWeap]](WeaponMod: string): Boolean
| align="center" |
|-
| function [[TGame.LoadCon|LoadCon]](ConfigFile: string): Boolean
| align="center" |
|-
| function [[TGame.LoadList|LoadList]](MapsList: string): Boolean
| align="center" |
|-
| procedure [[TGame.LobbyRegister|LobbyRegister]]
| align="center" |
|-
| colspan="3" |
|-
| property [[TGame.GameStyle|GameStyle]]: Byte
| align="center" | RW
|-
| property [[TGame.GameStyle|GameStyle]]: Byte
| align="center" | RW
|-
| property [[TGame.MaxPlayers|MaxPlayers]]: Byte
| align="center" | RW
|-
| property [[TGame.NextMap|NextMap]]: string
| align="center" | R
|-
| property [[TGame.NumBots|NumBots]]: Byte
| align="center" | R
|-
| property [[TGame.NumPlayers|NumPlayers]]: Byte
| align="center" | R
|-
| property [[TGame.Spectators|Spectators]]: Byte
| align="center" | R
|-
| property [[TGame.ScoreLimit|ScoreLimit]]: Byte
| align="center" | RW
|-
| property [[TGame.ServerIP|ServerIP]]: string
| align="center" | R
|-
| property [[TGame.ServerName|ServerName]]: string
| align="center" | R
|-
| property [[TGame.ServerPort|ServerPort]]: Word
| align="center" | R
|-
| property [[TGame.ServerVersion|ServerVersion]]: string
| align="center" | R
|-
| property [[TGame.ServerInfo|ServerInfo]]: string
| align="center" | R
|-
| property [[TGame.Gravity|Gravity]]: Single
| align="center" | RW
|-
| property [[TGame.Paused|Paused]]: Boolean
| align="center" | RW
|-
| property [[TGame.RespawnTime|RespawnTime]]: LongInt
| align="center" | RW
|-
| property [[TGame.MinRespawnTime|MinRespawnTime]]: LongInt
| align="center" | RW
|-
| property [[TGame.MaxRespawnTime|MaxRespawnTime]]: LongInt
| align="center" | RW
|-
| property [[TGame.MaxGrenades|MaxGrenades]]: Byte
| align="center" | RW
|-
| property [[TGame.Bonus|Bonus]]: Byte
| align="center" | RW
|-
| property [[TGame.TimeLimit|TimeLimit]]: LongInt
| align="center" | RW
|-
| property [[TGame.TimeLeft|TimeLeft]]: LongInt
| align="center" | R
|-
| property [[TGame.FriendlyFire|FriendlyFire]]: Boolean
| align="center" | RW
|-
| property property [[TGame.Password|Password]]: string
| align="center" | RW
|-
| property [[TGame.VotePercent|VotePercent]]: Single
| align="center" | RW
|-
| property [[TGame.Realistic|Realistic]]: Boolean
| align="center" | RW
|-
| property [[TGame.Survival|Survival]]: Boolean
| align="center" | RW
|-
| property [[TGame.Advance|Advance]]: Boolean
| align="center" | RW
|-
| property [[TGame.Balance|Balance]]: Boolean
| align="center" | RW
|-
| property [[TGame.TickThreshold|TickThreshold]]: LongInt
| align="center" | RW
|-
| property [[TGame.Teams|Teams]][ID: Byte]: [[TTeam]]
| align="center" | R
|-
| property [[TGame.OnClockTick|OnClockTick]]: [[TOnClockTickEvent]]
| align="center" | RW
|-
| property [[TGame.OnJoin|OnJoin]]: [[TOnJoinGameEvent]]
| align="center" | RW
|-
| property [[TGame.OnLeave|OnLeave]]: [[TOnLeaveGameEvent]]
| align="center" | RW
|-
| property [[TGame.OnRequest|OnRequest]]: [[TOnRequestEvent]]
| align="center" | RW
|}

[[Category:Classes]][[Category:TGame]]

TMap

2013-07-29T14:14:49Z

Menturi: Removed garbage old content left behind from my previous edit.

==Inheritance==
*[[TMap]]

==Description==

Used to access information on player's field of vision, get a flag's pointer or creating new objects or spawnpoints on the map.

'''This class is assigned to global variable "Map"'''

==Members==

{| class="wikitable"
|-
! Member declaration !! Access mode
|-
| function [[TMap.RayCast|RayCast]](X1,Y1,X2,Y2:Single; Player,Flag,Bullet,CheckCollider:Boolean; Team:Byte):Boolean
| align="center" |
|-
| function [[TMap.RayCastVector|RayCastVector]](A,B:TVector; Player,Flag,Bullet,CheckCollider:Boolean; Team:Byte):Boolean
| align="center" |
|-
| function [[TMap.AddObject|AddObject]](Obj:[[TNewMapObject]]):[[TActiveMapObject]]
| align="center" |
|-
| function [[TMap.AddSpawnPoint|AddSpawnPoint]](Spawn:[[TNewSpawnPoint]]):[[TActiveSpawnPoint]]
| align="center" |
|-
| colspan="3" |
|-
| property [[TMap.Objects|Objects]][ID: Byte ]: [[TActiveMapObject]]
| align="center" | R
|-
| property [[TMap.Spawns|Spawns]][ID: Byte]: [[TActiveSpawnPoint]]
| align="center" | R
|-
| property [[TMap.RedFlag|RedFlag]]: Byte
| align="center" | R
|-
| property [[TMap.BlueFlag|BlueFlag]]: Byte
| align="center" | R
|-
| property [[TMap.YellowFlag|YellowFlag]]: Byte
| align="center" | R
|-
| property [[TMap.OnBeforeMapChange|OnBeforeMapChange]]: [[TOnBeforeMapChangeEvent]]
| align="center" | RW
|-
| property [[TMap.OnAfterMapChange|OnAfterMapChange]]: [[TOnAfterMapChangeEvent]]
| align="center" | RW
|}
[[Category: Classes]]

TMap

2013-07-29T14:12:52Z

Menturi: /* Members */ Reformatted table to be consistent with other tables

TPlayers.BigText

2013-07-29T13:59:01Z

Menturi: /* Example */ Typo `server` as `serevr`

'''''procedure BigText(Layer: Byte; Text: string; Delay: Integer; Color: Longint; Scale: Single; X, Y: Integer)'''''
Layer: in which layer the text will be shown
Text: message to be shown
Delay: time in milliseconds for the message to remain on screen
Color: text's color
Scale: size of the text
X: horizontal starting position on the screen to display text (1-640)
Y: vertical starting position on the screen to display text (1-480)
==Description==
Displays a big text on all players' screens, like the "You Killed <Player>" text or so on.<br>
Note that the Y axis grows downwards.

== Example ==
<syntaxhighlight lang="pascal">
// let all players know that the server must be restarted
Players.BigText(2,'Server will now be restarted!',200,$FFFF00,0.20,20,300);
</syntaxhighlight>

[[Category:TPlayers]]

TActivePlayer.Alive

2013-07-29T13:54:05Z

Menturi: /* Example */ Capitalized `Btye` for consistency. Condensed code making it easier to understand

'''''property TActivePlayer.Alive: Boolean'''''
Access mode: RW
==Description==
If a player is alive or not.

==Example==
<syntaxhighlight lang="pascal">
var i: Byte;
begin
for i := 1 to 32 do
Players[i].Alive := not Players[i].Alive; // causes player to die if alive, and respawn if dead
end;
</syntaxhighlight>
[[Category:TActivePlayer]]

TActivePlayer.WeaponActive

2013-07-29T13:49:08Z

Menturi: /* Example */ Made comment slightly easier to read by adding a space after the `//`

'''''property TActivePlayer.WeaponActive[ID: Byte]: Boolean'''''
Access mode: W
==Description==
Sets a weapon available/unavailable from the weapon menu for a certain player.<br>
Weapon ID goes from 1 to 14 (Desert Eagles, HK .... Chainsaw, Law).

==Example==
<syntaxhighlight lang="pascal">
var i: byte;
begin
for i := 1 to 14 do
Players[i].WeaponActive[i] := i = 12; // deactivate all weapons but knife
</syntaxhighlight>

[[Category:TActivePlayer]]

TActivePlayer.WeaponActive

2013-07-29T13:36:46Z

Menturi: /* Example */ Old example assumed the knife was activated beforehand

'''''property TActivePlayer.WeaponActive[ID: Byte]: Boolean'''''
Access mode: W
==Description==
Sets a weapon available/unavailable from the weapon menu for a certain player.<br>
Weapon ID goes from 1 to 14 (Desert Eagles, HK .... Chainsaw, Law).

==Example==
<syntaxhighlight lang="pascal">
var i: byte;
begin
for i := 1 to 14 do
Players[i].WeaponActive[i] := i = 12; //deactivate all weapons but knife
</syntaxhighlight>

[[Category:TActivePlayer]]

TActivePlayer

2013-07-29T13:26:52Z

Menturi: /* Members */ Centered text in table to be consistent with other pages

==Inheritance==
*[[TPlayer]]
**[[TActivePlayer]]
**[[TNewPlayer]]

==Description==
Represents an active player. Accessible trough [[TPlayers.Player|Players[]]] array property.

user constructable: '''NO'''<br>
user destructable: '''NO'''

==Members==

{| class="wikitable"
! Member declaration !! Access mode !! Inherited
|-
| function [[TActivePlayer.Ban|Ban]](Time: Integer; Reason: string): Boolean || align="center" | || align="center" | no
|-
| function [[TActivePlayer.Kick|Kick]]: Boolean || align="center" | || align="center" | no
|-
| procedure [[TActivePlayer.Say|Say]](Text: string) || align="center" | || align="center" | no
|-
| procedure [[TActivePlayer.Damage|Damage]](Shooter: Byte; Damage: Integer) || align="center" | || align="center" | no
|-
| procedure [[TActivePlayer.BigText|BigText]](Layer: Byte; Text: string; Delay: Integer; Color: Longint; Scale: Single; X, Y: Integer) || align="center" | || align="center" | no
|-
| procedure [[TActivePlayer.ForceWeapon|ForceWeapon]](Primary, Secondary: [[TWeapon]]) || align="center" | || align="center" | no
|-
| procedure [[TActivePlayer.Forward|Forward]](TargetIP: string; TargetPort: Word; Message: string) || align="center" | || align="center" | no
|-
| procedure [[TActivePlayer.GiveBonus|GiveBonus]](BType: Byte) || align="center" | || align="center" | no
|-
| procedure [[TActivePlayer.Move|Move]](X, Y: Single) || align="center" | || align="center" | no
|-
| procedure [[TActivePlayer.Tell|Tell]](Text: string) || align="center" | || align="center" | no
|-
| procedure [[TActivePlayer.WriteConsole|WriteConsole]](Text: string; Color: Longint) || align="center" | || align="center" | no
|-
| colspan="3" |
|-
| property [[TPlayer.Name|Name]]: string || align="center" | R || align="center" | yes
|-
| property [[TPlayer.Health|Health]]: string || align="center" | R || align="center" | yes
|-
| property [[TPlayer.Primary|Primary]]: [[TPlayerWeapon]] || align="center" | R || align="center" | yes
|-
| property [[TPlayer.Secondary|Secondary]]: [[TPlayerWeapon]] || align="center" | R || align="center" | yes
|-
| property [[TPlayer.ShirtColor|ShirtColor]]: Longword || align="center" | R || align="center" | yes
|-
| property [[TPlayer.PantsColor|PantsColor]]: Longword || align="center" | R || align="center" | yes
|-
| property [[TPlayer.SkinColor|SkinColor]]: Longword || align="center" | R || align="center" | yes
|-
| property [[TPlayer.HairColor|HairColor]]: Longword || align="center" | R || align="center" | yes
|-
| property [[TPlayer.FavouriteWeapon|FavouriteWeapon]]: string || align="center" | RW || align="center" | yes
|-
| property [[TPlayer.ChosenSecondaryWeapon|ChosenSecondaryWeapon]]: Byte || align="center" | R || align="center" | yes
|-
| property [[TPlayer.Friend|Friend]]: string || align="center" | RW || align="center" | yes
|-
| property [[TPlayer.Accuracy|Accuracy]]: Byte || align="center" | RW || align="center" | yes
|-
| property [[TPlayer.ShootDead|ShootDead]]: Boolean || align="center" | RW || align="center" | yes
|-
| property [[TPlayer.GrenadeFrequency|GrenadeFrequency]]: Byte || align="center" | RW || align="center" | yes
|-
| property [[TPlayer.Camping|Camping]]: Boolean || align="center" | RW || align="center" | yes
|-
| property [[TPlayer.OnStartUse|OnStartUse]]: Byte || align="center" | RW || align="center" | yes
|-
| property [[TPlayer.HairStyle|HairStyle]]: Byte || align="center" | R || align="center" | yes
|-
| property [[TPlayer.Headgear|Headgear]]: Byte || align="center" | R || align="center" | yes
|-
| property [[TPlayer.Chain|Chain]]: Byte || align="center" | R || align="center" | yes
|-
| property [[TPlayer.ChatFrequency|ChatFrequency]]: Byte || align="center" | RW || align="center" | yes
|-
| property [[TPlayer.ChatKill|ChatKill]]: string || align="center" | RW || align="center" | yes
|-
| property [[TPlayer.ChatDead|ChatDead]]: string || align="center" | RW || align="center" | yes
|-
| property [[TPlayer.ChatLowHealth|ChatLowHealth]]: string || align="center" | RW || align="center" | yes
|-
| property [[TPlayer.ChatSeeEnemy|ChatSeeEnemy]]: string || align="center" | RW || align="center" | yes
|-
| property [[TPlayer.ChatWinning|ChatWinning]]: string || align="center" | RW || align="center" | yes
|-
| property [[TPlayer.Dummy|Dummy]]: Boolean || align="center" | R || align="center" | yes
|-
| property [[TActivePlayer.ID|ID]]: Byte || align="center" | R || align="center" | no
|-
| property [[TActivePlayer.Team|Team]]: Byte || align="center" | RW || align="center" | yes (modif.)
|-
| property [[TActivePlayer.Alive|Alive]]: Boolean || align="center" | RW || align="center" | yes (modif.)
|-
| property [[TActivePlayer.Kills|Kills]]: Integer || align="center" | RW || align="center" | no
|-
| property [[TActivePlayer.Deaths|Deaths]]: Integer || align="center" | R || align="center" | no
|-
| property [[TActivePlayer.Ping|Ping]]: Integer || align="center" | R || align="center" | no
|-
| property [[TActivePlayer.Active|Active]]: Boolean || align="center" | R || align="center" | no
|-
| property [[TActivePlayer.IP|IP]]: string || align="center" | R || align="center" | no
|-
| property [[TActivePlayer.Port|Port]]: Word || align="center" | R || align="center" | no
|-
| property [[TActivePlayer.VelX|VelX]]: Single || align="center" | R || align="center" | no
|-
| property [[TActivePlayer.VelY|VelY]]: Single || align="center" | R || align="center" | no
|-
| property [[TActivePlayer.Muted|Muted]]: Boolean || align="center" | RW || align="center" | no
|-
| property [[TActivePlayer.Jets|Jets]]: Integer || align="center" | R || align="center" | no
|-
| property [[TActivePlayer.Grenades|Grenades]]: Byte || align="center" | R || align="center" | no
|-
| property [[TActivePlayer.X|X]]: Single || align="center" | R || align="center" | no
|-
| property [[TActivePlayer.Y|Y]]: Single || align="center" | R || align="center" | no
|-
| property [[TActivePlayer.Flagger|Flagger]]: Boolean || align="center" | R || align="center" | no
|-
| property [[TActivePlayer.Time|Time]]: Integer || align="center" | R || align="center" | no
|-
| property [[TActivePlayer.OnGround|OnGround]]: Boolean || align="center" | R || align="center" | no
|-
| property [[TActivePlayer.Human|Human]]: Boolean || align="center" | R || align="center" | no
|-
| property [[TActivePlayer.Direction|Direction]]: Shortint || align="center" | R || align="center" | no
|-
| property [[TActivePlayer.Flags|Flags]]: Byte || align="center" | R || align="center" | no
|-
| property [[TActivePlayer.HWID|HWID]]: string || align="center" | R || align="center" | no
|-
| property [[TActivePlayer.KeyUp|KeyUp]]: Boolean || align="center" | R || align="center" | no
|-
| property [[TActivePlayer.KeyLeft|KeyLeft]]: Boolean || align="center" | R || align="center" | no
|-
| property [[TActivePlayer.KeyRight|KeyRight]]: Boolean || align="center" | R || align="center" | no
|-
| property [[TActivePlayer.KeyShoot|KeyShoot]]: Boolean || align="center" | R || align="center" | no
|-
| property [[TActivePlayer.KeyJetpack|KeyJetpack]]: Boolean || align="center" | R || align="center" | no
|-
| property [[TActivePlayer.KeyGrenade|KeyGrenade]]: Boolean || align="center" | R || align="center" | no
|-
| property [[TActivePlayer.KeyChangeWeap|KeyChangeWeap]]: Boolean || align="center" | R || align="center" | no
|-
| property [[TActivePlayer.KeyThrow|KeyThrow]]: Boolean || align="center" | R || align="center" | no
|-
| property [[TActivePlayer.KeyReload|KeyReload]]: Boolean || align="center" | R || align="center" | no
|-
| property [[TActivePlayer.KeyCrouch|KeyCrouch]]: Boolean || align="center" | R || align="center" | no
|-
| property [[TActivePlayer.KeyProne|KeyProne]]: Boolean || align="center" | R || align="center" | no
|-
| property [[TActivePlayer.WeaponActive|WeaponActive]][ID: Byte]: Boolean || align="center" | W || align="center" | no
|-
| property [[TActivePlayer.OnFlagGrab|OnFlagGrab]]: [[TOnFlagGrabEvent]] || align="center" | RW || align="center" | no
|-
| property [[TActivePlayer.OnFlagReturn|OnFlagReturn]]: [[TOnFlagReturnEvent]] || align="center" | RW || align="center" | no
|-
| property [[TActivePlayer.OnFlagScore|OnFlagScore]]: [[TOnFlagScoreEvent]] || align="center" | RW || align="center" | no
|-
| property [[TActivePlayer.OnBeforeRespawn|OnBeforeRespawn]]: [[TOnBeforeRespawnEvent]] || align="center" | RW || align="center" | no
|-
| property [[TActivePlayer.OnAfterRespawn|OnAfterRespawn]]: [[TOnAfterRespawnEvent]] || align="center" | RW || align="center" | no
|-
| property [[TActivePlayer.OnDamage|OnDamage]]: [[TOnDamageEvent]] || align="center" | RW || align="center" | no
|-
| property [[TActivePlayer.OnKill|OnKill]]: [[TOnKillEvent]] || align="center" | RW || align="center" | no
|-
| property [[TActivePlayer.OnWeaponChange|OnWeaponChange]]: [[TOnWeaponChangeEvent]] || align="center" | RW || align="center" | no
|-
| property [[TActivePlayer.OnVoteMapStart|OnVoteMapStart]]: [[TOnVoteMapStartEvent]] || align="center" | RW || align="center" | no
|-
| property [[TActivePlayer.OnVoteKickStart|OnVoteKickStart]]: [[TOnVoteKickStartEvent]] || align="center" | RW || align="center" | no
|-
| property [[TActivePlayer.OnVoteMap|OnVoteMap]]: [[TOnVoteMapEvent]] || align="center" | RW || align="center" | no
|-
| property [[TActivePlayer.OnVoteKick|OnVoteKick]]: [[TOnVoteKick]] || align="center" | RW || align="center" | no
|-
| property [[TActivePlayer.OnSpeak|OnSpeak]]: [[TOnSpeakEvent]] || align="center" | RW || align="center" | no
|-
| property [[TActivePlayer.OnCommand|OnCommand]]: [[TOnCommandEvent]] || align="center" | RW || align="center" | no
|}

[[Category:Classes]][[Category:TPlayer]]

TNewPlayer

2013-07-29T13:22:29Z

Menturi: /* Members */ Centered text in table to be consistent with other pages

==Inheritance==
*[[TPlayer]]
**[[TActivePlayer]]
**[[TNewPlayer]]

==Description==
Represents a new player (bot). To effectively create one, you can use [[TPlayers.Add|Players.Add]].<br>
'''Don't forget to free the instance after using it!'''<br>
user constructable: '''YES'''
user destructable: '''YES'''

==Members==

{| class="wikitable"
! Member declaration !! Access mode !! Inherited
|-
| constructor [[TNewPlayer.Create|Create]] || align="center" | || align="center" | no
|-
| procedure [[TNewPlayer.Free|Free]] || align="center" | || align="center" | no
|-
| colspan="3" |
|-
| property [[TNewPlayer.Name|Name]]: string || align="center" | RW || align="center" | yes (modif.)
|-
| property [[TNewPlayer.Health|Health]]: string || align="center" | RW || align="center" | yes (modif.)
|-
| property [[TNewPlayer.Primary|Primary]]: [[TPlayerWeapon]] || align="center" | RW || align="center" | yes (modif.)
|-
| property [[TNewPlayer.Secondary|Secondary]]: [[TPlayerWeapon]] || align="center" | RW || align="center" | yes (modif.)
|-
| property [[TNewPlayer.ShirtColor|ShirtColor]]: Longword || align="center" | RW || align="center" | yes (modif.)
|-
| property [[TNewPlayer.PantsColor|PantsColor]]: Longword || align="center" | RW || align="center" | yes (modif.)
|-
| property [[TNewPlayer.SkinColor|SkinColor]]: Longword || align="center" | RW || align="center" | yes (modif.)
|-
| property [[TNewPlayer.HairColor|HairColor]]: Longword || align="center" | RW || align="center" | yes (modif.)
|-
| property [[TPlayer.FavouriteWeapon|FavouriteWeapon]]: string || align="center" | RW || align="center" | yes
|-
| property [[TPlayer.ChosenSecondaryWeapon|ChosenSecondaryWeapon]]: Byte || align="center" | R || align="center" | yes
|-
| property [[TPlayer.Friend|Friend]]: string || align="center" | RW || align="center" | yes
|-
| property [[TPlayer.Accuracy|Accuracy]]: Byte || align="center" | RW || align="center" | yes
|-
| property [[TPlayer.ShootDead|ShootDead]]: Boolean || align="center" | RW || align="center" | yes
|-
| property [[TPlayer.GrenadeFrequency|GrenadeFrequency]]: Byte || align="center" | RW || align="center" | yes
|-
| property [[TPlayer.Camping|Camping]]: Boolean || align="center" | RW || align="center" | yes
|-
| property [[TPlayer.OnStartUse|OnStartUse]]: Byte || align="center" | RW || align="center" | yes
|-
| property [[TNewPlayer.HairStyle|HairStyle]]: Byte || align="center" | RW || align="center" | yes (modif.)
|-
| property [[TNewPlayer.Headgear|Headgear]]: Byte || align="center" | RW || align="center" | yes (modif.)
|-
| property [[TNewPlayer.Chain|Chain]]: Byte || align="center" | RW || align="center" | yes (modif.)
|-
| property [[TPlayer.ChatFrequency|ChatFrequency]]: Byte || align="center" | RW || align="center" | yes
|-
| property [[TPlayer.ChatKill|ChatKill]]: string || align="center" | RW || align="center" | yes
|-
| property [[TPlayer.ChatDead|ChatDead]]: string || align="center" | RW || align="center" | yes
|-
| property [[TPlayer.ChatLowHealth|ChatLowHealth]]: string || align="center" | RW || align="center" | yes
|-
| property [[TPlayer.ChatSeeEnemy|ChatSeeEnemy]]: string || align="center" | RW || align="center" | yes
|-
| property [[TPlayer.ChatWinning|ChatWinning]]: string || align="center" | RW || align="center" | yes
|-
| property [[TNewPlayer.Dummy|Dummy]]: Boolean || align="center" | RW || align="center" | yes (modif.)
|-
| property [[TNewPlayer.Team|Team]]: Byte || align="center" | RW || align="center" | yes (modif.)
|-
| property [[TPlayer.Alive|Alive]]: Boolean || align="center" | RW || align="center" | yes
|}

[[Category:Classes]][[Category:TPlayer]]

TPlayer

2013-07-29T13:18:22Z

Menturi: /* Description */ Change format to be consistent with other pages

==Inheritance==
*[[TPlayer]]
**[[TActivePlayer]]
**[[TNewPlayer]]

==Description==
Represents a player.<br>
user constructable: '''NO'''
user destructable: '''NO'''

==Members==

{| class="wikitable"
|-
! Member declaration !! Access mode !! Inherited
|-
| property [[TPlayer.Team|Team]]: Byte
| align="center" | R
| align="center" | no
|-
| property [[TPlayer.Name|Name]]: string
| align="center" | R
| align="center" | no
|-
| property [[TPlayer.Alive|Alive]]: boolean
| align="center" | R
| align="center" | no
|-
| property [[TPlayer.Health|Health]]: integer
| align="center" | R
| align="center" | no
|-
| property [[TPlayer.Primary|Primary]]: [[TPrimaryPlayerWeapon]]
| align="center" | R
| align="center" | no
|-
| property [[TPlayer.Secondary|Secondary]]: [[TSecondaryPlayerWeapon]]
| align="center" | R
| align="center" | no
|-
| property [[TPlayer.ShirtColor|ShirtColor]]: Longword
| align="center" | R
| align="center" | no
|-
| property [[TPlayer.PantsColor|PantsColor]]: Longword
| align="center" | R
| align="center" | no
|-
| property [[TPlayer.SkinColor|SkinColor]]: Longword
| align="center" | R
| align="center" | no
|-
| property [[TPlayer.HairColor|HairColor]]: Longword
| align="center" | R
| align="center" | no
|-
| property [[TPlayer.FavouriteWeapon|FavouriteWeapon]]: string
| align="center" | RW
| align="center" | no
|-
| property [[TPlayer.ChosenSecondaryWeapon|ChosenSecondaryWeapon]]: Byte
| align="center" | R
| align="center" | no
|-
| property [[TPlayer.Friend|Friend]]: string
| align="center" | RW
| align="center" | no
|-
| property [[TPlayer.Accuracy|Accuracy]]: Byte
| align="center" | RW
| align="center" | no
|-
| property [[TPlayer.ShootDead|ShootDead]]: Boolean
| align="center" | RW
| align="center" | no
|-
| property [[TPlayer.GrenadeFrequency|GrenadeFrequency]]: Byte
| align="center" | RW
| align="center" | no
|-
| property [[TPlayer.Camping|Camping]]: Boolear
| align="center" | RW
| align="center" | no
|-
| property [[TPlayer.OnStartUse|OnStartUse]]: Byte
| align="center" | RW
| align="center" | no
|-
| property [[TPlayer.HairStyle|HairStyle]]: Byte
| align="center" | R
| align="center" | no
|-
| property [[TPlayer.Headgear|Headgear]]: Byte
| align="center" | R
| align="center" | no
|-
| property [[TPlayer.Chain|Chain]]: Byte
| align="center" | R
| align="center" | no
|-
| property [[TPlayer.ChatFrequency|ChatFrequency]]: Byte
| align="center" | RW
| align="center" | no
|-
| property [[TPlayer.ChatKill|ChatKill]]: string
| align="center" | RW
| align="center" | no
|-
| property [[TPlayer.ChatDead|ChatDead]]: string
| align="center" | RW
| align="center" | no
|-
| property [[TPlayer.ChatLowHealth|ChatLowHealth]]: string
| align="center" | RW
| align="center" | no
|-
| property [[TPlayer.ChatSeeEnemy|ChatSeeEnemy]]: string
| align="center" | RW
| align="center" | no
|-
| property [[TPlayer.ChatWinning|ChatWinning]]: string
| align="center" | RW
| align="center" | no
|-
| property [[TPlayer.Dummy|Dummy]]: Boolean
| align="center" | R
| align="center" | no
|}
[[Category:Classes]]

TPlayer

2013-07-29T13:16:33Z

Menturi: /* Members */ Changed table format to be consistent with other pages

==Inheritance==
*[[TPlayer]]
**[[TActivePlayer]]
**[[TNewPlayer]]

==Description==
Represents a player.

user constructable: '''NO'''<br>
user destructable: '''NO'''

==Members==

{| class="wikitable"
|-
! Member declaration !! Access mode !! Inherited
|-
| property [[TPlayer.Team|Team]]: Byte
| align="center" | R
| align="center" | no
|-
| property [[TPlayer.Name|Name]]: string
| align="center" | R
| align="center" | no
|-
| property [[TPlayer.Alive|Alive]]: boolean
| align="center" | R
| align="center" | no
|-
| property [[TPlayer.Health|Health]]: integer
| align="center" | R
| align="center" | no
|-
| property [[TPlayer.Primary|Primary]]: [[TPrimaryPlayerWeapon]]
| align="center" | R
| align="center" | no
|-
| property [[TPlayer.Secondary|Secondary]]: [[TSecondaryPlayerWeapon]]
| align="center" | R
| align="center" | no
|-
| property [[TPlayer.ShirtColor|ShirtColor]]: Longword
| align="center" | R
| align="center" | no
|-
| property [[TPlayer.PantsColor|PantsColor]]: Longword
| align="center" | R
| align="center" | no
|-
| property [[TPlayer.SkinColor|SkinColor]]: Longword
| align="center" | R
| align="center" | no
|-
| property [[TPlayer.HairColor|HairColor]]: Longword
| align="center" | R
| align="center" | no
|-
| property [[TPlayer.FavouriteWeapon|FavouriteWeapon]]: string
| align="center" | RW
| align="center" | no
|-
| property [[TPlayer.ChosenSecondaryWeapon|ChosenSecondaryWeapon]]: Byte
| align="center" | R
| align="center" | no
|-
| property [[TPlayer.Friend|Friend]]: string
| align="center" | RW
| align="center" | no
|-
| property [[TPlayer.Accuracy|Accuracy]]: Byte
| align="center" | RW
| align="center" | no
|-
| property [[TPlayer.ShootDead|ShootDead]]: Boolean
| align="center" | RW
| align="center" | no
|-
| property [[TPlayer.GrenadeFrequency|GrenadeFrequency]]: Byte
| align="center" | RW
| align="center" | no
|-
| property [[TPlayer.Camping|Camping]]: Boolear
| align="center" | RW
| align="center" | no
|-
| property [[TPlayer.OnStartUse|OnStartUse]]: Byte
| align="center" | RW
| align="center" | no
|-
| property [[TPlayer.HairStyle|HairStyle]]: Byte
| align="center" | R
| align="center" | no
|-
| property [[TPlayer.Headgear|Headgear]]: Byte
| align="center" | R
| align="center" | no
|-
| property [[TPlayer.Chain|Chain]]: Byte
| align="center" | R
| align="center" | no
|-
| property [[TPlayer.ChatFrequency|ChatFrequency]]: Byte
| align="center" | RW
| align="center" | no
|-
| property [[TPlayer.ChatKill|ChatKill]]: string
| align="center" | RW
| align="center" | no
|-
| property [[TPlayer.ChatDead|ChatDead]]: string
| align="center" | RW
| align="center" | no
|-
| property [[TPlayer.ChatLowHealth|ChatLowHealth]]: string
| align="center" | RW
| align="center" | no
|-
| property [[TPlayer.ChatSeeEnemy|ChatSeeEnemy]]: string
| align="center" | RW
| align="center" | no
|-
| property [[TPlayer.ChatWinning|ChatWinning]]: string
| align="center" | RW
| align="center" | no
|-
| property [[TPlayer.Dummy|Dummy]]: Boolean
| align="center" | R
| align="center" | no
|}
[[Category:Classes]]

TGame.OnClockTick

2013-07-29T12:55:33Z

Menturi: /* Description */ `iddle` typo changed to `idle`

'''''property OnClockTick'''''
Access mode: RW
Event handler type: [[TOnClockTickEvent]]
Event handler declaration: procedure (Ticks: Integer);

==Description==
Event property called on idle in frequency described by [[TGame.TickThreshold|TickThreshold]]
<br>

==Example==
<syntaxhighlight lang="pascal">
procedure MyOnClockTickHandler(Ticks: Integer);
begin
WriteLn('OnClockTick event called: ' + IntToStr(Ticks));
end;

// ...

begin
// assign OnClockTick handler
Game.OnClockTick := @MyOnClockTickHandler;

// ...

// unassign
Game.OnClockTick := nil;
end;
</syntaxhighlight>

[[Category:TGame]][[Category:Events]]

TGame.OnLeave

2013-07-29T12:54:48Z

Menturi: Added missing semicolon

'''''property OnLeave'''''
Access mode: RW
Event handler type: [[TOnLeaveGameEvent]]
Event handler declaration: procedure (Player: [[TActivePlayer]]; Kicked: Boolean);

==Description==
Event property called when any player leaves the server or gets kicked/banned.
<br>

==Example==
<syntaxhighlight lang="pascal">
procedure MyOnLeaveHandler(Player: TActivePlayer; Kicked: Boolean);
begin
if Kicked then
WriteLn(Player.Name + ' has been kicked!')
else
WriteLn(Player.Name + ' has left the game in peace');
end;

// ...

begin
// assign OnLeave handler
Game.OnLeave := @MyOnLeaveHandler;

// ...

// unassign
Game.OnLeave := nil;
end;
</syntaxhighlight>

[[Category:TGame]][[Category:Events]]

Anticheat Ideas

2013-07-29T12:27:32Z

Menturi: Registered-players only server allowed to ban players by registration-key

* Accounts
* Paid Accounts (1 or 2€ donation goes to charity)
* External Closed-Source Anti-Cheat solution
* Authoritative server
* Ban by registration key in servers that only allow registered players