Soldat Community Wiki - User contributions [en]

SC3 Changelog

2020-05-10T08:50:31Z

==Full releases==

{| class="wikitable"
! SoldatServer Version !! Changelog
|-
| 2.8.2 ||
+ Added procedure [[TActivePlayer.RequestDiscordToken]]
+ Added [[TGame.OnSteamAuth]] event
+ Added [[TActivePlayer.SteamID]] and [[TActivePlayer.SteamIDString]] properties
+ Added [[TMath|ScriptMath]] unit
+ Added arctan to SC2
+ Added SC3 [[TActivePlayer.ChangeTeam|TActivePlayer.ChangeTeam(Team, JoinType)]]
+ Added missing [[TActivePlayer.PlaySound]]
+ Added Players.Active[] and Players.Active.Count to SC3
+ Added OnBeforeJoinTeam event to SC3
- Removed TTeam.Add

~ Modified SC3 Player.OnBeforeRespawn now returns spawn position
~ Modified SC3 TTeam.Players[] property to return TActivePlayer instead of TPlayer
~ Modified SC3 TActivePlayer.Dummy is now RW
~ Modified SC3 TActivePlayer.Alive is now read only (R)
~ Modified KickPlayer fails on admin only if it's a ping, flood or vote related kick
~ Modified TPlayer.Health and TPlayer.Vest are RW now
~ Marked SC3 OnTCPCommand as deprecated
~ Moved OnBeforeMapChange event to fire at round end (5s before "real" map switch)

* Fixed SC3 OnLeaveGame giving wrong team parameter, possibly crashing the server
* Fixed SC3 OnAdminCommand sometimes not honoring the result
* Fixed SC3 TActivePlayer.ChangeTeam not honoring Team parameter correctly
* Fixed ForceWeapon function working with wrong Gun objects
* Fixed console executed commands not calling Game.OnAdminCommand in SC3
* Fixed regenerating polygons not calling OnPlayerDamage
* Fixed TActivePlayer.Ping is always 1 #666
|-
| 2.8.1 ||
+ Added [[TActiveBullet.Owner]] property (Read only)
+ Added [[TScript.OnUnhandledException]]

~ Modified [[TPlayer.Alive]], [[TActivePlayer.IsAdmin|IsAdmin]], [[TActivePlayer.Human|Human]] and [[TPlayer.Dummy|Dummy]] properties to also check if player is active and return accordingly.
~ Modified [[TActivePlayer.Deaths]] is now Read-Write
~ Modified [[TScript.OnException]] to be a procedure instead of function
~ Modified SC3 exception handler now unloads the script if exception is thrown
~ Modified SC3 exception handler should output more meaningful messages, even with debug mode off
~ Modified [[TActivePlayer.Kick]], added Reason parameter
~ Modified [[TPlayers.Add]], added JoinType parameter
~ Modified [[TPlayer.Health]] and [[TPlayer.Vest]] are now stored as decimal values
~ Modified [[TPlayer.Health]] type is now Single
~ Modified [[TActivePlayer.OnDamage]] event now accepts Damage parameter as Single instead of Integer, return type changed accordingly

* Fixed issues with SC3 FileAPI sometimes not working properly
* Fixed [[TScript.Unload]] and [[TScript.Recompile]] either not working or crashing
* Fixed SC3 [[TScript.OnException]] message sometimes being empty
* Fixed SC3 [[TActivePlayer.OnKill|OnKill]] provided WeaponID value instead of BulletID
* Fixed [[TActivePlayer.ForceWeapon|ForceWeapon]] sometimes didn't apply ammo
* Fixed [[TActivePlayer.OnVoteKickStart]] crashing when vote started by the server due to cheat detection
* Fixed SC3 script recompilation crashed the server when the new version had compile time errors.
|-
| 2.8.0 ||
+ Added basic conversion functions to SC3: {{link|ScriptCore3|weap2obj}}, {{link|ScriptCore3|menu2obj}}, {{link|ScriptCore3|obj2weap}}, {{link|ScriptCore3|obj2menu}}, {{link|ScriptCore3|weap2menu}}, {{link|ScriptCore3|menu2weap}}
+ Added missing [[TGame.TickCount]] to SC3
+ Added missing [[TActivePlayer.KeyFlagThrow]] to SC3

* Fixed [[TActivePlayer.OnWeaponChange]] was sometimes called too late
* Fixed added missing [[TPlayer.Vest|Vest]] property to SC3 [[TPlayer]]
* Fixed [[TScript.Name]] in SC3 Legacy mode contained full path instead of just folder name
* Fixed unpredictable [[TActivePlayer.OnWeaponChange|OnWeaponChange]] behavior when calling [[TActivePlayer.ForceWeapon|ForceWeapon]] from within
* Fixed wrong player coordinates in [[TActivePlayer.OnAfterRespawn|OnAfterRespawn]] (SC3 only)
* Fixed [[TActivePlayer.OnWeaponChange]] event sometimes called with weird weapon parameters
* Fixed incorrect Weapon being passed to [[TActivePlayer.OnKill]]
* Fixed [[TActivePlayer.Move]] not broadcasted to players when set on bot
* Fixed [[TActivePlayer.SetVelocity]] not broadcasted to players when set on bot
* Fixed [[Random]] function in SC2 producing weird results
* Fixed SC3 sometimes throwing access violations when hitting exception
(most noticable when trying to load non existing dll
|-
| 2.7.9 ||
+ Added SC3 property [[TActivePlayer.IsProne]] (read only - boolean)
+ Added SC3 property [[TActivePlayer.MouseAimX]] (read write - SmallInt) (write only works on bots)
+ Added SC3 property [[TActivePlayer.MouseAimY]] (read write - SmallInt) (write only works on bots)
+ Added SC3 [[TGame.AdminPassword]] property (string - read write)
+ Added SC3 object constants: OBJECT_ALPHA_FLAG, OBJECT_BRAVO_FLAG, OBJECT_POINTMATCH_FLAG,
OBJECT_USSOCOM, OBJECT_DESERT_EAGLE, OBJECT_HK_MP5, OBJECT_AK74, OBJECT_STEYR_AUG, OBJECT_SPAS12,
OBJECT_RUGER77, OBJECT_M79, OBJECT_BARRET_M82A1, OBJECT_MINIMI, OBJECT_MINIGUN, OBJECT_RAMBO_BOW,
OBJECT_MEDICAL_KIT, OBJECT_GRENADE_KIT, OBJECT_FLAMER_KIT, OBJECT_PREDATOR_KIT, OBJECT_VEST_KIT,
OBJECT_BERSERK_KIT, OBJECT_CLUSTER_KIT, OBJECT_PARACHUTE, OBJECT_COMBAT_KNIFE, OBJECT_CHAINSAW,
OBJECT_LAW, OBJECT_STATIONARY_GUN
+ Added SC3 weapon constants: WTYPE_EAGLE, WTYPE_MP5, WTYPE_AK74, WTYPE_STEYRAUG, WTYPE_SPAS12,
WTYPE_RUGER77, WTYPE_M79, WTYPE_BARRETT, WTYPE_M249, WTYPE_MINIGUN, WTYPE_USSOCOM, WTYPE_KNIFE,
WTYPE_CHAINSAW, WTYPE_LAW, WTYPE_FLAMER, WTYPE_BOW, WTYPE_BOW2, WTYPE_M2, WTYPE_NOWEAPON,
WTYPE_FRAGGRENADE, WTYPE_CLUSTERGRENADE, WTYPE_CLUSTER, WTYPE_THROWNKNIFE
+ Added SC3 function [[ScriptCore3.MD5|Md5]](A: string): string;
+ Added SC3 type [[TBannedHW]] = record HW: string; Time: Integer; Reason: string; end;
+ Added SC3 type [[TBannedIP]] = record IP: ShortString; Time: Integer; Reason: string; end;
+ Added SC3 class [[TBanLists]] (accessible over global variable "[[TGame.BanLists|Game.BanLists]]")
+ Added SC3 procedure [[TBanLists.AddHWBan]](HW, Reason: string; Duration: Integer);
+ Added SC3 procedure [[TBanLists.AddIPBan]](IP: ShortString; Reason: string; Duration: Integer);
+ Added SC3 function [[TBanLists.DelHWBan]](HW: string): Boolean;
+ Added SC3 function [[TBanLists.DelIPBan]](IP: ShortString): Boolean;
+ Added SC3 function [[TBanLists.IsBannedHW]](HW: string): Boolean;
+ Added SC3 function [[TBanLists.IsBannedIP]](IP: ShortString): Boolean;
+ Added SC3 function [[TBanLists.GetHWBanId]](HW: string): Integer;
+ Added SC3 function [[TBanLists.GetIPBanId]](IP: ShortString): Integer;
+ Added SC3 property [[TBanLists.HW]] (read only - array of TBannedHW)
+ Added SC3 property [[TBanLists.IP]] (read only - array of TBannedIP)
+ Added SC3 property [[TBanLists.BannedHWCount]]: (read only - Integer)
+ Added SC3 property [[TBanLists.BannedIPCount]] (read only - Integer)

~ Modified modifying velocity of bots to be less laggy
~ Modified MovePlayer function to be less laggy on bots
~ Modified SC3 property [[TActivePlayer.KeyUp]] access mode to read write (write only works on bots)
~ Modified SC3 property [[TActivePlayer.KeyLeft]] access mode to read write (write only works on bots)
~ Modified SC3 property [[TActivePlayer.KeyRight]] access mode to read write (write only works on bots)
~ Modified SC3 property [[TActivePlayer.KeyShoot]] access mode to read write (write only works on bots)
~ Modified SC3 property [[TActivePlayer.KeyJetpack]] access mode to read write (write only works on bots)
~ Modified SC3 property [[TActivePlayer.KeyGrenade]] access mode to read write (write only works on bots)
~ Modified SC3 property [[TActivePlayer.KeyChangeWeap]] access mode to read write (write only works on bots)
~ Modified SC3 property [[TActivePlayer.KeyThrow]] access mode to read write (write only works on bots)
~ Modified SC3 property [[TActivePlayer.KeyReload]] access mode to read write (write only works on bots)
~ Modified SC3 property [[TActivePlayer.KeyCrouch]] access mode to read write (write only works on bots)
~ Modified SC3 property [[TActivePlayer.KeyProne]] access mode to read write (write only works on bots)

* Fixed [[TMap.AddObject]] function had swapped knife and saw
* Fixed votes started via script didn't work properly
* Fixed SC3 property [[TActivePlayer.KeyProne]] returns position instead pressed key
* Fixed SC3 [[TGame.Password]] shows admin password instead of game password #604
* Fixed SC3 [[TGame.Password]] property was read only
* Fixed SC3 joining the game increases sometimes team count by 2 instead of 1
* Fixed SC3 [[TGame.Teams]] [[TTeam.Player|Player]] property returned nil or an error
|-
| 2.7.8 ||
+ Added SC3 function [[ScriptCore3.StrToDateTime|StrToDateTime]](const S: string): TDateTime;
+ Added SC3 event [[TGame.OnTCPCommand]](Ip: string; Port: Word; Command: string): Boolean;
+ Added SC3 event [[TActivePlayer.OnKitPickup]](Player: TActivePlayer; Kit: TActiveMapObject)
+ Added SC3 event [[TActivePlayer.OnFlagDrop]](Player: TActivePlayer; Flag: TActiveFlag; Team: Byte; Thrown: Boolean)
+ Added SC3 procedure [[TActivePlayer.WorldText]](Layer: Byte; Text: string; Delay: Integer; Color: Longint; Scale, X, Y: Single)
+ Added SC3 procedure [[TPlayers.WorldText]](Layer: Byte; Text: string; Delay: Integer; Color: Longint; Scale, X, Y: Single)
+ Added SC3 event [[TGame.OnAdminConnect]](Ip: string; Port: Word)
+ Added SC3 event [[TGame.OnAdminDisconnect]](Ip: string; Port: Word)
+ Added SC3 procedure [[TActivePlayer.SetVelocity]](VelX, VelY: Single)
+ Added SC3 function [[TGame.TOnAdminCommand]](Player: TActivePlayer; Command: string): boolean
+ Added SC3 function [[TGame.TOnTCPMessage]](Ip: string; Port: Word; Text: string): boolean
+ Added SC3 function [[TMap.CreateBulletVector]](A, B: TVector; HitM: Single; sStyle: Byte; Owner: TActivePlayer): Integer
+ Added SC3 function [[TMap.CreateBullet]](X, Y, VelX, VelY, HitM_ Single; sStyle: Byte; Owner: TActivePlayer): Integer
+ Added SC3 function [[Distance]](X1, X2, Y1, Y2: Single): Single
+ Added SC3 property [[TActivePlayer.IsAdmin]] (read write - Boolean)
+ Added SC3 property [[TGame.CurrentMap]] (read only - string)
+ Added SC3 class [[TMapsList]] (accessible over global variable "Game.MapsList")
+ Added SC3 procedure [[TMapsList.AddMap]](Name: string)
+ Added SC3 procedure [[TMapsList.RemoveMap]](Name: string)
+ Added SC3 function [[TMapsList.GetMapIdByName]](Name: string): Integer
+ Added SC3 property [[TMapsList.Map]] (read only - array of string)
+ Added SC3 property [[TMapsList.CurrentMapId]] (read write - Integer)
+ Added SC3 property [[TMapsList.MapsCount]] (read only - Integer)
+ Added SC3 class [[TGlobal]] (accessible over global variable "Global")
+ Added SC3 property [[TGlobal.DateSeparator]] (read write - string)
+ Added SC3 property [[TGlobal.ShortDateFormat]] (read write - string)
+ Added SC3 class [[TActiveMapBullet]] (accessible over global Byte array "Map.Bullets")
+ Added SC3 function [[TActiveMapBullet.GetOwnerWeaponId]]: Integer
+ Added SC3 property [[TActiveMapBullet.ID]] (read only - Byte)
+ Added SC3 property [[TActiveMapBullet.Active]] (read only - Boolean)
+ Added SC3 property [[TActiveMapBullet.X]] (read only - Single)
+ Added SC3 property [[TActiveMapBullet.Y]] (read only - Single)
+ Added SC3 property [[TActiveMapBullet.VelX]] (read only - Single)
+ Added SC3 property [[TActiveMapBullet.VelY]] (read only - Single)

~ Modified SC3 type [[TOnKillEvent]] declaration to procedure(Killer, Victim: TActivePlayer; BulletID: Byte)
~ Modified SC3 type [[TOnTCPMessageEvent]] declaration to procedure(Ip: string; Port: Word; Message: string)
~ Modified request game log line from "IP:PORT requesting game..." to "IP:PORT|HWID requesting game..."
~ Modified SC3 procedure name [[TActivePlayer.Forward]] altered to TActivePlayer.ForwardTo
~ Modified SC3 type [[TOnRequestEvent]] declaration to function(Ip, Hw: string; Port: Word; State: Byte; Forwarded: Boolean; Password: string): Integer
~ Modified SC3 type [[TOnDamageEvent]] declaration to function(Shooter, Victim: TActivePlayer; Damage: Integer; Bullet: TActiveMapBullet): Integer

* Fixed [[TOnWeaponChangeEvent]] does not hold valueable data #582
* Fixed [[TActiveObject]]'s Style is 0 (Flags) #584
* Fixed [[TActivePlayer.OnFlagDrop]] [[TActiveMapObject.ID|Flag.ID]] can't be accessed or duplicates #585
* Fixed [[TActivePlayer.Alive|Player.Alive]] := FALSE deals damage (doesn't always kill) #586
* Fixed [[TActivePlayer.Move]] causes players to drop weapons and flags randomly #142
* Fixed [[TActivePlayer.Move]] randomly kills and respawns player #247
* Fixed Server refuses client if [[TActivePlayer.Move]] is used on connection #587
* Fixed SC3 [[TMapObject.Style]] results to be the same as in wiki
* Fixed SC3 using [[TGame.OnRequest]] crashes server
* Fixed SC3 Variable [[TGame.VotePercent]] is always set up on 0 #532
* Fixed SC3 [[TActivePlayer.Ban]] always bans for 0 minutes #576
* Fixed [[TActivePlayer.OnVoteMap|OnVoteMap]]/[[TActivePlayer.OnVoteMapStart|OnVoteMapStart]]events are not working as intended #550
* Fixed SC3 - [[TActivePlayer.OnWeaponChange]] does not provide changed weapon information #577
* Fixed SC3 - [[TActivePlayer.OnKill]]/[[TActivePlayer.OnDamage]] - WeaponType is unpredictable #356
* Fixed [[TActivePlayer.BigText]] with layer 0 causes WriteConsole behaviour #400
* Fixed SC3 [[ScriptCore3.StrToDate|StrToDate]] doesn't work as intended #401
* Fixed /recompile <script> hangs up admin client #578
* Fixed SC3 Strange [[TMap.RayCast]] values when walking "into" the wall #395
* Fixed SC3 some server crashes after unhandled exception
* Fixed SC3 some function results could be ignored in some cases
|-
|}

==Other versions==

{| class="wikitable"
| 2.7.8.b2 ||
+ event TGame.OnTCPCommand
+ function StrToDateTime

* OnKillEvent declaration changed (Killer, Victim: TActivePlayer; BulletID: Byte)
* TOnTCPMessageEvent declaration changed (Ip: string; Port: Word; Message: string)
* Fixed TOnWeaponChangeEvent does not hold valueable data #582
* Fixed TActiveObject's Style is 0 (Flags) #584
* Fixed Player.Alive := FALSE deals damage (doesn't always kill) #586
* Fixed TPlayer.OnFlagDrop Flag.ID can't be accessed or duplicates #585
* Fixed MovePlayer causes players to drop weapons and flags randomly #142
* Fixed MovePlayer randomly kills and respawns player #247
* Fixed Server refuses client if MovePlayer is used on connection #587
* Fixed SC3 TMapObject.Style results to be the same as in wiki
* Fixed SC3 using TGame.OnRequest crashes server
* Reverted "Modified SC3 type TOnKillEvent declaration changed (Killer, Victim: TActivePlayer; Bullet: TActiveMapBullet)"
|-
|-
| 2.7.8.b1 ||
+ event TActivePlayer.OnKitPickup
+ event TActivePlayer.OnFlagDrop
+ procedure TActivePlayer.WorldText
+ procedure TPlayers.WorldText
+ event TGame.OnAdminConnect
+ event TGame.OnAdminDisconnect
+ procedure TActivePlayer.SetVelocity
+ event TGame.OnAdminCommand
+ event TGame.OnTCPMessage
+ function TMap.CreateBulletVector
+ function TMap.CreateBullet
+ function Distance
+ property TActivePlayer.IsAdmin
+ property TGame.CurrentMap
+ class TMapsList
+ procedure TMapsList.AddMap
+ procedure TMapsList.RemoveMap
+ function TMapsList.GetMapIdByName
+ property TMapsList.Map
+ property TMapsList.CurrentMapId
+ property TMapsList.MapsCount
+ class TGlobal
+ property TGlobal.DateSeparator
+ property TGlobal.ShortDateFormat
+ class TActiveMapBullet
+ function TActiveMapBullet.GetOwnerWeaponId
+ property TActiveMapBullet.ID
+ property TActiveMapBullet.Active
+ property TActiveMapBullet.Style
+ property TActiveMapBullet.X
+ property TActiveMapBullet.Y
+ property TActiveMapBullet.VelX
+ property TActiveMapBullet.VelY

* procedure name TActivePlayer.Forward altered to TActivePlayer.ForwardTo
* TOnRequestEvent declaration changed (+ Hw)
* TOnDamageEvent declaration changed (BulletID: Byte to Bullet: TActiveMapBullet)
* TOnKillEvent declaration changed (BulletID: Byte to Bullet: TActiveMapBullet)
|-
|}

[[Category:ScriptCore_3]]

TGame.OnSteamAuth

2020-05-06T22:48:17Z

H: Created page with " '''''property OnSteamAuth''''' Access mode: RW Event handler type: TOnSteamAuthEvent Event handler declaration: function(PlayerId: Byte; AuthState: Byte): Byte..."

'''''property OnSteamAuth'''''
Access mode: RW
Event handler type: [[TOnSteamAuthEvent]]
Event handler declaration:
function(PlayerId: Byte; AuthState: Byte): Byte;

==Description==
Event property called when when server gets final decision about identity of the steam user, only after receiving this event with value of AuthState set to 0 you can be sure about identity of the player

'''AuthState value can be one of the following:'''
<code>
 
0 Steam has verified the user is online, the ticket is valid and ticket has not been reused. 
1 The user in question is not connected to steam. 
2 The user doesn't have a license for this App ID or the ticket has expired. 
3 The user is VAC banned for this game. 
4 The user account has logged in elsewhere and the session containing the game instance has been disconnected. 
5 VAC has been unable to perform anti-cheat checks on this user. 
6 The ticket has been canceled by the issuer. 
7 This ticket has already been used, it is not valid. 
8 This ticket is not from a user instance currently connected to steam. 
9 The user is banned for this game. The ban came via the web api and not VAC. 
</code>

<syntaxhighlight lang="pascal">
function OnSteamAuth(PlayerId: Byte; AuthState: Byte): Byte;
begin
if AuthState = 0 then
begin
// Logged in
end else
// Not logged
end;

// ...

begin
// assign OnSteamAuth handler
Game.OnSteamAuth := @OnSteamAuth;

end;
</syntaxhighlight>
[[Category:TGame]][[Category:Events]]

TGame

2020-05-06T22:39:05Z

==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.AdminPassword|AdminPassword]]: string
| align="center" | RW || 2.7.9
|-
| 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.BanLists|BanLists]]: [[TBanLists]]
| align="center" | R
| 2.7.9
|-
| 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
|-
| property [[TGame.OnSteamAuth|OnSteamAuth]]: [[TOnSteamAuthEvent]]
| align="center" | RW
| 2.8.2 steam version
|-
|}

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

