Difference between revisions of "TGame"

From Soldat Community Wiki
Jump to: navigation, search
m (Description)
 
(10 intermediate revisions by 3 users not shown)
Line 5: Line 5:
 
Represents a game state and configuration.
 
Represents a game state and configuration.
  
  '''This class is assigned to global variable "Game"'''
+
  '''This class is assigned to global variable "[[Global_Variables.Game|Game]]"'''
  
 
  user constructable: '''NO'''
 
  user constructable: '''NO'''
Line 11: Line 11:
  
 
==Members==
 
==Members==
<code>
+
{| class="wikitable"
  <table>
+
|-
  <tr><th>Member declaration</th><th>Access mode</th></tr>
+
! Member declaration !! Access mode !! SS Version
  <tr><td>procedure [[TGame.Shutdown|Shutdown]]</td></tr>
+
|-
  <tr><td>procedure [[TGame.StartVoteKick|StartVoteKick]](ID: Byte; Reason: string)</td></tr>
+
| procedure [[TGame.Shutdown|Shutdown]]
  <tr><td>procedure [[TGame.StartVoteMap|StartVoteMap]](Name: string)</td></tr>
+
| align="center" |
  <tr><td>procedure [[TGame.Restart|Restart]]</td></tr>
+
|-
  <tr><td>function [[TGame.LoadWeap|LoadWeap]](WeaponMod: string): Boolean</td></tr>
+
| procedure [[TGame.StartVoteKick|StartVoteKick]](ID: Byte; Reason: string)
  <tr><td>function [[TGame.LoadCon|LoadCon]](ConfigFile: string): Boolean</td></tr>
+
| align="center" |
  <tr><td>function [[TGame.LoadList|LoadList]](MapsList: string): Boolean</td></tr>
+
|-
  <tr><td>procedure [[TGame.LobbyRegister|LobbyRegister]]</td></tr>
+
| procedure [[TGame.StartVoteMap|StartVoteMap]](Name: string)
  <tr><td><br /></td></tr>
+
| align="center" |
  <tr><td>property [[TGame.GameStyle|GameStyle]]: Byte</td><td>RW</td></tr>
+
|-
  <tr><td>property [[TGame.MaxPlayers|MaxPlayers]]: Byte</td><td>RW</td></tr>
+
| procedure [[TGame.Restart|Restart]]
  <tr><td>property [[TGame.NextMap|NextMap]]: string</td><td>R</td></tr>
+
| align="center" |
  <tr><td>property [[TGame.NumBots|NumBots]]: Byte</td><td>R</td></tr>
+
|-
  <tr><td>property [[TGame.NumPlayers|NumPlayers]]: Byte</td><td>R</td></tr>
+
| function [[TGame.LoadWeap|LoadWeap]](WeaponMod: string): Boolean
  <tr><td>property [[TGame.Spectators|Spectators]]: Byte</td><td>R</td></tr>
+
| align="center" |
  <tr><td>property [[TGame.ScoreLimit|ScoreLimit]]: Byte</td><td>RW</td></tr>
+
|-
  <tr><td>property [[TGame.ServerIP|ServerIP]]: string</td><td>R</td></tr>
+
| function [[TGame.LoadCon|LoadCon]](ConfigFile: string): Boolean
  <tr><td>property [[TGame.ServerName|ServerName]]: string</td><td>R</td></tr>
+
| align="center" |
  <tr><td>property [[TGame.ServerPort|ServerPort]]: Word</td><td>R</td></tr>
+
|-
  <tr><td>property [[TGame.ServerVersion|ServerVersion]]: string</td><td>R</td></tr>
+
| function [[TGame.LoadList|LoadList]](MapsList: string): Boolean
  <tr><td>property [[TGame.ServerInfo|ServerInfo]]: string</td><td>R</td></tr>
+
| align="center" |
  <tr><td>property [[TGame.Gravity|Gravity]]: Single</td><td>RW</td></tr>
+
|-
  <tr><td>property [[TGame.Paused|Paused]]: Boolean</td><td>RW</td></tr>
+
| procedure [[TGame.LobbyRegister|LobbyRegister]]
  <tr><td>property [[TGame.RespawnTime|RespawnTime]]: LongInt</td><td>RW</td></tr>
+
| align="center" |
  <tr><td>property [[TGame.MinRespawnTime|MinRespawnTime]]: LongInt</td><td>RW</td></tr>
+
|-
  <tr><td>property [[TGame.MaxRespawnTime|MaxRespawnTime]]: LongInt</td><td>RW</td></tr>
+
| colspan="3" |
  <tr><td>property [[TGame.MaxGrenades|MaxGrenades]]: Byte</td><td>RW</td></tr>
+
|-
  <tr><td>property [[TGame.Bonus|Bonus]]: Byte</td><td>RW</td></tr>
+
| property [[TGame.GameStyle|GameStyle]]: Byte
  <tr><td>property [[TGame.TimeLimit|TimeLimit]]: LongInt</td><td>RW</td></tr>
+
| align="center" | RW
  <tr><td>property [[TGame.TimeLeft|TimeLeft]]: LongInt</td><td>R</td></tr>
+
|-
  <tr><td>property [[TGame.FriendlyFire|FriendlyFire]]: Boolean</td><td>RW</td></tr>
+
| property [[TGame.MaxPlayers|MaxPlayers]]: Byte
  <tr><td>property [[TGame.Password|Password]]: string</td><td>RW</td></tr>
+
| align="center" | RW
  <tr><td>property [[TGame.VotePercent|VotePercent]]: Single</td><td>RW</td></tr>
+
|-
  <tr><td>property [[TGame.Realistic|Realistic]]: Boolean</td><td>RW</td></tr>
+
| property [[TGame.NextMap|NextMap]]: string
  <tr><td>property [[TGame.Survival|Survival]]: Boolean</td><td>RW</td></tr>
+
| align="center" | R
  <tr><td>property [[TGame.Advance|Advance]]: Boolean</td><td>RW</td></tr>
+
|-
  <tr><td>property [[TGame.Balance|Balance]]: Boolean</td><td>RW</td></tr>
+
| property [[TGame.NumBots|NumBots]]: Byte
  <tr><td>property [[TGame.TickThreshold|TickThreshold]]: LongInt</td><td>RW</td></tr>
+
| align="center" | R
  <tr><td>property [[TGame.Teams|Teams]][ID: Byte]: [[TTeam]]</td><td>R</td></tr>
+
|-
  <tr><td>property [[TGame.OnClockTick|OnClockTick]]: [[TOnClockTickEvent]]</td><td>RW</td></tr>
+
| property [[TGame.NumPlayers|NumPlayers]]: Byte
  <tr><td>property [[TGame.OnJoin|OnJoin]]: [[TOnJoinGameEvent]] </td><td>RW</td></tr>
+
| align="center" | R
  <tr><td>property [[TGame.OnLeave|OnLeave]]: [[TOnLeaveGameEvent]]</td><td>RW</td></tr>
+
|-
  <tr><td>property [[TGame.OnRequest|OnRequest]]: [[TOnRequestEvent]]</td><td>RW</td></tr>
+
| property [[TGame.Spectators|Spectators]]: Byte
  </table>
+
| align="center" | R
</code>
+
|-
 +
| 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]]
 
