Soldat Community Wiki - User contributions [en]

TNewPlayer

2016-06-23T19:59:33Z

Falcon: /* Members */

==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 [[Constructor|Create]] || align="center" | || align="center" | no
|-
| procedure [[Destructor|Free]] || align="center" | || align="center" | no
|-
| colspan="3" |
|-
| property [[TNewPlayer.Name|Name]]: string || align="center" | RW || align="center" | yes (modif.)
|-
| property [[TNewPlayer.Health|Health]]: Single || align="center" | RW || align="center" | yes (modif.)
|-
| property [[TNewPlayer.Vest|Vest]]: Single || align="center" | R || align="center" | yes
|-
| 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

2016-06-23T19:59:17Z

Falcon: Modified health to single, added vest

==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]]: Single
| align="center" | R
| align="center" | no
|-
| property [[TPlayer.Vest|Vest]]: Single
| 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]]

TNewPlayer

2016-06-23T19:58:24Z

Falcon: Modified health to single, added vest

==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 [[Constructor|Create]] || align="center" | || align="center" | no
|-
| procedure [[Destructor|Free]] || align="center" | || align="center" | no
|-
| colspan="3" |
|-
| property [[TNewPlayer.Name|Name]]: string || align="center" | RW || align="center" | yes (modif.)
|-
| property [[TNewPlayer.Health|Health]]: Single || align="center" | RW || align="center" | yes (modif.)
|-
| property [[TNewPlayer.Vest|Vest]]: Single || 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]]

TActivePlayer

2016-06-23T19:57:37Z

Falcon: Changed health to single, added vest

==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 !! SS Version
|-
| 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.ForwardTo|ForwardTo]](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
|-
| procedure [[TActivePlayer.WorldText|WorldText]](Layer: Byte; Text: string; Delay: Integer; Color: Longint; Scale, X, Y: Single) || || || 2.7.8.b1
|-
| procedure [[TActivePlayer.SetVelocity|SetVelocity]](VelX, VelY: Single) || || || 2.7.8.b1
|-
| colspan="3" |
|-
| property [[TPlayer.Name|Name]]: string || align="center" | R || align="center" | yes
|-
| property [[TPlayer.Health|Health]]: Single || align="center" | R || align="center" | yes
|-
| property [[TPlayer.Vest|Vest]]: Single || 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" | RW || align="center" | no || W since 2.8.1
|-
| 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.IsAdmin|IsAdmin]]: Boolean || align="center" | RW || align="center" | no || 2.7.8.b1
|-
| property [[TActivePlayer.KeyUp|KeyUp]]: Boolean || align="center" | RW* || align="center" | no
|-
| property [[TActivePlayer.KeyLeft|KeyLeft]]: Boolean || align="center" | RW* || align="center" | no
|-
| property [[TActivePlayer.KeyRight|KeyRight]]: Boolean || align="center" | RW* || align="center" | no
|-
| property [[TActivePlayer.KeyShoot|KeyShoot]]: Boolean || align="center" | RW* || align="center" | no
|-
| property [[TActivePlayer.KeyJetpack|KeyJetpack]]: Boolean || align="center" | RW* || align="center" | no
|-
| property [[TActivePlayer.KeyGrenade|KeyGrenade]]: Boolean || align="center" | RW* || align="center" | no
|-
| property [[TActivePlayer.KeyChangeWeap|KeyChangeWeap]]: Boolean || align="center" | RW* || align="center" | no
|-
| property [[TActivePlayer.KeyThrow|KeyThrow]]: Boolean || align="center" | RW* || align="center" | no
|-
| property [[TActivePlayer.KeyReload|KeyReload]]: Boolean || align="center" | RW* || align="center" | no
|-
| property [[TActivePlayer.KeyCrouch|KeyCrouch]]: Boolean || align="center" | RW* || align="center" | no
|-
| property [[TActivePlayer.KeyProne|KeyProne]]: Boolean || align="center" | RW* || 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]]: [[TOnVoteKickEvent]] || 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
|-
| property [[TActivePlayer.OnKitPickup|OnKitPickup]]: [[TOnKitPickupEvent]] || align="center" | RW || align="center" | no || 2.7.8.b1
|-
| property [[TActivePlayer.OnFlagDrop|OnFlagDrop]]: [[TOnFlagDropEvent]] || align="center" | RW || align="center" | no || 2.7.8.b1
|}
'''Note''': writing properties marked with "RW*" affects only bots.

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

TScript.OnUnhandledException

2016-06-23T19:55:27Z

Falcon: Created page with "==Description== Type used by TScript.OnUnhandledException as an event handler type. ==Declaration== function (ErrorCode: TErrorType; Message, UnitName, FunctionName: st..."

==Description==
Type used by [[TScript.OnUnhandledException]] as an event handler type.

==Declaration==
function (ErrorCode: TErrorType; Message, UnitName, FunctionName: string; Row, Col: Cardinal): Boolean
ErrorCode: See below!
Message: Error message to be displayed
UnitName: Unit in which the error occured
FunctionName: Function that caused an error
Row,Col: Cursor position in file where error occured
Result: True if exception is handled, otherwise script is disabled.

==Error Types==
{{expand|descriptions when the errors appear}}
*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
[[Category:Types]]

TScript.TOnException

2016-06-23T19:55:19Z

Falcon:

==Description==
Type used by [[TScript.OnException]] as an event handler type.

==Declaration==
procedure (ErrorCode: TErrorType; Message, UnitName, FunctionName: string; Row, Col: Cardinal);
ErrorCode: See below!
Message: Error message to be displayed
UnitName: Unit in which the error occured
FunctionName: Function that caused an error
Row,Col: Cursor position in file where error occured

==Error Types==
{{expand|descriptions when the errors appear}}
*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
[[Category:Types]]

TScript.TOnUnhandledException

2016-06-23T19:54:41Z

Falcon:

'''''property OnUnhandledException: [[TScript.TOnUnhandledException|TOnUnhandledException]]'''''
Access mode: RW

==Description==
Occurs when an uncaught exception is thrown (out of range, null pointer, among others).

[[Category:TScript]]

TScript.TOnUnhandledException

2016-06-23T19:54:26Z

Falcon: Created page with " '''''property OnException: TOnException''''' Access mode: RW ==Description== Occurs when an uncaught exception is thrown (out of range, null point..."

'''''property OnException: [[TScript.TOnException|TOnException]]'''''
Access mode: RW

==Description==
Occurs when an uncaught exception is thrown (out of range, null pointer, among others).

[[Category:TScript]]

TScript.OnException

2016-06-23T19:54:22Z

Falcon:

'''''property OnException: [[TScript.TOnException|TOnException]]'''''
Access mode: RW

==Description==
Occurs when an exception is thrown (out of range, null pointer, among others).

[[Category:TScript]]

TScript

2016-06-23T19:53:50Z

Falcon: /* Members */

==Inheritance==
*[[TScript]]

==Description==
Represents a script.

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

'''This class is assigned to global variable "[[Global_Variables.Script|Script]]"'''

==Members==

{| class="wikitable"
! Member declaration !! Access mode !! Inherited
|-
| procedure [[TScript.Recompile|Recompile]](Force: Boolean) || align="center" | || align="center" | no
|-
| procedure [[TScript.Unload|Unload]] || align="center" | || align="center" | no
|-
| colspan="3" |
|-
| property [[TScript.Name|Name]]: string || align="center" | R || align="center" | no
|-
| property [[TScript.Version|Version]]: string || align="center" | R || align="center" | no
|-
| property [[TScript.Dir|Dir]]: string || align="center" | R || align="center" | no
|-
| property [[TScript.DebugMode|DebugMode]]: Boolean || align="center" | R || align="center" | no
|-
| property [[TScript.OnException|OnException]]: [[TScript.TOnException|TOnException]] || align="center" | RW || align="center" | no
|-
| property [[TScript.OnUnhandledException|OnUnhandledException]]: [[TScript.TOnUnhandledException|TOnUnhandledException]] || align="center" | RW || align="center" | no
|}

[[Category:Classes]]

TScript

2016-06-23T19:53:34Z

Falcon: Added TScript.OnUnhandledException

==Inheritance==
*[[TScript]]

==Description==
Represents a script.

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

'''This class is assigned to global variable "[[Global_Variables.Script|Script]]"'''

==Members==

{| class="wikitable"
! Member declaration !! Access mode !! Inherited
|-
| procedure [[TScript.Recompile|Recompile]](Force: Boolean) || align="center" | || align="center" | no
|-
| procedure [[TScript.Unload|Unload]] || align="center" | || align="center" | no
|-
| colspan="3" |
|-
| property [[TScript.Name|Name]]: string || align="center" | R || align="center" | no
|-
| property [[TScript.Version|Version]]: string || align="center" | R || align="center" | no
|-
| property [[TScript.Dir|Dir]]: string || align="center" | R || align="center" | no
|-
| property [[TScript.DebugMode|DebugMode]]: Boolean || align="center" | R || align="center" | no
|-
| property [[TScript.OnException|OnException]]: [[TScript.TOnException|TOnException]] || align="center" | RW || align="center" | no
-
| property [[TScript.OnUnhandledException|OnUnhandledException]]: [[TScript.TOnUnhandledException|TOnUnhandledException]] || align="center" | RW || align="center" | no
|}

[[Category:Classes]]

TPlayers.Add

2016-06-23T19:50:08Z

Falcon: Added JoinType parameter

'''''function Add(NewPlayer: [[TNewPlayer]], JoinType: TJoinType): [[TActivePlayer]]'''''
NewPlayer: An instance of TNewPlayer serving as configuration object for the bot
JoinType: Enum (TJoinNormal, TJoinSilent)�. Silent join will not generate message in console
Result: Active instance of bot
==Description==
Adds a new bot to game basing on configuration from [[TNewPlayer]].
'''Don't forget to free TNewPlayer instance after using it!'''

== Example ==
<syntaxhighlight lang="pascal">
var
NewPlayer: TNewPlayer;
begin
NewPlayer := TNewPlayer.Create;
try
NewPlayer.Name := 'Test bot!';
NewPlayer.Team := 1; // important!
NewPlayer.PantsColor := $FFFFFFFF;
NewPlayer.SkinColor := $FFFFFFFF;
Players.Add(NewPlayer, TJoinNormal);
finally
NewPlayer.Free; // important!
end;
end;
</syntaxhighlight>
[[Category:TPlayers]]

TActivePlayer.Kick

2016-06-23T19:48:46Z

Falcon: Added reason parameter

'''''function Kick: Boolean(Reason: TKickReason)'''''
Result: if it worked
Reason: Enum (TKickNoResponse, TKickNoCheatResponse,
TKickChangeTeam, TKickPing, TKickFlooding, TKickConsole,
TKickConnectionCheat, TKickCheat, TKickLeft, TKickVoted,
TKickAC, TKickSilent);
==Description==
Kicks a player from the server.<br>
Results false if you attempt to kick an inactive ID; otherwise true.

== Example ==
<syntaxhighlight lang="pascal">
var i: byte;
begin
for i := 1 to 32 do if Players[i].Active then
Players[i].Kick(TKickConsole); //kicks all active players
end;
</syntaxhighlight>

[[Category:TActivePlayer]]

TFile.CreateFileStreamFromFile

2016-04-04T20:35:17Z

Falcon:

'''''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.
[[Category:TFile]]

TActivePlayer

2016-03-21T00:29:29Z

Falcon: Deaths server description

==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 !! SS Version
|-
| 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.ForwardTo|ForwardTo]](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
|-
| procedure [[TActivePlayer.WorldText|WorldText]](Layer: Byte; Text: string; Delay: Integer; Color: Longint; Scale, X, Y: Single) || || || 2.7.8.b1
|-
| procedure [[TActivePlayer.SetVelocity|SetVelocity]](VelX, VelY: Single) || || || 2.7.8.b1
|-
| colspan="3" |
|-
| property [[TPlayer.Name|Name]]: string || align="center" | R || align="center" | yes
|-
| property [[TPlayer.Health|Health]]: Integer || 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" | RW || align="center" | no || W since 2.8.1
|-
| 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.IsAdmin|IsAdmin]]: Boolean || align="center" | RW || align="center" | no || 2.7.8.b1
|-
| property [[TActivePlayer.KeyUp|KeyUp]]: Boolean || align="center" | RW* || align="center" | no
|-
| property [[TActivePlayer.KeyLeft|KeyLeft]]: Boolean || align="center" | RW* || align="center" | no
|-
| property [[TActivePlayer.KeyRight|KeyRight]]: Boolean || align="center" | RW* || align="center" | no
|-
| property [[TActivePlayer.KeyShoot|KeyShoot]]: Boolean || align="center" | RW* || align="center" | no
|-
| property [[TActivePlayer.KeyJetpack|KeyJetpack]]: Boolean || align="center" | RW* || align="center" | no
|-
| property [[TActivePlayer.KeyGrenade|KeyGrenade]]: Boolean || align="center" | RW* || align="center" | no
|-
| property [[TActivePlayer.KeyChangeWeap|KeyChangeWeap]]: Boolean || align="center" | RW* || align="center" | no
|-
| property [[TActivePlayer.KeyThrow|KeyThrow]]: Boolean || align="center" | RW* || align="center" | no
|-
| property [[TActivePlayer.KeyReload|KeyReload]]: Boolean || align="center" | RW* || align="center" | no
|-
| property [[TActivePlayer.KeyCrouch|KeyCrouch]]: Boolean || align="center" | RW* || align="center" | no
|-
| property [[TActivePlayer.KeyProne|KeyProne]]: Boolean || align="center" | RW* || 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]]: [[TOnVoteKickEvent]] || 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
|-
| property [[TActivePlayer.OnKitPickup|OnKitPickup]]: [[TOnKitPickupEvent]] || align="center" | RW || align="center" | no || 2.7.8.b1
|-
| property [[TActivePlayer.OnFlagDrop|OnFlagDrop]]: [[TOnFlagDropEvent]] || align="center" | RW || align="center" | no || 2.7.8.b1
|}
'''Note''': writing properties marked with "RW*" affects only bots.

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

TActiveMapBullet

2016-02-11T17:29:20Z

Falcon: Added owner property

==Inheritance==
*[[TActiveMapBullet]]

==Description==
Holds information about bullets currently used on the [[TMap|Map]]

'''This class is assigned to global variable "[[TMap.Bullets|Map.Bullets]]"'''

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

==Members==
{| class="wikitable"
|-
! Member declaration !! Access mode !! SS Version
|-
| function [[TActiveMapBullet.GetOwnerWeaponId|GetOwnerWeaponId]]: Integer
| align="center" |
| 2.7.8.b1
|-
| colspan="3" |
|-
| property [[TActiveMapBullet.ID|ID]]: Byte
| align="center" | R
| 2.7.8.b1
|-
| property [[TActiveMapBullet.Active|Active]]: Boolean
| align="center" | R
| 2.7.8.b1
|-
| property [[TActiveMapBullet.Style|Style]]: Byte
| align="center" | R
| 2.7.8.b1
|-
| property [[TActiveMapBullet.X|X]]: Single
| align="center" | R
| 2.7.8.b1
|-
| property [[TActiveMapBullet.Y|Y]]: Single
| align="center" | R
| 2.7.8.b1
|-
| property [[TActiveMapBullet.VelX|VelX]]: Single
| align="center" | R
| 2.7.8.b1
|-
| property [[TActiveMapBullet.VelY|VelY]]: Single
| align="center" | R
| 2.7.8.b1
|-
| property [[TActiveMapBullet.Owner|Owner]]: Byte
| align="center" | R
| 2.8.1
|-
|}

[[Category:Classes]][[Category:TMap]]

TGame

2016-01-25T15:36:46Z

Falcon: Added TickCount

==Inheritance==
*[[TGame]]

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

'''This class is assigned to global variable "[[Global_Variables.Game|Game]]"'''

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

==Members==
{| class="wikitable"
|-
! Member declaration !! Access mode !! SS Version
|-
| 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.TickCount|TickCount]]: LongInt
| align="center" | R
| 2.8.0.rc1
|-
| property [[TGame.Teams|Teams]][ID: Byte]: [[TTeam]]
| align="center" | R
|-
| property [[TGame.CurrentMap|CurrentMap]]: string
| align="center" | R
| 2.7.8.b1
|-align="center" | R
|-
| property [[TGame.MapsList|MapsList]]: [[TMapsList]]
| align="center" | R
| 2.7.8.b1
|-
| 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
|-
| property [[TGame.OnAdminCommand|OnAdminCommand]]: [[TOnAdminCommandEvent]]
| align="center" | RW
| 2.7.8.b1
|-
| property [[TGame.OnTCPMessage|OnTCPMessage]]: [[TOnTCPMessageEvent]]
| align="center" | RW
| 2.7.8.b1
|-
| property [[TGame.OnAdminConnect|OnAdminConnect]]: [[TOnAdminConnectEvent]]
| align="center" | RW
| 2.7.8.b1
|-
| property [[TGame.OnAdminDisconnect|OnAdminDisconnect]]: [[TOnAdminDisconnectEvent]]
| align="center" | RW
| 2.7.8.b1
|-
|}

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

TActivePlayer

2015-12-09T20:49:18Z

Falcon: Fixed Health was documented as string

==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 !! SS Version
|-
| 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.ForwardTo|ForwardTo]](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
|-
| procedure [[TActivePlayer.WorldText|WorldText]](Layer: Byte; Text: string; Delay: Integer; Color: Longint; Scale, X, Y: Single) || || || 2.7.8.b1
|-
| procedure [[TActivePlayer.SetVelocity|SetVelocity]](VelX, VelY: Single) || || || 2.7.8.b1
|-
| colspan="3" |
|-
| property [[TPlayer.Name|Name]]: string || align="center" | R || align="center" | yes
|-
| property [[TPlayer.Health|Health]]: Integer || 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.IsAdmin|IsAdmin]]: Boolean || align="center" | RW || align="center" | no || 2.7.8.b1
|-
| 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]]: [[TOnVoteKickEvent]] || 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
|-
| property [[TActivePlayer.OnKitPickup|OnKitPickup]]: [[TOnKitPickupEvent]] || align="center" | RW || align="center" | no || 2.7.8.b1
|-
| property [[TActivePlayer.OnFlagDrop|OnFlagDrop]]: [[TOnFlagDropEvent]] || align="center" | RW || align="center" | no || 2.7.8.b1
|}

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

TNewPlayer

2013-10-28T22:18:19Z

Falcon: Health string->integer

==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 [[Constructor|Create]] || align="center" | || align="center" | no
|-
| procedure [[Destructor|Free]] || align="center" | || align="center" | no
|-
| colspan="3" |
|-
| property [[TNewPlayer.Name|Name]]: string || align="center" | RW || align="center" | yes (modif.)
|-
| property [[TNewPlayer.Health|Health]]: integer || 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]]

TActivePlayer.OnVoteKick

2013-09-25T22:18:58Z

Falcon: /* Example */

'''''property OnVoteKick'''''
Access mode: RW
Event handler type: [[TOnVoteKickEvent]]
Event handler declaration: procedure (Player, Victim: TActivePlayer)

==Description==
Event property called when a player hits F12 during a kick vote. F11 (No) votes are ignored.
<br>

==Example==
Example makes players say "Voted Yes!" when they hit F12.
<syntaxhighlight lang="pascal">
procedure OnVoteMessage(Player, Victim: TActivePlayer);
begin
Player.Say('Voted Yes!');
end;

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

[[Category:TActivePlayer]][[Category:Events]]

TActivePlayer.OnVoteMap

2013-09-25T22:18:43Z

Falcon: /* Example */

'''''property OnVoteMap'''''
Access mode: RW
Event handler type: [[TOnVoteMapEvent]]
Event handler declaration: procedure (Player: TActivePlayer; Map: string)

==Description==
Event property called when a player hits F12 during a map vote. F11 (No) votes are ignored.
<br>

==Example==
Example makes players say "Voted Yes!" when they hit F12.
<syntaxhighlight lang="pascal">
procedure OnVoteMessage(Player: TActivePlayer; Map: string);
begin
Player.Say('Voted Yes!');
end;

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

[[Category:TActivePlayer]][[Category:Events]]

TActivePlayer.OnVoteMap

2013-09-25T22:18:11Z

Falcon:

'''''property OnVoteMap'''''
Access mode: RW
Event handler type: [[TOnVoteMapEvent]]
Event handler declaration: procedure (Player: TActivePlayer; Map: string)

==Description==
Event property called when a player hits F12 during a map vote. F11 (No) votes are ignored.
<br>

==Example==
Example makes players say "Voted!" when they hit F12.
<syntaxhighlight lang="pascal">
procedure OnVoteMessage(Player: TActivePlayer; Map: string);
begin
Player.Say('Voted Yes!');
end;

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

[[Category:TActivePlayer]][[Category:Events]]

TActivePlayer.OnVoteKick

2013-09-25T22:17:31Z

Falcon: /* Example */

'''''property OnVoteKick'''''
Access mode: RW
Event handler type: [[TOnVoteKickEvent]]
Event handler declaration: procedure (Player, Victim: TActivePlayer)

==Description==
Event property called when a player hits F12 during a kick vote. F11 (No) votes are ignored.
<br>

==Example==
Example makes players say "Voted!" when they hit F12.
<syntaxhighlight lang="pascal">
procedure OnVoteMessage(Player, Victim: TActivePlayer);
begin
Player.Say('Voted Yes!');
end;

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

[[Category:TActivePlayer]][[Category:Events]]

TActivePlayer.OnVoteKick

2013-09-25T22:17:22Z

Falcon: /* Example */

'''''property OnVoteKick'''''
Access mode: RW
Event handler type: [[TOnVoteKickEvent]]
Event handler declaration: procedure (Player, Victim: TActivePlayer)

==Description==
Event property called when a player hits F12 during a kick vote. F11 (No) votes are ignored.
<br>

==Example==
Example makes players say "Voted!" when they hit F12.
<syntaxhighlight lang="pascal">
procedure OnVoteMessage(Player, Victim: TActivePlayer);
begin
Player.Say('Voted!');
end;

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

[[Category:TActivePlayer]][[Category:Events]]

TActivePlayer.OnVoteKick

2013-09-25T22:17:09Z

Falcon: /* Description */

'''''property OnVoteKick'''''
Access mode: RW
Event handler type: [[TOnVoteKickEvent]]
Event handler declaration: procedure (Player, Victim: TActivePlayer)

==Description==
Event property called when a player hits F12 during a kick vote. F11 (No) votes are ignored.
<br>

==Example==
Example makes players say "Voted!" when they hit F11/F12.
<syntaxhighlight lang="pascal">
procedure OnVoteMessage(Player, Victim: TActivePlayer);
begin
Player.Say('Voted!');
end;

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

[[Category:TActivePlayer]][[Category:Events]]

TMap

2013-08-21T17:26:10Z

Falcon: Byte -> TActiveFlag

==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]]: [[TActiveFlag]]
| align="center" | R
|-
| property [[TMap.BlueFlag|BlueFlag]]: [[TActiveFlag]]
| align="center" | R
|-
| property [[TMap.YellowFlag|YellowFlag]]: [[TActiveFlag]]
| align="center" | R
|-
| property [[TMap.OnBeforeMapChange|OnBeforeMapChange]]: [[TOnBeforeMapChangeEvent]]
| align="center" | RW
|-
| property [[TMap.OnAfterMapChange|OnAfterMapChange]]: [[TOnAfterMapChangeEvent]]
| align="center" | RW
|}
[[Category: Classes]]

TScript.TOnException

2013-08-21T17:07:20Z

Falcon: /* Error Types */

==Description==
Type used by [[TScript.OnException]] as an event handler type.

==Declaration==
function (ErrorCode: TErrorType; Message, UnitName, FunctionName: string; Row, Col: Cardinal): Boolean
ErrorCode: See below!
Message: Error message to be displayed
UnitName: Unit in which the error occured
FunctionName: Function that caused an error
Row,Col: Cursor position in file where error occured
Result: True if exception is handled, otherwise script is disabled.

==Error Types==
*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
[[Category:Types]]

OnPlayerSpeak

2013-08-21T08:52:11Z

Falcon: removed thread note

===From the Scripting Manual===
''procedure OnPlayerSpeak(ID: Byte; Text: string);''

'''Parameter Info:'''
ID (Byte): Player ID of the person who just spoke.
Text (String): Self Explanitory.

'''Description:'''
This procedure will be called every time a player speaks.

==See also==
* [[OnPlayerCommand]]

[[Category:Server Scripting]][[Category:Server Scripting Events]]

SC3 Config File

2013-07-29T22:15:48Z

Falcon: /* Config */

Config file is divded into three sections: Config, SearchPaths and Defines. First one defines all the basic properties,
2nd paths in which to search all the unit/include files and 3rd pre-defines preprocessor defines.

==Config==
{| class="wikitable"
|-
! Key !! Description !! Type !! Required !! Default value
|-
| Name
| The name of the script. Appears everywhere in console output that is related to that script (compile messages, exceptions). Must be at most 20 characters long.
| align="center" | String
| align="center" | Yes
| align="center" | N/A
|-
| MainFile
| The name of entry file for the script.
| align="center" | String
| align="center" | No
| align="center" | main.pas
|-
| Debug
| Whenever script should run in debug mode or not. In debug mode, debug symbols are also compiled and used during runtime. This allows displaying line and unit name in case of exception.
| align="center" | Boolean (1 or 0)
| align="center" | No
| align="center" | 0
|-
| Sandboxed
| Sandbox level for the script. possible values:
* 0: access to entire harddrive
* 1: access restricted to entire soldatserver/ folder
* 2: access restricted to script's data folder (soldatserver/scripts/<script name>/data
This value can be constrained by server.ini file.
| align="center" | Integer
| align="center" | No
| align="center" | 2
|-
| AllowDlls
| Whenever the script is allowed to load external dlls. This value can be constrained by server.ini file.
| align="center" | Boolean (1 or 0)
| align="center" | No
| align="center" | 0
|-
| AllowIniEdit
| Used only if Sandboxed is set to 1. Determinates whenever script is allowed to read/write soldat.ini and server.ini. This value can be constrained by server.ini file.
| align="center" | Boolean (1 or 0)
| align="center" | No
| align="center" | 0
|-
| Gamemod
| Whenever the script is a gamemod. Gamemod script mark server as gamemod server and thus make it displayed as such in the lobby
| align="center" | Boolean (1 or 0)
| align="center" | No
| align="center" | 0
|-
| Legacy
| Whenever the script should run in legacy mode or not. Legacy mode adds all interface and events known from ScriptCore 2. Useful for migrating the scripts.
| align="center" | Boolean (1 or 0)
| align="center" | No
| align="center" | 0
|}

Example:
[Config]
Name=My awesome script
MainFile=events.pas
Sandboxed=1
Legacy=1

==SearchPaths==
[SearchPaths] section defines all the folders that should be scanned for unit files. Paths should be delimited by enter, each path in new line. Paths can contain "../" which allows to make script use some "shared" units folder. Paths are relative to script's root folder (soldatserver/scripts/<script name>). They also inherit paths defined in server.ini file, which are also relative to root folder of script they're applied to. Script's root folder is scanned by default, there's no need to add "." search path. <br>
Example:
[SearchPaths]
/players
/players/tasks
/game/
../shared

==Defines==
[Defines] section defines preprocessor constants that should be exported to the script. Besides those defined here, script will also recieve WINDOWS/UNIX constant depending on operating system it runs on. Defines should be enter delimited, each define in new line. Script also inherits all defines defined in server.ini file.<br>
Example:
[Defines]
TEST
DEBUG
FANCY
lowercasedarealsook
[[Category:ScriptCore 3]]

==Example==
Complete file made from this article's examples would look like this:
[Config]
Name=My awesome script
MainFile=events.pas
Sandboxed=1
Legacy=1

[SearchPaths]
/players
/players/tasks
/game/
../shared

[Defines]
TEST
DEBUG
FANCY
lowercasedarealsook

SC3 Config File

2013-07-29T18:45:59Z

Falcon: /* Example */

Config file is divded into three sections: Config, SearchPaths and Defines. First one defines all the basic properties,
2nd paths in which to search all the unit/include files and 3rd pre-defines preprocessor defines.

==Config==
{| class="wikitable"
|-
! Key !! Description !! Type !! Required !! Default value
|-
| Name
| The name of the script. Appears everywhere in console output that is related to that script (compile messages, exceptions). Must be at most 25 characters long.
| align="center" | String
| align="center" | Yes
| align="center" | N/A
|-
| MainFile
| The name of entry file for the script.
| align="center" | String
| align="center" | No
| align="center" | main.pas
|-
| Debug
| Whenever script should run in debug mode or not. In debug mode, debug symbols are also compiled and used during runtime. This allows displaying line and unit name in case of exception.
| align="center" | Boolean (1 or 0)
| align="center" | No
| align="center" | 0
|-
| Sandboxed
| Sandbox level for the script. possible values:
* 0: access to entire harddrive
* 1: access restricted to entire soldatserver/ folder
* 2: access restricted to script's data folder (soldatserver/scripts/<script name>/data
This value can be constrained by server.ini file.
| align="center" | Integer
| align="center" | No
| align="center" | 2
|-
| AllowDlls
| Whenever the script is allowed to load external dlls. This value can be constrained by server.ini file.
| align="center" | Boolean (1 or 0)
| align="center" | No
| align="center" | 0
|-
| AllowIniEdit
| Used only if Sandboxed is set to 1. Determinates whenever script is allowed to read/write soldat.ini and server.ini. This value can be constrained by server.ini file.
| align="center" | Boolean (1 or 0)
| align="center" | No
| align="center" | 0
|-
| Gamemod
| Whenever the script is a gamemod. Gamemod script mark server as gamemod server and thus make it displayed as such in the lobby
| align="center" | Boolean (1 or 0)
| align="center" | No
| align="center" | 0
|-
| Legacy
| Whenever the script should run in legacy mode or not. Legacy mode adds all interface and events known from ScriptCore 2. Useful for migrating the scripts.
| align="center" | Boolean (1 or 0)
| align="center" | No
| align="center" | 0
|}

Example:
[Config]
Name=My awesome script
MainFile=events.pas
Sandboxed=1
Legacy=1

==SearchPaths==
[SearchPaths] section defines all the folders that should be scanned for unit files. Paths should be delimited by enter, each path in new line. Paths can contain "../" which allows to make script use some "shared" units folder. Paths are relative to script's root folder (soldatserver/scripts/<script name>). They also inherit paths defined in server.ini file, which are also relative to root folder of script they're applied to. Script's root folder is scanned by default, there's no need to add "." search path. <br>
Example:
[SearchPaths]
/players
/players/tasks
/game/
../shared

==Defines==
[Defines] section defines preprocessor constants that should be exported to the script. Besides those defined here, script will also recieve WINDOWS/UNIX constant depending on operating system it runs on. Defines should be enter delimited, each define in new line. Script also inherits all defines defined in server.ini file.<br>
Example:
[Defines]
TEST
DEBUG
FANCY
lowercasedarealsook
[[Category:ScriptCore 3]]

==Example==
Complete file made from this article's examples would look like this:
[Config]
Name=My awesome script
MainFile=events.pas
Sandboxed=1
Legacy=1

[SearchPaths]
/players
/players/tasks
/game/
../shared

[Defines]
TEST
DEBUG
FANCY
lowercasedarealsook

Global Variables.Script

2013-07-29T18:42:34Z

Falcon: /* Description */

'''''Script: [[TScript]]'''''

==Description==
{| class=wikitable
! Variable Name !! Type
|-
| align=center | Script || [[TScript]]
|-
|}

Global variable in which script related API is being held.

[[Category:Global Variables]]

SC3 Config File

2013-07-29T18:38:21Z

Falcon: /* Config */

Config file is divded into three sections: Config, SearchPaths and Defines. First one defines all the basic properties,
2nd paths in which to search all the unit/include files and 3rd pre-defines preprocessor defines.

==Config==
{| class="wikitable"
|-
! Key !! Description !! Type !! Required !! Default value
|-
| Name
| The name of the script. Appears everywhere in console output that is related to that script (compile messages, exceptions). Must be at most 25 characters long.
| align="center" | String
| align="center" | Yes
| align="center" | N/A
|-
| MainFile
| The name of entry file for the script.
| align="center" | String
| align="center" | No
| align="center" | main.pas
|-
| Debug
| Whenever script should run in debug mode or not. In debug mode, debug symbols are also compiled and used during runtime. This allows displaying line and unit name in case of exception.
| align="center" | Boolean (1 or 0)
| align="center" | No
| align="center" | 0
|-
| Sandboxed
| Sandbox level for the script. possible values:
* 0: access to entire harddrive
* 1: access restricted to entire soldatserver/ folder
* 2: access restricted to script's data folder (soldatserver/scripts/<script name>/data
This value can be constrained by server.ini file.
| align="center" | Integer
| align="center" | No
| align="center" | 2
|-
| AllowDlls
| Whenever the script is allowed to load external dlls. This value can be constrained by server.ini file.
| align="center" | Boolean (1 or 0)
| align="center" | No
| align="center" | 0
|-
| AllowIniEdit
| Used only if Sandboxed is set to 1. Determinates whenever script is allowed to read/write soldat.ini and server.ini. This value can be constrained by server.ini file.
| align="center" | Boolean (1 or 0)
| align="center" | No
| align="center" | 0
|-
| Gamemod
| Whenever the script is a gamemod. Gamemod script mark server as gamemod server and thus make it displayed as such in the lobby
| align="center" | Boolean (1 or 0)
| align="center" | No
| align="center" | 0
|-
| Legacy
| Whenever the script should run in legacy mode or not. Legacy mode adds all interface and events known from ScriptCore 2. Useful for migrating the scripts.
| align="center" | Boolean (1 or 0)
| align="center" | No
| align="center" | 0
|}

Example:
[Config]
Name=My awesome script
MainFile=events.pas
Sandboxed=1
Legacy=1

==SearchPaths==
[SearchPaths] section defines all the folders that should be scanned for unit files. Paths should be delimited by enter, each path in new line. Paths can contain "../" which allows to make script use some "shared" units folder. Paths are relative to script's root folder (soldatserver/scripts/<script name>). They also inherit paths defined in server.ini file, which are also relative to root folder of script they're applied to. Script's root folder is scanned by default, there's no need to add "." search path. <br>
Example:
[SearchPaths]
/players
/players/tasks
/game/
../shared

==Defines==
[Defines] section defines preprocessor constants that should be exported to the script. Besides those defined here, script will also recieve WINDOWS/UNIX constant depending on operating system it runs on. Defines should be enter delimited, each define in new line. Script also inherits all defines defined in server.ini file.<br>
Example:
[Defines]
TEST
DEBUG
FANCY
lowercasedarealsook
[[Category:ScriptCore 3]]

==Example==
Complete file made from this article's example would look like this:
[Config]
Name=My awesome script
MainFile=events.pas
Sandboxed=1
Legacy=1

[SearchPaths]
/players
/players/tasks
/game/
../shared

[Defines]
TEST
DEBUG
FANCY
lowercasedarealsook

SC3 Config File

2013-07-29T18:37:08Z

Falcon: /* Config */

Config file is divded into three sections: Config, SearchPaths and Defines. First one defines all the basic properties,
2nd paths in which to search all the unit/include files and 3rd pre-defines preprocessor defines.

==Config==
{| class="wikitable"
|-
! Key !! Description !! Type !! Required !! Default value
|-
| Name
| The name of the script. Appears everywhere in console output that is related to that script (compile messages, exceptions). Must be at most 25 characters long.
| align="center" | String
| align="center" | Yes
| align="center" | none
|-
| MainFile
| The name of entry file for the script.
| align="center" | String
| align="center" | No
| align="center" | main.pas
|-
| Debug
| Whenever script should run in debug mode or not. In debug mode, debug symbols are also compiled and used during runtime. This allows displaying line and unit name in case of exception.
| align="center" | Boolean (1 or 0)
| align="center" | No
| align="center" | 0
|-
| Sandboxed
| Sandbox level for the script. possible values:
* 0: access to entire harddrive
* 1: access restricted to entire soldatserver/ folder
* 2: access restricted to script's data folder (soldatserver/scripts/<script name>/data
This value can be constrained by server.ini file.
| align="center" | Integer
| align="center" | No
| align="center" | 2
|-
| AllowDlls
| Whenever the script is allowed to load external dlls. This value can be constrained by server.ini file.
| align="center" | Boolean (1 or 0)
| align="center" | No
| align="center" | 0
|-
| AllowIniEdit
| Used only if Sandboxed is set to 1. Determinates whenever script is allowed to read/write soldat.ini and server.ini. This value can be constrained by server.ini file.
| align="center" | Boolean (1 or 0)
| align="center" | No
| align="center" | 0
|-
| Gamemod
| Whenever the script is a gamemod. Gamemod script mark server as gamemod server and thus make it displayed as such in the lobby
| align="center" | Boolean (1 or 0)
| align="center" | No
| align="center" | 0
|-
| Legacy
| Whenever the script should run in legacy mode or not. Legacy mode adds all interface and events known from ScriptCore 2. Useful for migrating the scripts.
| align="center" | Boolean (1 or 0)
| align="center" | No
| align="center" | 0
|}

Example:
[Config]
Name=My awesome script
MainFile=events.pas
Sandboxed=1
Legacy=1

==SearchPaths==
[SearchPaths] section defines all the folders that should be scanned for unit files. Paths should be delimited by enter, each path in new line. Paths can contain "../" which allows to make script use some "shared" units folder. Paths are relative to script's root folder (soldatserver/scripts/<script name>). They also inherit paths defined in server.ini file, which are also relative to root folder of script they're applied to. Script's root folder is scanned by default, there's no need to add "." search path. <br>
Example:
[SearchPaths]
/players
/players/tasks
/game/
../shared

==Defines==
[Defines] section defines preprocessor constants that should be exported to the script. Besides those defined here, script will also recieve WINDOWS/UNIX constant depending on operating system it runs on. Defines should be enter delimited, each define in new line. Script also inherits all defines defined in server.ini file.<br>
Example:
[Defines]
TEST
DEBUG
FANCY
lowercasedarealsook
[[Category:ScriptCore 3]]

==Example==
Complete file made from this article's example would look like this:
[Config]
Name=My awesome script
MainFile=events.pas
Sandboxed=1
Legacy=1

[SearchPaths]
/players
/players/tasks
/game/
../shared

[Defines]
TEST
DEBUG
FANCY
lowercasedarealsook

SC3 Config File

2013-07-29T18:35:37Z

Falcon:

Config file is divded into three sections: Config, SearchPaths and Defines. First one defines all the basic properties,
2nd paths in which to search all the unit/include files and 3rd pre-defines preprocessor defines.

==Config==
{| class="wikitable"
|-
! Key !! Description !! Type !! Required !! Default value
|-
| Name
| The name of the script. Appears everywhere in console output that is related to that script (compile messages, exceptions). Must be at most 25 characters long.
| align="center" | String
| align="center" | Yes
| align="center" | none
|-
| MainFile
| The name of entry file for the script.
| align="center" | String
| align="center" | No
| align="center" | main.pas
|-
| Debug
| Whenever script should run in debug mode or not. In debug mode, debug symbols are also compiled and used during runtime. This allows displaying line and unit name in case of exception.
| align="center" | Boolean (1 or 0)
| align="center" | No
| align="center" | 0
|-
| Sandboxed
| Sandbox level for the script. possible values:
* 0: access to entire harddrive
* 1: access restricted to entire soldatserver/ folder
* 2: access restricted to script's data folder (soldatserver/scripts/<script name>/data
This value can be constrained by server.ini file.
| align="center" | Integer
| align="center" | No
| align="center" | 2
|-
| AllowDlls
| Whenever the script is allowed to load external dlls. This value can be constrained by server.ini file.
| align="center" | Boolean (1 or 0)
| align="center" | No
| align="center" | 0
|-
| AllowIniEdit
| Used only if Sandboxed is set to 1. Determinates whenever script is allowed to read/write soldat.ini and server.ini. This value can be constrained by server.ini file.
| align="center" | Boolean (1 or 0)
| align="center" | No
| align="center" | 0
|-
| Gamemod
| Whenever the script is a gamemod. Gamemod script mark server as gamemod server and thus make it displayed as such in the lobby
| align="center" | Boolean (1 or 0)
| align="center" | No
| align="center" | 0
|-
| Legacy
| Whenever the script should run in legacy mode or not. Legacy mode adds all interface and events known from ScriptCore 2. Usfeul for migrating the scripts.
| align="center" | Boolean (1 or 0)
| align="center" | No
| align="center" | 0
|}

Example:
[Config]
Name=My awesome script
MainFile=events.pas
Sandboxed=1
Legacy=1

==SearchPaths==
[SearchPaths] section defines all the folders that should be scanned for unit files. Paths should be delimited by enter, each path in new line. Paths can contain "../" which allows to make script use some "shared" units folder. Paths are relative to script's root folder (soldatserver/scripts/<script name>). They also inherit paths defined in server.ini file, which are also relative to root folder of script they're applied to. Script's root folder is scanned by default, there's no need to add "." search path. <br>
Example:
[SearchPaths]
/players
/players/tasks
/game/
../shared

==Defines==
[Defines] section defines preprocessor constants that should be exported to the script. Besides those defined here, script will also recieve WINDOWS/UNIX constant depending on operating system it runs on. Defines should be enter delimited, each define in new line. Script also inherits all defines defined in server.ini file.<br>
Example:
[Defines]
TEST
DEBUG
FANCY
lowercasedarealsook
[[Category:ScriptCore 3]]

==Example==
Complete file made from this article's example would look like this:
[Config]
Name=My awesome script
MainFile=events.pas
Sandboxed=1
Legacy=1

[SearchPaths]
/players
/players/tasks
/game/
../shared

[Defines]
TEST
DEBUG
FANCY
lowercasedarealsook

SC3 Config File

2013-07-29T18:31:48Z

Falcon:

Config file is divded into three sections: Config, SearchPaths and Defines. First one defines all the basic properties,
2nd paths in which to search all the unit/include files and 3rd pre-defines some preprocessor defines.

==Config==
{| class="wikitable"
|-
! Key !! Description !! Type !! Required !! Default value
|-
| Name
| The name of the script. Appears everywhere in console output that is related to that script (compile messages, exceptions). Must be at most 25 characters long.
| align="center" | String
| align="center" | Yes
| align="center" | none
|-
| MainFile
| The name of entry file for the script.
| align="center" | String
| align="center" | No
| align="center" | main.pas
|-
| Debug
| Whenever script should run in debug mode or not. In debug mode, debug symbols are also compiled and used during runtime. This allows displaying line and unit name in case of exception.
| align="center" | Boolean (1 or 0)
| align="center" | No
| align="center" | 0
|-
| Sandboxed
| Sandbox level for the script. possible values:
* 0: access to entire harddrive
* 1: access restricted to entire soldatserver/ folder
* 2: access restricted to script's data folder (soldatserver/scripts/<script name>/data
This value can be constrained by server.ini file.
| align="center" | Integer
| align="center" | No
| align="center" | 2
|-
| AllowDlls
| Whenever the script is allowed to load external dlls. This value can be constrained by server.ini file.
| align="center" | Boolean (1 or 0)
| align="center" | No
| align="center" | 0
|-
| AllowIniEdit
| Used only if Sandboxed is set to 1. Determinates whenever script is allowed to read/write soldat.ini and server.ini. This value can be constrained by server.ini file.
| align="center" | Boolean (1 or 0)
| align="center" | No
| align="center" | 0
|-
| Gamemod
| Whenever the script is a gamemod. Gamemod script mark server as gamemod server and thus make it displayed as such in the lobby
| align="center" | Boolean (1 or 0)
| align="center" | No
| align="center" | 0
|-
| Legacy
| Whenever the script should run in legacy mode or not. Legacy mode adds all interface and events known from ScriptCore 2. Usfeul for migrating the scripts.
| align="center" | Boolean (1 or 0)
| align="center" | No
| align="center" | 0
|}

Example:
[Config]
Name=My awesome script
MainFile=events.pas
Sandboxed=1
Legacy=1

==SearchPaths==
[SearchPaths] section defines all the folders that should be scanned for unit files. Paths should be delimited by enter, each path in new line. Paths can contain "../" which allows to make script use some "shared" units folder. Paths are relative to script's root folder (soldatserver/scripts/<script name>). They also inherit paths defined in server.ini file, which are also relative to root folder of script they're applied to. Script's root folder is scanned by default, there's no need to add "." search path. <br>
Example:
[SearchPaths]
/players
/players/tasks
/game/
../shared

==Defines==
[Defines] section defines preprocessor constants that should be exported to the script. Besides those defined here, script will also recieve WINDOWS/UNIX constant depending on operating system it runs on. Defines should be enter delimited, each define in new line. Script also inherits all defines defined in server.ini file.<br>
Example:
[Defines]
TEST
DEBUG
FANCY
lowercasedarealsook
[[Category:ScriptCore 3]]

==Example==
Complete file made from this article's example would look like this:
[Config]
Name=My awesome script
MainFile=events.pas
Sandboxed=1
Legacy=1

[SearchPaths]
/players
/players/tasks
/game/
../shared

[Defines]
TEST
DEBUG
FANCY
lowercasedarealsook

TTeam.OnJoin

2013-07-29T12:52:32Z

Falcon: /* Example */

'''''property OnJoin'''''
Access mode: RW
Event handler type: [[TOnJoinTeamEvent]]
Event handler declaration: procedure (Player: [[TPlayer]]; Team: [[TTeam]]);

==Description==
Event property called when a player tries to change team
<br>

==Example==
<syntaxhighlight lang="pascal">
procedure MyOnJoinTeamHandler(Player: TActivePlayer; Team: TTeam);
begin
Player.Team := 1;
Player.Tell('Sorry, you can''t join Bravo Team');
end;

// ...

begin
// assign OnJoinTeam handler
Game.Teams[2].OnJoin := @MyOnJoinTeamHandler;

// ...

// unassign
Game.Teams[2].OnJoin := nil;
end;
</syntaxhighlight>

[[Category:TTeam]][[Category:Events]]

SC3 Config File

2013-07-29T12:24:53Z

Falcon: /* Defines */

Config file is divded into three sections: Config, SearchPaths and Defines. First one defines all the basic properties,
2nd paths in which to search all the unit/include files and 3rd pre-defines come preprocessor defines.

==Config==
{| class="wikitable"
|-
! Key !! Description !! Type !! Required !! Default value
|-
| Name
| The name of the script. Appears everywhere in console output that is related to that script (compile messages, exceptions). Must be at most 25 characters long.
| align="center" | String
| align="center" | Yes
| align="center" | none
|-
| MainFile
| The name of entry file for the script.
| align="center" | String
| align="center" | No
| align="center" | main.pas
|-
| Debug
| Whenever script should run in debug mode or not. In debug mode, debug symbols are also compiled and used during runtime. This allows displaying line and unit name in case of exception.
| align="center" | Boolean (1 or 0)
| align="center" | No
| align="center" | 0
|-
| Sandboxed
| Sandbox level for the script. possible values:
* 0: access to entire harddrive
* 1: access restricted to entire soldatserver/ folder
* 2: access restricted to script's data folder (soldatserver/scripts/<script name>/data
This value can be constrained by server.ini file.
| align="center" | Integer
| align="center" | No
| align="center" | 2
|-
| AllowDlls
| Whenever the script is allowed to load external dlls. This value can be constrained by server.ini file.
| align="center" | Boolean (1 or 0)
| align="center" | No
| align="center" | 0
|-
| AllowIniEdit
| Used only if Sandboxed is set to 1. Determinates whenever script is allowed to read/write soldat.ini and server.ini. This value can be constrained by server.ini file.
| align="center" | Boolean (1 or 0)
| align="center" | No
| align="center" | 0
|-
| Gamemod
| Whenever the script is a gamemod. Gamemod script mark server as gamemod server and thus make it displayed as such in the lobby
| align="center" | Boolean (1 or 0)
| align="center" | No
| align="center" | 0
|-
| Legacy
| Whenever the script should run in legacy mode or not. Legacy mode adds all interface and events known from ScriptCore 2. Usfeul for migrating the scripts.
| align="center" | Boolean (1 or 0)
| align="center" | No
| align="center" | 0
|}

Example:
[Config]
Name=My awesome script
MainFile=events.pas
Sandboxed=1
Legacy=1

==SearchPaths==
[SearchPaths] section defines all the folders that should be scanned for unit files. Paths should be delimited by enter, each path in new line. Paths can contain "../" which allows to make script use some "shared" units folder. Paths are relative to script's root folder (soldatserver/scripts/<script name>). They also inherit paths defined in server.ini file, which are also relative to root folder of script they're applied to. Script's root folder is scanned by default, there's no need to add "." search path. <br>
Example:
[SearchPaths]
/players
/players/tasks
/game/
../shared

==Defines==
[Defines] section defines preprocessor constants that should be exported to the script. Besides those defined here, script will also recieve WINDOWS/UNIX constant depending on operating system it runs on. Defines should be enter delimited, each define in new line. Script also inherits all defines defined in server.ini file.<br>
Example:
[Defines]
TEST
DEBUG
FANCY
lowercasedarealsook
[[Category:ScriptCore 3]]

==Example==
Complete file made from this article's example would look like this:
[Config]
Name=My awesome script
MainFile=events.pas
Sandboxed=1
Legacy=1

[SearchPaths]
/players
/players/tasks
/game/
../shared

[Defines]
TEST
DEBUG
FANCY
lowercasedarealsook

SC3 Config File

2013-07-29T12:24:42Z

Falcon: /* Defines */

Config file is divded into three sections: Config, SearchPaths and Defines. First one defines all the basic properties,
2nd paths in which to search all the unit/include files and 3rd pre-defines come preprocessor defines.

==Config==
{| class="wikitable"
|-
! Key !! Description !! Type !! Required !! Default value
|-
| Name
| The name of the script. Appears everywhere in console output that is related to that script (compile messages, exceptions). Must be at most 25 characters long.
| align="center" | String
| align="center" | Yes
| align="center" | none
|-
| MainFile
| The name of entry file for the script.
| align="center" | String
| align="center" | No
| align="center" | main.pas
|-
| Debug
| Whenever script should run in debug mode or not. In debug mode, debug symbols are also compiled and used during runtime. This allows displaying line and unit name in case of exception.
| align="center" | Boolean (1 or 0)
| align="center" | No
| align="center" | 0
|-
| Sandboxed
| Sandbox level for the script. possible values:
* 0: access to entire harddrive
* 1: access restricted to entire soldatserver/ folder
* 2: access restricted to script's data folder (soldatserver/scripts/<script name>/data
This value can be constrained by server.ini file.
| align="center" | Integer
| align="center" | No
| align="center" | 2
|-
| AllowDlls
| Whenever the script is allowed to load external dlls. This value can be constrained by server.ini file.
| align="center" | Boolean (1 or 0)
| align="center" | No
| align="center" | 0
|-
| AllowIniEdit
| Used only if Sandboxed is set to 1. Determinates whenever script is allowed to read/write soldat.ini and server.ini. This value can be constrained by server.ini file.
| align="center" | Boolean (1 or 0)
| align="center" | No
| align="center" | 0
|-
| Gamemod
| Whenever the script is a gamemod. Gamemod script mark server as gamemod server and thus make it displayed as such in the lobby
| align="center" | Boolean (1 or 0)
| align="center" | No
| align="center" | 0
|-
| Legacy
| Whenever the script should run in legacy mode or not. Legacy mode adds all interface and events known from ScriptCore 2. Usfeul for migrating the scripts.
| align="center" | Boolean (1 or 0)
| align="center" | No
| align="center" | 0
|}

Example:
[Config]
Name=My awesome script
MainFile=events.pas
Sandboxed=1
Legacy=1

==SearchPaths==
[SearchPaths] section defines all the folders that should be scanned for unit files. Paths should be delimited by enter, each path in new line. Paths can contain "../" which allows to make script use some "shared" units folder. Paths are relative to script's root folder (soldatserver/scripts/<script name>). They also inherit paths defined in server.ini file, which are also relative to root folder of script they're applied to. Script's root folder is scanned by default, there's no need to add "." search path. <br>
Example:
[SearchPaths]
/players
/players/tasks
/game/
../shared

==Defines==
[Defines] section defines preprocessor constants that should be exported to the script. Besides those defined here, script will also recieve WINDOWS/UNIX constant depending on operating system it runs on. Defines should be enter delimited, each define in new line. Script also inherits all defines defined in server.ini file.<br>
Example
[Defines]
TEST
DEBUG
FANCY
lowercasedarealsook
[[Category:ScriptCore 3]]

==Example==
Complete file made from this article's example would look like this:
[Config]
Name=My awesome script
MainFile=events.pas
Sandboxed=1
Legacy=1

[SearchPaths]
/players
/players/tasks
/game/
../shared

[Defines]
TEST
DEBUG
FANCY
lowercasedarealsook

SC3 Config File

2013-07-29T12:24:30Z

Falcon: /* SearchPaths */

Config file is divded into three sections: Config, SearchPaths and Defines. First one defines all the basic properties,
2nd paths in which to search all the unit/include files and 3rd pre-defines come preprocessor defines.

==Config==
{| class="wikitable"
|-
! Key !! Description !! Type !! Required !! Default value
|-
| Name
| The name of the script. Appears everywhere in console output that is related to that script (compile messages, exceptions). Must be at most 25 characters long.
| align="center" | String
| align="center" | Yes
| align="center" | none
|-
| MainFile
| The name of entry file for the script.
| align="center" | String
| align="center" | No
| align="center" | main.pas
|-
| Debug
| Whenever script should run in debug mode or not. In debug mode, debug symbols are also compiled and used during runtime. This allows displaying line and unit name in case of exception.
| align="center" | Boolean (1 or 0)
| align="center" | No
| align="center" | 0
|-
| Sandboxed
| Sandbox level for the script. possible values:
* 0: access to entire harddrive
* 1: access restricted to entire soldatserver/ folder
* 2: access restricted to script's data folder (soldatserver/scripts/<script name>/data
This value can be constrained by server.ini file.
| align="center" | Integer
| align="center" | No
| align="center" | 2
|-
| AllowDlls
| Whenever the script is allowed to load external dlls. This value can be constrained by server.ini file.
| align="center" | Boolean (1 or 0)
| align="center" | No
| align="center" | 0
|-
| AllowIniEdit
| Used only if Sandboxed is set to 1. Determinates whenever script is allowed to read/write soldat.ini and server.ini. This value can be constrained by server.ini file.
| align="center" | Boolean (1 or 0)
| align="center" | No
| align="center" | 0
|-
| Gamemod
| Whenever the script is a gamemod. Gamemod script mark server as gamemod server and thus make it displayed as such in the lobby
| align="center" | Boolean (1 or 0)
| align="center" | No
| align="center" | 0
|-
| Legacy
| Whenever the script should run in legacy mode or not. Legacy mode adds all interface and events known from ScriptCore 2. Usfeul for migrating the scripts.
| align="center" | Boolean (1 or 0)
| align="center" | No
| align="center" | 0
|}

Example:
[Config]
Name=My awesome script
MainFile=events.pas
Sandboxed=1
Legacy=1

==SearchPaths==
[SearchPaths] section defines all the folders that should be scanned for unit files. Paths should be delimited by enter, each path in new line. Paths can contain "../" which allows to make script use some "shared" units folder. Paths are relative to script's root folder (soldatserver/scripts/<script name>). They also inherit paths defined in server.ini file, which are also relative to root folder of script they're applied to. Script's root folder is scanned by default, there's no need to add "." search path. <br>
Example:
[SearchPaths]
/players
/players/tasks
/game/
../shared

==Defines==
[Defines] section defines preprocessor constants that should be exported to the script. Besides those defined here, script will also recieve WINDOWS/UNIX constant depending on operating system it runs on. Defines should be enter delimited, each define in new line. Script also inherits all defines defined in server.ini file.
Example
[Defines]
TEST
DEBUG
FANCY
lowercasedarealsook
[[Category:ScriptCore 3]]

==Example==
Complete file made from this article's example would look like this:
[Config]
Name=My awesome script
MainFile=events.pas
Sandboxed=1
Legacy=1

[SearchPaths]
/players
/players/tasks
/game/
../shared

[Defines]
TEST
DEBUG
FANCY
lowercasedarealsook

SC3 Config File

2013-07-29T12:23:57Z

Falcon: /* SearchPaths */

Config file is divded into three sections: Config, SearchPaths and Defines. First one defines all the basic properties,
2nd paths in which to search all the unit/include files and 3rd pre-defines come preprocessor defines.

==Config==
{| class="wikitable"
|-
! Key !! Description !! Type !! Required !! Default value
|-
| Name
| The name of the script. Appears everywhere in console output that is related to that script (compile messages, exceptions). Must be at most 25 characters long.
| align="center" | String
| align="center" | Yes
| align="center" | none
|-
| MainFile
| The name of entry file for the script.
| align="center" | String
| align="center" | No
| align="center" | main.pas
|-
| Debug
| Whenever script should run in debug mode or not. In debug mode, debug symbols are also compiled and used during runtime. This allows displaying line and unit name in case of exception.
| align="center" | Boolean (1 or 0)
| align="center" | No
| align="center" | 0
|-
| Sandboxed
| Sandbox level for the script. possible values:
* 0: access to entire harddrive
* 1: access restricted to entire soldatserver/ folder
* 2: access restricted to script's data folder (soldatserver/scripts/<script name>/data
This value can be constrained by server.ini file.
| align="center" | Integer
| align="center" | No
| align="center" | 2
|-
| AllowDlls
| Whenever the script is allowed to load external dlls. This value can be constrained by server.ini file.
| align="center" | Boolean (1 or 0)
| align="center" | No
| align="center" | 0
|-
| AllowIniEdit
| Used only if Sandboxed is set to 1. Determinates whenever script is allowed to read/write soldat.ini and server.ini. This value can be constrained by server.ini file.
| align="center" | Boolean (1 or 0)
| align="center" | No
| align="center" | 0
|-
| Gamemod
| Whenever the script is a gamemod. Gamemod script mark server as gamemod server and thus make it displayed as such in the lobby
| align="center" | Boolean (1 or 0)
| align="center" | No
| align="center" | 0
|-
| Legacy
| Whenever the script should run in legacy mode or not. Legacy mode adds all interface and events known from ScriptCore 2. Usfeul for migrating the scripts.
| align="center" | Boolean (1 or 0)
| align="center" | No
| align="center" | 0
|}

Example:
[Config]
Name=My awesome script
MainFile=events.pas
Sandboxed=1
Legacy=1

==SearchPaths==
[SearchPaths] section defines all the folders that should be scanned for unit files. Paths should be delimited by enter, each path in new line. Paths can contain "../" which allows to make script use some "shared" units folder. Paths are relative to script's root folder (soldatserver/scripts/<script name>). They also inherit paths defined in server.ini file, which are also relative to root folder of script they're applied to. Script's root folder is scanned by default, there's no need to add "." search path.
Example:
[SearchPaths]
/players
/players/tasks
/game/
../shared

==Defines==
[Defines] section defines preprocessor constants that should be exported to the script. Besides those defined here, script will also recieve WINDOWS/UNIX constant depending on operating system it runs on. Defines should be enter delimited, each define in new line. Script also inherits all defines defined in server.ini file.
Example
[Defines]
TEST
DEBUG
FANCY
lowercasedarealsook
[[Category:ScriptCore 3]]

==Example==
Complete file made from this article's example would look like this:
[Config]
Name=My awesome script
MainFile=events.pas
Sandboxed=1
Legacy=1

[SearchPaths]
/players
/players/tasks
/game/
../shared

[Defines]
TEST
DEBUG
FANCY
lowercasedarealsook

SC3 Config File

2013-07-29T12:22:42Z

Falcon:

Config file is divded into three sections: Config, SearchPaths and Defines. First one defines all the basic properties,
2nd paths in which to search all the unit/include files and 3rd pre-defines come preprocessor defines.

==Config==
{| class="wikitable"
|-
! Key !! Description !! Type !! Required !! Default value
|-
| Name
| The name of the script. Appears everywhere in console output that is related to that script (compile messages, exceptions). Must be at most 25 characters long.
| align="center" | String
| align="center" | Yes
| align="center" | none
|-
| MainFile
| The name of entry file for the script.
| align="center" | String
| align="center" | No
| align="center" | main.pas
|-
| Debug
| Whenever script should run in debug mode or not. In debug mode, debug symbols are also compiled and used during runtime. This allows displaying line and unit name in case of exception.
| align="center" | Boolean (1 or 0)
| align="center" | No
| align="center" | 0
|-
| Sandboxed
| Sandbox level for the script. possible values:
* 0: access to entire harddrive
* 1: access restricted to entire soldatserver/ folder
* 2: access restricted to script's data folder (soldatserver/scripts/<script name>/data
This value can be constrained by server.ini file.
| align="center" | Integer
| align="center" | No
| align="center" | 2
|-
| AllowDlls
| Whenever the script is allowed to load external dlls. This value can be constrained by server.ini file.
| align="center" | Boolean (1 or 0)
| align="center" | No
| align="center" | 0
|-
| AllowIniEdit
| Used only if Sandboxed is set to 1. Determinates whenever script is allowed to read/write soldat.ini and server.ini. This value can be constrained by server.ini file.
| align="center" | Boolean (1 or 0)
| align="center" | No
| align="center" | 0
|-
| Gamemod
| Whenever the script is a gamemod. Gamemod script mark server as gamemod server and thus make it displayed as such in the lobby
| align="center" | Boolean (1 or 0)
| align="center" | No
| align="center" | 0
|-
| Legacy
| Whenever the script should run in legacy mode or not. Legacy mode adds all interface and events known from ScriptCore 2. Usfeul for migrating the scripts.
| align="center" | Boolean (1 or 0)
| align="center" | No
| align="center" | 0
|}

Example:
[Config]
Name=My awesome script
MainFile=events.pas
Sandboxed=1
Legacy=1

==SearchPaths==
[SearchPaths] section defines all the folders that should be scanned for unit files. Paths should be delimited by enter, each path in new line. Paths can contain "../" which allows to make script use some "shared" units folder. Paths are relative to script's root folder (soldatserver/scripts/<script name>). They also inherit paths defined in server.ini file, which are also relative to root folder of script they're applied to.
Example:
[SearchPaths]
/players
/players/tasks
/game/
../shared

==Defines==
[Defines] section defines preprocessor constants that should be exported to the script. Besides those defined here, script will also recieve WINDOWS/UNIX constant depending on operating system it runs on. Defines should be enter delimited, each define in new line. Script also inherits all defines defined in server.ini file.
Example
[Defines]
TEST
DEBUG
FANCY
lowercasedarealsook
[[Category:ScriptCore 3]]

==Example==
Complete file made from this article's example would look like this:
[Config]
Name=My awesome script
MainFile=events.pas
Sandboxed=1
Legacy=1

[SearchPaths]
/players
/players/tasks
/game/
../shared

[Defines]
TEST
DEBUG
FANCY
lowercasedarealsook

SC3 Config File

2013-07-29T12:17:17Z

Falcon: /* Example */

Config file is divded into three sections: Config, SearchPaths and Defines. First one defines all the basic properties,
2nd paths in which to search all the unit/include files and 3rd pre-defines come preprocessor defines.

==Config==
{| class="wikitable"
|-
! Key !! Description !! Type !! Required !! Default value
|-
| Name
| The name of the script. Appears everywhere in console output that is related to that script (compile messages, exceptions). Must be at most 25 characters long.
| align="center" | String
| align="center" | Yes
| align="center" | none
|-
| MainFile
| The name of entry file for the script.
| align="center" | String
| align="center" | No
| align="center" | main.pas
|-
| Debug
| Whenever script should run in debug mode or not. In debug mode, debug symbols are also compiled and used during runtime. This allows displaying line and unit name in case of exception.
| align="center" | Boolean (1 or 0)
| align="center" | No
| align="center" | 0
|-
| Sandboxed
| Sandbox level for the script. possible values:
* 0: access to entire harddrive
* 1: access restricted to entire soldatserver/ folder
* 2: access restricted to script's data folder (soldatserver/scripts/<script name>/data
This value can be constrained by server.ini file.
| align="center" | Integer
| align="center" | No
| align="center" | 2
|-
| AllowDlls
| Whenever the script is allowed to load external dlls. This value can be constrained by server.ini file.
| align="center" | Boolean (1 or 0)
| align="center" | No
| align="center" | 0
|-
| AllowIniEdit
| Used only if Sandboxed is set to 1. Determinates whenever script is allowed to read/write soldat.ini and server.ini. This value can be constrained by server.ini file.
| align="center" | Boolean (1 or 0)
| align="center" | No
| align="center" | 0
|-
| Gamemod
| Whenever the script is a gamemod. Gamemod script mark server as gamemod server and thus make it displayed as such in the lobby
| align="center" | Boolean (1 or 0)
| align="center" | No
| align="center" | 0
|-
| Legacy
| Whenever the script should run in legacy mode or not. Legacy mode adds all interface and events known from ScriptCore 2. Usfeul for migrating the scripts.
| align="center" | Boolean (1 or 0)
| align="center" | No
| align="center" | 0
|}

Example:
[Config]
Name=My awesome script
MainFile=events.pas
Sandboxed=1
Legacy=1

==SearchPaths==
[SearchPaths] section defines all the folders that should be scanned for unit files. Paths should be delimited by enter, each path in new line. Paths can contain "../" which allows to make script use some "shared" units folder.
Example:
[SearchPaths]
/players
/players/tasks
/game/
../shared

==Defines==
[Defines] section defines preprocessor constants that should be exported to the script. Besides those defined here, script will also recieve WINDOWS/UNIX constant depending on operating system it runs on. Defines should be enter delimited, each define in new line.
Example
[Defines]
TEST
DEBUG
FANCY
lowercasedarealsook
[[Category:ScriptCore 3]]

==Example==
Complete file made from this article's example would look like this:
[Config]
Name=My awesome script
MainFile=events.pas
Sandboxed=1
Legacy=1

[SearchPaths]
/players
/players/tasks
/game/
../shared

[Defines]
TEST
DEBUG
FANCY
lowercasedarealsook

SC3 Config File

2013-07-29T12:16:46Z

Falcon: /* Config */

Config file is divded into three sections: Config, SearchPaths and Defines. First one defines all the basic properties,
2nd paths in which to search all the unit/include files and 3rd pre-defines come preprocessor defines.

==Config==
{| class="wikitable"
|-
! Key !! Description !! Type !! Required !! Default value
|-
| Name
| The name of the script. Appears everywhere in console output that is related to that script (compile messages, exceptions). Must be at most 25 characters long.
| align="center" | String
| align="center" | Yes
| align="center" | none
|-
| MainFile
| The name of entry file for the script.
| align="center" | String
| align="center" | No
| align="center" | main.pas
|-
| Debug
| Whenever script should run in debug mode or not. In debug mode, debug symbols are also compiled and used during runtime. This allows displaying line and unit name in case of exception.
| align="center" | Boolean (1 or 0)
| align="center" | No
| align="center" | 0
|-
| Sandboxed
| Sandbox level for the script. possible values:
* 0: access to entire harddrive
* 1: access restricted to entire soldatserver/ folder
* 2: access restricted to script's data folder (soldatserver/scripts/<script name>/data
This value can be constrained by server.ini file.
| align="center" | Integer
| align="center" | No
| align="center" | 2
|-
| AllowDlls
| Whenever the script is allowed to load external dlls. This value can be constrained by server.ini file.
| align="center" | Boolean (1 or 0)
| align="center" | No
| align="center" | 0
|-
| AllowIniEdit
| Used only if Sandboxed is set to 1. Determinates whenever script is allowed to read/write soldat.ini and server.ini. This value can be constrained by server.ini file.
| align="center" | Boolean (1 or 0)
| align="center" | No
| align="center" | 0
|-
| Gamemod
| Whenever the script is a gamemod. Gamemod script mark server as gamemod server and thus make it displayed as such in the lobby
| align="center" | Boolean (1 or 0)
| align="center" | No
| align="center" | 0
|-
| Legacy
| Whenever the script should run in legacy mode or not. Legacy mode adds all interface and events known from ScriptCore 2. Usfeul for migrating the scripts.
| align="center" | Boolean (1 or 0)
| align="center" | No
| align="center" | 0
|}

Example:
[Config]
Name=My awesome script
MainFile=events.pas
Sandboxed=1
Legacy=1

==SearchPaths==
[SearchPaths] section defines all the folders that should be scanned for unit files. Paths should be delimited by enter, each path in new line. Paths can contain "../" which allows to make script use some "shared" units folder.
Example:
[SearchPaths]
/players
/players/tasks
/game/
../shared

==Defines==
[Defines] section defines preprocessor constants that should be exported to the script. Besides those defined here, script will also recieve WINDOWS/UNIX constant depending on operating system it runs on. Defines should be enter delimited, each define in new line.
Example
[Defines]
TEST
DEBUG
FANCY
lowercasedarealsook
[[Category:ScriptCore 3]]

==Example==
Complete file made from this site's example would look like this:
[Config]
Name=My awesome script
MainFile=events.pas
Sandboxed=1
Legacy=1

[SearchPaths]
/players
/players/tasks
/game/
../shared

[Defines]
TEST
DEBUG
FANCY
lowercasedarealsook

SC3 Config File

2013-07-29T12:16:09Z

Falcon: /* Config */

Config file is divded into three sections: Config, SearchPaths and Defines. First one defines all the basic properties,
2nd paths in which to search all the unit/include files and 3rd pre-defines come preprocessor defines.

==Config==
{| class="wikitable"
|-
! Key !! Description !! Type !! Required !! Default value
|-
| Name
| The name of the script. Appears everywhere in console output that is related to that script (compile messages, exceptions). Must be at most 25 characters long.
| align="center" | String
| align="center" | Yes
| align="center" | none
|-
| MainFile
| The name of entry file for the script.
| align="center" | String
| align="center" | No
| align="center" | main.pas
|-
| Debug
| Whenever script should run in debug mode or not. In debug mode, debug symbols are also compiled and used during runtime. This allows displaying line and unit name in case of exception.
| align="center" | Boolean (1 or 0)
| align="center" | No
| align="center" | 0
|-
| Sandboxed
| Sandbox level for the script. possible values:
* 0: access to entire harddrive
* 1: access restricted to entire soldatserver/ folder
* 2: access restricted to script's data folder (soldatserver/scripts/<script name>/data
This value can be constrained by server.ini file.
| align="center" | Integer
| align="center" | No
| align="center" | 2
|-
| AllowDlls
| Whenever the script is allowed to load external dlls. This value can be constrained by server.ini file.
| align="center" | Boolean (1 or 0)
| align="center" | No
| align="center" | 0
|-
| AllowIniEdit
| Used only if Sandboxed is set to 1. Determinates whenever script is allowed to read/write soldat.ini and server.ini. This value can be constrained by server.ini file.
| align="center" | Boolean (1 or 0)
| align="center" | No
| align="center" | 0
|-
| Gamemod
| Whenever the script is a gamemod. Gamemod script mark server as gamemod server and thus make it displayed as such in the lobby
| align="center" | Boolean (1 or 0)
| align="center" | No
| align="center" | 0
|-
| Legacy
| Whenever the script should run in legacy mode or not. Legacy mode adds all interface and events known from ScriptCore2. Usfeul for migrating the scripts.
| align="center" | Boolean (1 or 0)
| align="center" | No
| align="center" | 0
|}

Example:
[Config]
Name=My awesome script
MainFile=events.pas
Sandboxed=1
Legacy=1

==SearchPaths==
[SearchPaths] section defines all the folders that should be scanned for unit files. Paths should be delimited by enter, each path in new line. Paths can contain "../" which allows to make script use some "shared" units folder.
Example:
[SearchPaths]
/players
/players/tasks
/game/
../shared

==Defines==
[Defines] section defines preprocessor constants that should be exported to the script. Besides those defined here, script will also recieve WINDOWS/UNIX constant depending on operating system it runs on. Defines should be enter delimited, each define in new line.
Example
[Defines]
TEST
DEBUG
FANCY
lowercasedarealsook
[[Category:ScriptCore 3]]

==Example==
Complete file made from this site's example would look like this:
[Config]
Name=My awesome script
MainFile=events.pas
Sandboxed=1
Legacy=1

[SearchPaths]
/players
/players/tasks
/game/
../shared

[Defines]
TEST
DEBUG
FANCY
lowercasedarealsook

SC3 Config File

2013-07-29T12:15:55Z

Falcon: /* Config */

Config file is divded into three sections: Config, SearchPaths and Defines. First one defines all the basic properties,
2nd paths in which to search all the unit/include files and 3rd pre-defines come preprocessor defines.

==Config==
{| class="wikitable"
|-
! Key !! Description !! Type !! Required !! Default value
|-
| Name
| The name of the script. Appears everywhere in console output that is related to that script (compile messages, exceptions). Must be at most 25 characters long.
| align="center" | String
| align="center" | Yes
| align="center" | none
|-
| MainFile
| The name of entry file for the script.
| align="center" | String
| align="center" | No
| align="center" | main.pas
|-
| Debug
| Whenever script should run in debug mode or not. In debug mode, debug symbols are also compiled and used during runtime. This allows displaying line and unit name in case of exception.
| align="center" | Boolean (1 or 0)
| align="center" | No
| align="center" | 0
|-
| Sandboxed
| Sandbox level for the script. possible values:
* 0: access to entire harddrive
* 1: access resricted to entire soldatserver/ folder
* 2: access restricted to script's data folder (soldatserver/scripts/<script name>/data
This value can be constrained by server.ini file.
| align="center" | Integer
| align="center" | No
| align="center" | 2
|-
| AllowDlls
| Whenever the script is allowed to load external dlls. This value can be constrained by server.ini file.
| align="center" | Boolean (1 or 0)
| align="center" | No
| align="center" | 0
|-
| AllowIniEdit
| Used only if Sandboxed is set to 1. Determinates whenever script is allowed to read/write soldat.ini and server.ini. This value can be constrained by server.ini file.
| align="center" | Boolean (1 or 0)
| align="center" | No
| align="center" | 0
|-
| Gamemod
| Whenever the script is a gamemod. Gamemod script mark server as gamemod server and thus make it displayed as such in the lobby
| align="center" | Boolean (1 or 0)
| align="center" | No
| align="center" | 0
|-
| Legacy
| Whenever the script should run in legacy mode or not. Legacy mode adds all interface and events known from ScriptCore2. Usfeul for migrating the scripts.
| align="center" | Boolean (1 or 0)
| align="center" | No
| align="center" | 0
|}

Example:
[Config]
Name=My awesome script
MainFile=events.pas
Sandboxed=1
Legacy=1

==SearchPaths==
[SearchPaths] section defines all the folders that should be scanned for unit files. Paths should be delimited by enter, each path in new line. Paths can contain "../" which allows to make script use some "shared" units folder.
Example:
[SearchPaths]
/players
/players/tasks
/game/
../shared

==Defines==
[Defines] section defines preprocessor constants that should be exported to the script. Besides those defined here, script will also recieve WINDOWS/UNIX constant depending on operating system it runs on. Defines should be enter delimited, each define in new line.
Example
[Defines]
TEST
DEBUG
FANCY
lowercasedarealsook
[[Category:ScriptCore 3]]

==Example==
Complete file made from this site's example would look like this:
[Config]
Name=My awesome script
MainFile=events.pas
Sandboxed=1
Legacy=1

[SearchPaths]
/players
/players/tasks
/game/
../shared

[Defines]
TEST
DEBUG
FANCY
lowercasedarealsook

SC3 Config File

2013-07-29T12:14:46Z

Falcon: /* Config */

Config file is divded into three sections: Config, SearchPaths and Defines. First one defines all the basic properties,
2nd paths in which to search all the unit/include files and 3rd pre-defines come preprocessor defines.

==Config==
{| class="wikitable"
|-
! Key !! Description !! Type !! Required !! Default value
|-
| Name
| The name of the script. Appears everywhere in console output that is related to that script (compile messages, exceptions). Must be at most 25 characters long.
| align="center" | String
| align="center" | Yes
| align="center" | none
|-
| MainFile
| The name of entry file for the script.
| align="center" | String
| align="center" | No
| align="center" | main.pas
|-
| Debug
| Whenever script should run in debug mode or not. In debug mode, debug symbols are also compiled and used during runtime. This allows displaying line and unit name in case of exception.
| align="center" | Boolean (1 or 0)
| align="center" | No
| align="center" | 0
|-
| Sandboxed
| Sandbox level for the script. possible values:
* 0: access to entire harddrive
* 1: access to entire soldatserver/ folder
* 2: access restricted to script's data folder (soldatserver/scripts/<script name>/data
This value can be constrained by server.ini file.
| align="center" | Integer
| align="center" | No
| align="center" | 2
|-
| AllowDlls
| Whenever the script is allowed to load external dlls. This value can be constrained by server.ini file.
| align="center" | Boolean (1 or 0)
| align="center" | No
| align="center" | 0
|-
| AllowIniEdit
| Used only if Sandboxed is set to 1. Determinates whenever script is allowed to read/write soldat.ini and server.ini. This value can be constrained by server.ini file.
| align="center" | Boolean (1 or 0)
| align="center" | No
| align="center" | 0
|-
| Gamemod
| Whenever the script is a gamemod. Gamemod script mark server as gamemod server and thus make it displayed as such in the lobby
| align="center" | Boolean (1 or 0)
| align="center" | No
| align="center" | 0
|-
| Legacy
| Whenever the script should run in legacy mode or not. Legacy mode adds all interface and events known from ScriptCore2. Usfeul for migrating the scripts.
| align="center" | Boolean (1 or 0)
| align="center" | No
| align="center" | 0
|}

Example:
[Config]
Name=My awesome script
MainFile=events.pas
Sandboxed=1
Legacy=1

==SearchPaths==
[SearchPaths] section defines all the folders that should be scanned for unit files. Paths should be delimited by enter, each path in new line. Paths can contain "../" which allows to make script use some "shared" units folder.
Example:
[SearchPaths]
/players
/players/tasks
/game/
../shared

==Defines==
[Defines] section defines preprocessor constants that should be exported to the script. Besides those defined here, script will also recieve WINDOWS/UNIX constant depending on operating system it runs on. Defines should be enter delimited, each define in new line.
Example
[Defines]
TEST
DEBUG
FANCY
lowercasedarealsook
[[Category:ScriptCore 3]]

==Example==
Complete file made from this site's example would look like this:
[Config]
Name=My awesome script
MainFile=events.pas
Sandboxed=1
Legacy=1

[SearchPaths]
/players
/players/tasks
/game/
../shared

[Defines]
TEST
DEBUG
FANCY
lowercasedarealsook

SC3 Config File

2013-07-29T12:13:49Z

Falcon: /* Example */

Config file is divded into three sections: Config, SearchPaths and Defines. First one defines all the basic properties,
2nd paths in which to search all the unit/include files and 3rd pre-defines come preprocessor defines.

==Config==
{| class="wikitable"
|-
! Key !! Description !! Type !! Required !! Default value
|-
| Name
| The name of the script. Appears everywhere in console output that is related to that script (compile messages, exceptions). Must be at most 25 characters long.
| align="center" | String
| align="center" | Yes
| align="center" | none
|-
| MainFile
| The name of entry file for the script.
| align="center" | String
| align="center" | No
| align="center" | main.pas
|-
| Debug
| Whenever script should run in debug mode or not. In debug mode, debug symbols are also compiled and used during runtime. This allows displaying line and unit name in case of exception.
| align="center" | Boolean (1 or 0)
| align="center" | No
| align="center" | 0
|-
| Sandboxed
| Sandbox level for the script. possible values:
* 0: access to entire harddrive
* 1: access to entire soldatserver/ folder
* 2: access restricted to script's data folder (soldatserver/scripts/<script name>/data
This value can be constrained by server.ini file.
| align="center" | Integer
| align="center" | No
| align="center" | 2
|-
| AllowDlls
| Whenever the script is allowed to load external dlls. This value can be constrained by server.ini file.
| align="center" | Boolean (1 or 0)
| align="center" | No
| align="center" | 0
|-
| AllowIniEdit
| Used only if Sandboxed is set to 1. Determinates whenever script is allowed to read/write soldat.ini and server.ini
| align="center" | Boolean (1 or 0)
| align="center" | No
| align="center" | 0
|-
| Gamemod
| Whenever the script is a gamemod. Gamemod script mark server as gamemod server and thus make it displayed as such in the lobby
| align="center" | Boolean (1 or 0)
| align="center" | No
| align="center" | 0
|-
| Legacy
| Whenever the script should run in legacy mode or not. Legacy mode adds all interface and events known from ScriptCore2. Usfeul for migrating the scripts.
| align="center" | Boolean (1 or 0)
| align="center" | No
| align="center" | 0
|}

Example:
[Config]
Name=My awesome script
MainFile=events.pas
Sandboxed=1
Legacy=1

==SearchPaths==
[SearchPaths] section defines all the folders that should be scanned for unit files. Paths should be delimited by enter, each path in new line. Paths can contain "../" which allows to make script use some "shared" units folder.
Example:
[SearchPaths]
/players
/players/tasks
/game/
../shared

==Defines==
[Defines] section defines preprocessor constants that should be exported to the script. Besides those defined here, script will also recieve WINDOWS/UNIX constant depending on operating system it runs on. Defines should be enter delimited, each define in new line.
Example
[Defines]
TEST
DEBUG
FANCY
lowercasedarealsook
[[Category:ScriptCore 3]]

==Example==
Complete file made from this site's example would look like this:
[Config]
Name=My awesome script
MainFile=events.pas
Sandboxed=1
Legacy=1

[SearchPaths]
/players
/players/tasks
/game/
../shared

[Defines]
TEST
DEBUG
FANCY
lowercasedarealsook

SC3 Config File

2013-07-29T12:13:39Z

Falcon: Added example

Config file is divded into three sections: Config, SearchPaths and Defines. First one defines all the basic properties,
2nd paths in which to search all the unit/include files and 3rd pre-defines come preprocessor defines.

==Config==
{| class="wikitable"
|-
! Key !! Description !! Type !! Required !! Default value
|-
| Name
| The name of the script. Appears everywhere in console output that is related to that script (compile messages, exceptions). Must be at most 25 characters long.
| align="center" | String
| align="center" | Yes
| align="center" | none
|-
| MainFile
| The name of entry file for the script.
| align="center" | String
| align="center" | No
| align="center" | main.pas
|-
| Debug
| Whenever script should run in debug mode or not. In debug mode, debug symbols are also compiled and used during runtime. This allows displaying line and unit name in case of exception.
| align="center" | Boolean (1 or 0)
| align="center" | No
| align="center" | 0
|-
| Sandboxed
| Sandbox level for the script. possible values:
* 0: access to entire harddrive
* 1: access to entire soldatserver/ folder
* 2: access restricted to script's data folder (soldatserver/scripts/<script name>/data
This value can be constrained by server.ini file.
| align="center" | Integer
| align="center" | No
| align="center" | 2
|-
| AllowDlls
| Whenever the script is allowed to load external dlls. This value can be constrained by server.ini file.
| align="center" | Boolean (1 or 0)
| align="center" | No
| align="center" | 0
|-
| AllowIniEdit
| Used only if Sandboxed is set to 1. Determinates whenever script is allowed to read/write soldat.ini and server.ini
| align="center" | Boolean (1 or 0)
| align="center" | No
| align="center" | 0
|-
| Gamemod
| Whenever the script is a gamemod. Gamemod script mark server as gamemod server and thus make it displayed as such in the lobby
| align="center" | Boolean (1 or 0)
| align="center" | No
| align="center" | 0
|-
| Legacy
| Whenever the script should run in legacy mode or not. Legacy mode adds all interface and events known from ScriptCore2. Usfeul for migrating the scripts.
| align="center" | Boolean (1 or 0)
| align="center" | No
| align="center" | 0
|}

Example:
[Config]
Name=My awesome script
MainFile=events.pas
Sandboxed=1
Legacy=1

==SearchPaths==
[SearchPaths] section defines all the folders that should be scanned for unit files. Paths should be delimited by enter, each path in new line. Paths can contain "../" which allows to make script use some "shared" units folder.
Example:
[SearchPaths]
/players
/players/tasks
/game/
../shared

==Defines==
[Defines] section defines preprocessor constants that should be exported to the script. Besides those defined here, script will also recieve WINDOWS/UNIX constant depending on operating system it runs on. Defines should be enter delimited, each define in new line.
Example
[Defines]
TEST
DEBUG
FANCY
lowercasedarealsook
[[Category:ScriptCore 3]]

==Example==
Complete file made from this site's example would look like this:
[Config]
Name=My awesome script
MainFile=events.pas
Sandboxed=1
Legacy=1

[SearchPaths]
/players
/players/tasks
/game/
../shared

[Defines]
TEST
DEBUG
FANCY
lowercasedarealsook

SC3 Config File

2013-07-29T12:12:22Z

Falcon: Added example

Config file is divded into three sections: Config, SearchPaths and Defines. First one defines all the basic properties,
2nd paths in which to search all the unit/include files and 3rd pre-defines come preprocessor defines.

==Config==
{| class="wikitable"
|-
! Key !! Description !! Type !! Required !! Default value
|-
| Name
| The name of the script. Appears everywhere in console output that is related to that script (compile messages, exceptions). Must be at most 25 characters long.
| align="center" | String
| align="center" | Yes
| align="center" | none
|-
| MainFile
| The name of entry file for the script.
| align="center" | String
| align="center" | No
| align="center" | main.pas
|-
| Debug
| Whenever script should run in debug mode or not. In debug mode, debug symbols are also compiled and used during runtime. This allows displaying line and unit name in case of exception.
| align="center" | Boolean (1 or 0)
| align="center" | No
| align="center" | 0
|-
| Sandboxed
| Sandbox level for the script. possible values:
* 0: access to entire harddrive
* 1: access to entire soldatserver/ folder
* 2: access restricted to script's data folder (soldatserver/scripts/<script name>/data
This value can be constrained by server.ini file.
| align="center" | Integer
| align="center" | No
| align="center" | 2
|-
| AllowDlls
| Whenever the script is allowed to load external dlls. This value can be constrained by server.ini file.
| align="center" | Boolean (1 or 0)
| align="center" | No
| align="center" | 0
|-
| AllowIniEdit
| Used only if Sandboxed is set to 1. Determinates whenever script is allowed to read/write soldat.ini and server.ini
| align="center" | Boolean (1 or 0)
| align="center" | No
| align="center" | 0
|-
| Gamemod
| Whenever the script is a gamemod. Gamemod script mark server as gamemod server and thus make it displayed as such in the lobby
| align="center" | Boolean (1 or 0)
| align="center" | No
| align="center" | 0
|-
| Legacy
| Whenever the script should run in legacy mode or not. Legacy mode adds all interface and events known from ScriptCore2. Usfeul for migrating the scripts.
| align="center" | Boolean (1 or 0)
| align="center" | No
| align="center" | 0
|}

Example:
[Config]
Name=My awesome script
MainFile=events.pas
Sandboxed=1
Legacy=1

==SearchPaths==
[SearchPaths] section defines all the folders that should be scanned for unit files. Paths should be delimited by enter, each path in new line. Paths can contain "../" which allows to make script use some "shared" units folder.
Example:
[SearchPaths]
/players
/players/tasks
/game/
../shared

==Defines==
[Defines] section defines preprocessor constants that should be exported to the script. Besides those defined here, script will also recieve WINDOWS/UNIX constant depending on operating system it runs on. Defines should be enter delimited, each define in new line.
Example
[Defines]
TEST
DEBUG
FANCY
lowercasedarealsook
[[Category:ScriptCore 3]]

SC3 Config File

2013-07-29T12:11:18Z

Falcon: /* Defines */

Config file is divded into three sections: Config, SearchPaths and Defines. First one defines all the basic properties,
2nd paths in which to search all the unit/include files and 3rd pre-defines come preprocessor defines.

==Config==
{| class="wikitable"
|-
! Key !! Description !! Type !! Required !! Default value
|-
| Name
| The name of the script. Appears everywhere in console output that is related to that script (compile messages, exceptions)
| align="center" | String
| align="center" | Yes
| align="center" | none
|-
| MainFile
| The name of entry file for the script.
| align="center" | String
| align="center" | No
| align="center" | main.pas
|-
| Debug
| Whenever script should run in debug mode or not. In debug mode, debug symbols are also compiled and used during runtime. This allows displaying line and unit name in case of exception.
| align="center" | Boolean (1 or 0)
| align="center" | No
| align="center" | 0
|-
| Sandboxed
| Sandbox level for the script. possible values:
* 0: access to entire harddrive
* 1: access to entire soldatserver/ folder
* 2: access restricted to script's data folder (soldatserver/scripts/<script name>/data
This value can be constrained by server.ini file.
| align="center" | Integer
| align="center" | No
| align="center" | 2
|-
| AllowDlls
| Whenever the script is allowed to load external dlls. This value can be constrained by server.ini file.
| align="center" | Boolean (1 or 0)
| align="center" | No
| align="center" | 0
|-
| AllowIniEdit
| Used only if Sandboxed is set to 1. Determinates whenever script is allowed to read/write soldat.ini and server.ini
| align="center" | Boolean (1 or 0)
| align="center" | No
| align="center" | 0
|-
| Gamemod
| Whenever the script is a gamemod. Gamemod script mark server as gamemod server and thus make it displayed as such in the lobby
| align="center" | Boolean (1 or 0)
| align="center" | No
| align="center" | 0
|-
| Legacy
| Whenever the script should run in legacy mode or not. Legacy mode adds all interface and events known from ScriptCore2. Usfeul for migrating the scripts.
| align="center" | Boolean (1 or 0)
| align="center" | No
| align="center" | 0
|}

==SearchPaths==
[SearchPaths] section defines all the folders that should be scanned for unit files. Paths should be delimited by enter, each path in new line. Paths can contain "../" which allows to make script use some "shared" units folder.
Example:
[SearchPaths]
/players
/players/tasks
/game/
../shared

==Defines==
[Defines] section defines preprocessor constants that should be exported to the script. Besides those defined here, script will also recieve WINDOWS/UNIX constant depending on operating system it runs on. Defines should be enter delimited, each define in new line.
Example
[Defines]
TEST
DEBUG
FANCY
lowercasedarealsook
[[Category:ScriptCore 3]]