Server.ini

2020-05-06T22:34:13Z

Server.ini file was added in version 2.6.1, by EnEsCe. New settings can be found and adjusted in this file, such as enabling or disabling scripting, using health cooldown, etc. Like [[soldat.ini]], you can edit this file with any plain editor such as Nano or Notepad.

==For Dedicated Servers only==

'''[GAME]'''
TKWarnings_Before_TempBan=5 {{Comment|Number of teamkills that needs to be done before a temporary ban is handed out. Only with PunishTK set to 1.}}
PunishTK=0 {{Comment|Enables/disables the built-in TK punish feature.}}
EchoKills=1 {{Comment|Echoes kills done to the admin console.}}
BotBalanceTeams=0 {{Comment|Whether or not bots should count as players in the team balance.}}
HealthCooldown=0 {{Comment|Amount of time (in seconds) a player needs to wait before s/he's able to pick up a second medikit. Use 0 to disable.}}
TimestampConsole=0 {{Comment|If the console should be timestamped or not.}}
AutoRecord=1 {{Comment|Disable/Enable auto recording demos. (Since 2.8.2)}}
SlowTickWarning=30 {{Comment| Show performance warning when server a server tick takes too much time. (Since 2.8.2)}}
SteamIDAsHWID=1 {{Comment| Overrides HWID of the player with his SteamID. (Since 2.8.2, Steam version)}}
[[Logging|OldLogFilesFormat=0]] {{Comment|Uses the old filename format for log files. 0 for timestamped lognames, 1 for numeric auto-increasing filenames.}}

'''[NETWORK]'''
NR-Service=0 {{Comment|Enables/disables the [[NR Service|Nickname Registration Service]], by EnEsCe.}}
NR-OnlyAllowRegistered=0 {{Comment|Only allows nicknames registered with the [[NR Service]].}}
MaxAdminConnections=20 {{Comment|Maximum number of admins connections that can be opened to the server.}}
AntiMassFlag=1 {{Comment|Anti-massflag cheat on/off}}
Scripting=0 {{Comment|Enables/disables [[Server_Scripting|Server scripting]].}}
BEBanTime=5 {{Comment|The ban time for a [[BattlEye|BE]] violation, in minutes.}}
OnScriptCrash=ignore {{Comment|What action to take when a script crashes. Available parameters are recompile, shutdown, ignore and disable.}}

==UDP Log forwarding==
How it works: Server will send UDP packets in this format <code>%PREFIX %TIME(yy/mm/dd hh:nn:ss) %LOGMSG \r\n</code> every time a new log message occurs, this means 1 packet contains only 1 log entry. Be aware UDP packets can be lost in transit or come in wrong order.

'''[Forwarder1]''' {{Comment| Section name needs to be unique and start with " Forwarder" }}
IP=127.0.0.1 {{Comment| IP address of the server that will receive logs}}
Port=8000 {{Comment| Server Port}}
Prefix=CTF1 {{Comment| Prefix that will be appended to logs}}
[Forwarder2]
IP=192.168.0.1
Port=7000
Prefix=CTF1
[[Category:Server]]

TPlayers.Active

2020-05-06T22:14:00Z

H: Created page with " '''''property Active[i: Byte]: TActivePlayer''''' i: ID of a player. '''0'''-31 Access mode: R ==Description== An Array representing ACTIVE players in game ==Exa..."

'''''property Active[i: Byte]: [[TActivePlayer]]'''''
i: ID of a player. '''0'''-31
Access mode: R
==Description==
An Array representing ACTIVE players in game 

==Example==
<syntaxhighlight lang="pascal">
var
i: byte;
begin
for i := 0 to Players.Active.Count - 1 do begin
Players.WriteConsole('Nick: '+Players.Active[i].Name+', ID: '+inttostr(Players.Active[i].ID), $FFFFFF);
WriteLn('Nick: '+Players.Active[i].Name+', ID: '+inttostr(Players.Active[i].ID));
end;
end;
</syntaxhighlight>
[[Category:TPlayers]]

TPlayers

2020-05-06T22:12:28Z

==Inheritance==
*[[TPlayers]]

==Description==
Allows interaction with players and provides some identification functions

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

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

==Members==
{| class="wikitable"
|-
! Member declaration !! Access mode !! SS Version
|-
| function [[TPlayers.Add|Add]](Player: [[TNewPlayer]]): [[TActivePlayer]]
|
|-
| procedure [[TPlayers.WriteConsole|WriteConsole]](Text: string; Color: Longint)
|
|-
| procedure [[TPlayers.BigText|BigText]](Layer: Byte; Text: string; Delay: Integer; Color: Longint; Scale: Single; X, Y: Integer)
|
|-
| function [[TPlayers.GetByName|GetByName]](Name: string): [[TActivePlayer]]
|
|-
| function [[TPlayers.GetByIP|GetByIP]](IP: string): [[TActivePlayer]]
|
|-
| procedure [[TPlayers.Tell|Tell]](Text: string)
|
|-
| procedure [[TPlayers.WorldText|WorldText]](Layer: Byte; Text: string; Delay: Integer; Color: Longint; Scale, X, Y: Single)
|
| 2.7.8.b1
|-
| colspan="2" |
|-
| property [[TPlayers.Player|Player]][i: Byte]: [[TActivePlayer]]
| align="center" | R
|
| default
|-
|-
| property [[TPlayers.Active|Active]][i: Byte]: [[TActivePlayer]]
| align="center" | R
|
| default
|-
|}

[[Category:Classes]]

TMath

2020-05-06T22:10:10Z

==Inheritance==
*[[TMath]]

==Description==
A class holding all functions related to Math. 
'''This class is assigned to global variable "[[Global_Variables.Math|Math]]"'''

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

==Members==
{| class="wikitable"
|-
! Member declaration
|-
| function [[TMath.Sin|Sin]](A: Extended): Extended
|-
| function [[TMath.Cos|Cos]](A: Extended): Extended
|-
| function [[TMath.Tan|Tan]](A: Extended): Extended
|-
| function [[TMath.Cotan|Cotan]](A: Extended): Extended
|-
| function [[TMath.Pow|Pow]](A, B: Extended): Extended
|-
| function [[TMath.LogN|LogN]](A, B: Extended): Extended
|-
| function [[TMath.Ln|Ln]](A: Extended): Extended
|-
| function [[TMath.ArcSin|ArcSin]](A: Extended): Extended
|-
| function [[TMath.ArcCos|ArcCos]](A: Extended): Extended
|-
| function [[TMath.ArcTan|ArcTan]](A: Extended): Extended
|-
| function [[TMath.ArcCotan|ArcCotan]](A: Extended): Extended
|-
| function [[TMath.ArcTan2|ArcTan]](A,B: Extended): Extended
|-
| function [[TMath.Min|Min]](A, B: Extended): Extended
|-
| function [[TMath.Max|Max]](A, B: Extended): Extended
|-
| function [[TMath.Abs|Abs]](A: Extended): Extended
|-
| function [[TMath.Exp|Exp]](A: Extended): Extended
|-
| function [[TMath.Sign|Sign]](A: Extended): Extended
|-
| function [[TMath.IsNan|IsNan]](A: Extended): Boolean
|-
| function [[TMath.Round|Round]](A: Extended): Integer
|-
| function [[TMath.RoundTo|RoundTo]](A: Extended, B: TRoundToRange): Extended
|-
| function [[TMath.DegToRad|DegToRad]](A: Extended): Extended
|-
| function [[TMath.RadToDeg|RadToDeg]](A: Extended): Extended
|-
| function [[TMath.DegNormalize|DegNormalize]](A: Extended): Extended
|-
| function [[TMath.InRange|InRange]](const A, B, C: Double): Boolean
|-
| function [[TMath.EnsureRange|EnsureRange]](const AValue, AMin, AMax: Double): Double
|-
| function [[TMath.Random|Random]](Min, Max: Extended): Extended
|-
| property [[TMath.E]]: Extended
|-
| property [[TMath.Pi]]: Extended
|-
|}

[[Category:Classes]]

Global Variables.Math

2020-05-06T22:09:59Z

H: Created page with " '''''Math: TMath''''' ==Description== {| class=wikitable ! Variable Name !! Type |- | align=center | Math || TMath |- |} Global variable used for math operations [..."

'''''Math: [[TMath]]'''''

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

Global variable used for math operations [[TMath]]

[[Category:Global Variables]]

TMath

2020-05-06T22:08:34Z

==Inheritance==
*[[TMathApi]]

==Description==
A class holding all functions related to Math. 
'''This class is assigned to global variable "[[Global_Variables.Math|Math]]"'''

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

==Members==
{| class="wikitable"
|-
! Member declaration
|-
| function [[TMath.Sin|Sin]](A: Extended): Extended
|-
| function [[TMath.Cos|Cos]](A: Extended): Extended
|-
| function [[TMath.Tan|Tan]](A: Extended): Extended
|-
| function [[TMath.Cotan|Cotan]](A: Extended): Extended
|-
| function [[TMath.Pow|Pow]](A, B: Extended): Extended
|-
| function [[TMath.LogN|LogN]](A, B: Extended): Extended
|-
| function [[TMath.Ln|Ln]](A: Extended): Extended
|-
| function [[TMath.ArcSin|ArcSin]](A: Extended): Extended
|-
| function [[TMath.ArcCos|ArcCos]](A: Extended): Extended
|-
| function [[TMath.ArcTan|ArcTan]](A: Extended): Extended
|-
| function [[TMath.ArcCotan|ArcCotan]](A: Extended): Extended
|-
| function [[TMath.ArcTan2|ArcTan]](A,B: Extended): Extended
|-
| function [[TMath.Min|Min]](A, B: Extended): Extended
|-
| function [[TMath.Max|Max]](A, B: Extended): Extended
|-
| function [[TMath.Abs|Abs]](A: Extended): Extended
|-
| function [[TMath.Exp|Exp]](A: Extended): Extended
|-
| function [[TMath.Sign|Sign]](A: Extended): Extended
|-
| function [[TMath.IsNan|IsNan]](A: Extended): Boolean
|-
| function [[TMath.Round|Round]](A: Extended): Integer
|-
| function [[TMath.RoundTo|RoundTo]](A: Extended, B: TRoundToRange): Extended
|-
| function [[TMath.DegToRad|DegToRad]](A: Extended): Extended
|-
| function [[TMath.RadToDeg|RadToDeg]](A: Extended): Extended
|-
| function [[TMath.DegNormalize|DegNormalize]](A: Extended): Extended
|-
| function [[TMath.InRange|InRange]](const A, B, C: Double): Boolean
|-
| function [[TMath.EnsureRange|EnsureRange]](const AValue, AMin, AMax: Double): Double
|-
| function [[TMath.Random|Random]](Min, Max: Extended): Extended
|-
| property [[TMath.E]]: Extended
|-
| property [[TMath.Pi]]: Extended
|-
|}

[[Category:Classes]]

TMath

2020-05-06T22:07:40Z

H: Created page with "==Inheritance== *TMathApi ==Description== A class holding all functions related to Math. One object of this class is exported under global variable called '''Globa..."

==Inheritance==
*[[TMathApi]]

==Description==
A class holding all functions related to Math. 
One object of this class is exported under global variable called '''[[Global_Variables.Math|Math]]'''.

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

==Members==
{| class="wikitable"
|-
! Member declaration
|-
| function [[TMath.Sin|Sin]](A: Extended): Extended
|-
| function [[TMath.Cos|Cos]](A: Extended): Extended
|-
| function [[TMath.Tan|Tan]](A: Extended): Extended
|-
| function [[TMath.Cotan|Cotan]](A: Extended): Extended
|-
| function [[TMath.Pow|Pow]](A, B: Extended): Extended
|-
| function [[TMath.LogN|LogN]](A, B: Extended): Extended
|-
| function [[TMath.Ln|Ln]](A: Extended): Extended
|-
| function [[TMath.ArcSin|ArcSin]](A: Extended): Extended
|-
| function [[TMath.ArcCos|ArcCos]](A: Extended): Extended
|-
| function [[TMath.ArcTan|ArcTan]](A: Extended): Extended
|-
| function [[TMath.ArcCotan|ArcCotan]](A: Extended): Extended
|-
| function [[TMath.ArcTan2|ArcTan]](A,B: Extended): Extended
|-
| function [[TMath.Min|Min]](A, B: Extended): Extended
|-
| function [[TMath.Max|Max]](A, B: Extended): Extended
|-
| function [[TMath.Abs|Abs]](A: Extended): Extended
|-
| function [[TMath.Exp|Exp]](A: Extended): Extended
|-
| function [[TMath.Sign|Sign]](A: Extended): Extended
|-
| function [[TMath.IsNan|IsNan]](A: Extended): Boolean
|-
| function [[TMath.Round|Round]](A: Extended): Integer
|-
| function [[TMath.RoundTo|RoundTo]](A: Extended, B: TRoundToRange): Extended
|-
| function [[TMath.DegToRad|DegToRad]](A: Extended): Extended
|-
| function [[TMath.RadToDeg|RadToDeg]](A: Extended): Extended
|-
| function [[TMath.DegNormalize|DegNormalize]](A: Extended): Extended
|-
| function [[TMath.InRange|InRange]](const A, B, C: Double): Boolean
|-
| function [[TMath.EnsureRange|EnsureRange]](const AValue, AMin, AMax: Double): Double
|-
| function [[TMath.Random|Random]](Min, Max: Extended): Extended
|-
| property [[TMath.E]]: Extended
|-
| property [[TMath.Pi]]: Extended
|-
|}

[[Category:Classes]]

TActivePlayer.OnBeforeRespawn

2020-05-06T21:57:27Z

'''''property OnBeforeRespawn'''''
Access mode: RW
Event handler type: [[TOnBeforeRespawnEvent]]
Event handler declaration: function (Player: TActivePlayer): TVector;

==Description==
Event property called right before a player has respawned. 
In this event Player.Alive is FALSE (unless he's just joined the server)

== Example ==
<syntaxhighlight lang="pascal">
// Result is the position you want from player to be spawned on, for default player spawns at spawnpoint
function OnBeforeRespawn(Player: TActivePlayer): TVector;
begin
Result.X := 500;
Result.Y := 30;
end;
</syntaxhighlight>

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

TGame.OnAdminCommand

2020-05-06T21:54:13Z

'''''property OnAdminCommand'''''
Access mode: RW
Event handler type: [[TOnAdminCommandEvent]]
Event handler declaration:
function ('''Player''': [[TActivePlayer]]; '''Command''': string): boolean

==Description==
Event property called when an '''ingame''' admin enters a command. 

Since 2.8.2 Player is '''nil''' if the command comes from the tcp admin.

To disable the command used set the function's Result to ''TRUE''.

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

TTeam.OnBeforeJoin

2020-05-06T21:52:19Z

H: Created page with " '''''property OnBeforeJoin''''' Access mode: RW Event handler type: TOnBeforeJoinTeamEvent Event handler declaration: function (Player: TActivePlayer; Team,OldT..."

'''''property OnBeforeJoin'''''
Access mode: RW
Event handler type: [[TOnBeforeJoinTeamEvent]]
Event handler declaration: function (Player: [[TActivePlayer]]; Team,OldTeam: [[TTeam]]): ShortInt;

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

==Example==
<syntaxhighlight lang="pascal">
function OnBeforeJoin(Player: TActivePlayer; Team, OldTeam: TTeam): ShortInt;
begin
if Team.ID = 2 then //Lock Bravo team
Result := -1
else
Result := Team.ID;

if OldTeam <> nil then
Player.WriteConsole(inttostr(Team.ID)+', Old: '+inttostr(OldTeam.ID), $FFFFFF);
end;

// ...

begin
// assign OnBeforeJoinTeam handler
Game.Teams[2].OnBeforeJoin := @OnBeforeJoin;

// ...

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

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

TOnBeforeJoinTeamEvent

2020-05-06T21:51:12Z

==Description==
Type used by [[TTeam.OnBeforeJoin]] as an event handler type.

[[Category:Types]]

==Declaration==
function (Player: [[TActivePlayer]]; Team, OldTeam: [[TTeam]]): ShortInt
Player: player joining team
OldTeam: Current team
Team: target team
Result: Overrides team selection, set to -1 to block the change

TOnBeforeJoinTeamEvent

2020-05-06T21:49:19Z

TOnBeforeJoinTeamEvent

2020-05-06T21:48:12Z

H: Created page with "==Description== Type used by TTeam.OnBeforeJoin as an event handler type. Category:Types ==Declaration== function (Player: TActivePlayer; Team, OldTeam: TTea..."

TTeam

2020-05-06T21:47:24Z

==Inheritance==
*[[TTeam]]

==Description==
Represents a team of players

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

==Members==
{| class="wikitable"
|-
! Member declaration !! Access mode
|-
| procedure [[TTeam.Add|Add]](Player: [[TPlayer]])
|
|-
| colspan="2" |
|-
| property [[TTeam.Score|Score]]: Byte
| align="center" | RW
|-
| property [[TTeam.Player|Player]][i: Byte]: [[TPlayer]]
| align="center" | R
| default
|-
| property [[TTeam.Count|Count]]: Byte
| align="center" | R
|-
| property [[TTeam.ID|ID]]: Byte
| align="center" | R
|-
| property [[TTeam.OnBeforeJoin|OnBeforeJoin]]: [[TOnBeforeJoinTeamEvent]]
| align="center" | RW
|-
| property [[TTeam.OnJoin|OnJoin]]: [[TOnJoinTeamEvent]]
| align="center" | RW
|-
| property [[TTeam.OnJoin|OnLeave]]: [[TOnLeaveTeamEvent]]
| align="center" | RW
|-
|}

[[Category:Classes]]

TActivePlayer.SteamIDString

2020-05-06T21:43:34Z

H: Created page with " '''''property TActivePlayer.SteamIDString: String''''' Access mode: R ==Description== A player's SteamID in custom string format ('S' + Steam Account Number). Available onl..."

'''''property TActivePlayer.SteamIDString: String'''''
Access mode: R
==Description==
A player's SteamID in custom string format ('S' + Steam Account Number). Available only in the steam version of soldatserver.

[[Category:TActivePlayer]]

TActivePlayer.SteamID

2020-05-06T21:40:37Z

H: Created page with " '''''property TActivePlayer.SteamID: int64''''' Access mode: R ==Description== A player's SteamID. Available only in the steam version of soldatserver. Category:TActive..."

'''''property TActivePlayer.SteamID: int64'''''
Access mode: R
==Description==
A player's SteamID. Available only in the steam version of soldatserver.

[[Category:TActivePlayer]]

TActivePlayer.RequestDiscordToken

2020-05-06T21:38:57Z

H: Created page with " '''''procedure RequestDiscordToken''''' ==Description== Sends a request to retrieve player's discord OAuth2 token, on a successful call server will receive a /discord_token c..."

'''''procedure RequestDiscordToken'''''
==Description==
Sends a request to retrieve player's discord OAuth2 token, on a successful call server will receive a /discord_token command with the token.

This request works only on players who are using the desktop version of Discord.

== Example ==
<syntaxhighlight lang="pascal">

procedure OnJoin(Player: TActivePlayer; Team: TTeam);
begin
Player.RequestDiscordToken;
end;

function OnCommand(Player: TActivePlayer; Command: string): Boolean;
var
Token: String;
begin
if Copy(Command, 1, 15) = '/discord_token ' then
begin
Token := Copy(Command, 16, Length(Command));
// Use 3rdparty library to call and parse response from discord api
// Curl bash example: curl -H 'Authorization: Bearer TOKEN' https://discordapp.com/api/users/@me
end;
end;

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

[[Category:TActivePlayer]]

TActivePlayer.PlaySound

2020-05-06T21:18:44Z

H: Created page with " '''''procedure PlaySound(Name: string; X, Y: Single)''''' Name: Name of the sound file X,Y: Sound position ==Description== Plays a specified sound file == Example == <sy..."

'''''procedure PlaySound(Name: string; X, Y: Single)'''''
Name: Name of the sound file
X,Y: Sound position
==Description==
Plays a specified sound file

== Example ==
<syntaxhighlight lang="pascal">
Player.PlaySound('burn.wav', Player.X, Player.Y);
</syntaxhighlight>

[[Category:TActivePlayer]]

TActivePlayer.ChangeTeam

2020-05-06T21:16:34Z

H: Created page with " '''''procedure ChangeTeam(NewTeam: Byte; JoinType: TJoinType)''''' NewTeam: ID of new team (0-5) JoinType: TJoinType ==Description== Moves player to a specified t..."

'''''procedure ChangeTeam(NewTeam: Byte; JoinType: [[TJoinType]])'''''
NewTeam: ID of new team (0-5)
JoinType: [[TJoinType]]
==Description==
Moves player to a specified team

== Example ==
<syntaxhighlight lang="pascal">
Players[1].ChangeTeam(1, TJoinNormal); // Moves player with ID 1 to Alpha team

Players[2].ChangeTeam(1, TJoinSilent); // Moves player with ID 2 to Bravo team and hides join message ("has joined bravo team")
</syntaxhighlight>

[[Category:TActivePlayer]]

TActivePlayer

2020-05-06T21:10:11Z

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

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

user constructable: '''NO''' 
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]](Reason: TKickReason): 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
|-
| procedure [[TActivePlayer.RequestDiscordToken|RequestDiscordToken]] || || || 2.8.2
|-
| procedure [[TActivePlayer.PlaySound|PlaySound]](Name: string; X, Y: Single) || || || 2.8.2
|-
| procedure [[TActivePlayer.ChangeTeam|ChangeTeam]](NewTeam: Byte; JoinType: TJoinType) || || || 2.8.2
|-
| colspan="3" |
|-
| property [[TPlayer.Name|Name]]: string || align="center" | R || align="center" | yes
|-
| property [[TPlayer.Health|Health]]: Single || align="center" | RW || align="center" | yes || writable since 2.8.2
|-
| property [[TPlayer.Vest|Vest]]: Single || align="center" | RW || align="center" | yes || writable since 2.8.2
|-
| 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" | RW || align="center" | yes || writable since 2.8.2
|-
| 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" | R || 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.IsProne|IsProne]]: Boolean || align="center" | R || align="center" | no || 2.7.9
|-
| 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.SteamID|SteamID]]: Int64 || align="center" | R || align="center" | no || 2.8.2
|-
| property [[TActivePlayer.SteamIDString|SteamIDString]]: string || align="center" | R || align="center" | no || 2.8.2
|-
| 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.KeyFlagThrow|KeyFlagThrow]]: Boolean || align="center" | ?? || align="center" | no || 2.8.0
|-
| 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.MouseAimX|MouseAimX]]: SmallInt || align="center" | RW* || align="center" | no || 2.7.9
|-
| property [[TActivePlayer.MouseAimY|MouseAimY]]: SmallInt || align="center" | RW* || align="center" | no || 2.7.9
|-
| 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]]