[[Category:Classes]][[Category:TGame]]

Latest revision as of 23:39, 6 May 2020

Inheritance

Description

Represents a game state and configuration.

This class is assigned to global variable "Game"
user constructable: NO
user destructable: NO

Members

Member declaration Access mode SS Version
procedure Shutdown
procedure StartVoteKick(ID: Byte; Reason: string)
procedure StartVoteMap(Name: string)
procedure Restart
function LoadWeap(WeaponMod: string): Boolean
function LoadCon(ConfigFile: string): Boolean
function LoadList(MapsList: string): Boolean
procedure LobbyRegister
property GameStyle: Byte RW
property MaxPlayers: Byte RW
property NextMap: string R
property NumBots: Byte R
property NumPlayers: Byte R
property Spectators: Byte R
property ScoreLimit: Byte RW
property ServerIP: string R
property ServerName: string R
property ServerPort: Word R
property ServerVersion: string R
property ServerInfo: string R
property Gravity: Single RW
property Paused: Boolean RW
property RespawnTime: LongInt RW
property MinRespawnTime: LongInt RW
property MaxRespawnTime: LongInt RW
property MaxGrenades: Byte RW
property Bonus: Byte RW
property TimeLimit: LongInt RW
property TimeLeft: LongInt R
property FriendlyFire: Boolean RW
property Password: string RW
property AdminPassword: string RW 2.7.9
property VotePercent: Single RW
property Realistic: Boolean RW
property Survival: Boolean RW
property Advance: Boolean RW
property Balance: Boolean RW
property TickThreshold: LongInt RW
property TickCount: LongInt R 2.8.0.rc1
property Teams[ID: Byte]: TTeam R
property CurrentMap: string R 2.7.8.b1
property MapsList: TMapsList R 2.7.8.b1
property BanLists: TBanLists R 2.7.9
property OnClockTick: TOnClockTickEvent RW
property OnJoin: TOnJoinGameEvent RW
property OnLeave: TOnLeaveGameEvent RW
property OnRequest: TOnRequestEvent RW
property OnAdminCommand: TOnAdminCommandEvent RW 2.7.8.b1
property OnTCPMessage: TOnTCPMessageEvent RW 2.7.8.b1
property OnAdminConnect: TOnAdminConnectEvent RW 2.7.8.b1
property OnAdminDisconnect: TOnAdminDisconnectEvent RW 2.7.8.b1
property OnSteamAuth: TOnSteamAuthEvent RW 2.8.2 steam version