Soldat on macOS and Linux

2020-04-28T20:21:12Z

[[File:Macoslinux.png|right]]
=macOS=
==Experimental native macOS build==
A native, experimental version of Soldat on macOS is available for download at https://update.soldat.pl/updates/soldatlauncher-0.1.0.dmg

How to install:

# Download and open ''soldatlauncher-0.1.0.dmg''
# Move ''soldatlauncher'' to ''Applications''.
# Open ''Finder'', go to ''Applications'' and search for '''soldatlauncher'''

Be warned: This version lacks a fully-featured game menu and is not officially supported.

==Introduction==
Running Soldat 1.7.1 on macOS (High Sierra) Tutorial by '''aveh'''.

'''The setup might not always be such straightforward, and Mac-specwise, Wine -version may need to be different in some cases. Making changes through PlayOnMac UI is rather simple and user-friendly.'''

==Installation==
[[File:MacOS Playonmac.png|right|thumb|PlayOnMac Application]][[File:MacOS Opentheapp.png|right|thumb|PlayOnMac Application]]
# Download '''PlayOnMac''' ([https://www.playonmac.com/en/download.html Link]).
# Launch and install the program.
# Inside '''PlayOnMac''' click Install a program, and search for Soldat. It will start installing dependencies, click on Install on these. Then It'll automatically download ''SoldatSetup.exe'' from [http://soldat.pl soldat.pl] and begin Soldat installation automatically.
# During the installation click '''''next''''' (do not configure anything on this step).
# Install to default path is '''''C:\Soldat''''' (do not change).
# Wait for the installation to finish and then edit [[Settings#Config.exe Settings|Config.exe]] to the preferred options for your setup.
# Open Soldat only through the '''PlayOnMac''' interface instead of the automatically made desktop icon.

==Notes==
* To remove mouse acceleration and make mouse feel "Windows-like" ([https://www.reddit.com/r/MouseReview/comments/7bg0n1/removing_mouse_acceleration_in_macos_and_osx_high/ Link]).
* To remove macOS's "Shake mouse pointer to locate", go to '''''System Preferences > Accessibility > Display''''', and un-check the Shake mouse pointer to locate box. [ ]
* '''PlayOnMac''' instructs to install XQuartz (instead of using X11), this might cause in-game lag (it will ask every time you open '''PlayOnMac''', just ignore it).
* To edit ''[[Profiles and Taunts|taunts.txt]] / [[Soldat.ini|soldat.ini]]'' to your personal preference, open '''PlayOnMac''', secondary click on Soldat and select "Open the application's directory". This will open the Soldat directory.

==Setup specifications used in this guide==
###
####
###
####### #######
###################### Distro: OS X 10.13.4 (High Sierra)
##################### CPU: Intel Core i5-4690 CPU @ 3.50GHz
#################### GPU: AMD Radeon R9 285X 2GB
#################### Memory: 8 GB
#####################
######################
####################
################
#### #####

=Linux=
==Experimental native Linux build==
A native, experimental version of Soldat on Linux is available for download at https://update.soldat.pl/updates/soldat_linux.zip

How to install:

# Download and unzip ''soldat_linux.zip''
# Run ''soldatlauncher-0.1.0.AppImage''

Be warned: This version lacks a fully-featured game menu and is not officially supported.

==Introduction==
Running Soldat 1.7.1 on Linux Tutorial by '''SyavX'''.

==Installation==
Fairly similar to the steps for macOS, but with [https://www.playonlinux.com/en/download.html PlayOnLinux]. However, it might be necessary to enable Video Compatibility in Config.exe in case the visuals are not loading properly, or getting an "Access violation" error after entering the game.

In order to open config.exe you'll have to click on the Soldat application configure button, and there switch to "Other"/"Misc" tab, then click on "Run .exe on this virtual drive".

Inside config.exe go to "More" Tab and check the video compatibility box.

==Setup specifications used in this guide==
Distro: Xubuntu 17.10