Difference between revisions of "Global Properties"

From King Arthur's Gold Wiki
Jump to: navigation, search
(Created page with "<onlyinclude> Something here about the general concept of global properties. </onlyinclude> Then a big ol' list of the properties, with their descriptions. Link to their own art...")
 
 
(8 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
<onlyinclude>
 
<onlyinclude>
−
Something here about the general concept of global properties.
+
Global properties are variables that are globally available (for reading/writing) in any script.
 
</onlyinclude>
 
</onlyinclude>
 +
This is a list of all of the global properties provided by the KAG application (that is, not defined in a script).
 +
{| class="wikitableShiny" border="1"
 +
|-
 +
! '''Property'''
 +
! '''Type'''
 +
! '''Description'''
 +
|-
 +
| sv_name
 +
| string
 +
| Sets the server name displayed in server browser
 +
|-
 +
| sv_info
 +
| string
 +
| Sets the server info displayed in server browser
 +
|-
 +
| sv_password
 +
| string
 +
| Sets the server password
 +
|-
 +
| sv_rconpassword
 +
| string
 +
| Sets the server remote console password
 +
|-
 +
| sv_gold_only
 +
| bool
 +
| If set to 1 only premium account players can join (aka Gold Server)
 +
|-
 +
| sv_alloweditor
 +
| int
 +
| If set to 1 players that have RCON can start map editor on server
 +
|-
 +
| sv_maxping
 +
| int
 +
| Max ping allowed on server after which player is kicked. Large ping players will slow down server
 +
|-
 +
| sv_maxping_warnings
 +
| int
 +
| Because of ping spikes, warnings are issued if a player has ping over max number
 +
|-
 +
| sv_maxhack_warnings
 +
| int
 +
| Maximum amount of warnings where server thinks player is hacking
 +
|-
 +
| sv_gamemode
 +
| string
 +
| The gamemode that launched on start of dedicated server
 +
|-
 +
| sv_require_auth
 +
| bool
 +
| If set to 1 server checks client authentication via master server
 +
|-
 +
| sv_register
 +
| bool
 +
| Whether or not to register this server with the master list. You likely only want this set to 0 if this is a firewalled private server
 +
|-
 +
| sv_preferAF
 +
| unsigned short int
 +
| Server AF preference for whether clients connect using IPv4 or IPv6. Set to 0 for clients to use whichever performs better when both are available
 +
|-
 +
| sv_enableIPv6
 +
| bool
 +
| Whether to use IPv6 globally. Set to 0 to disable IPv6 globally including for API calls (NOT RECOMMENDED!)
 +
|-
 +
| sv_ip
 +
| string
 +
| Server communication IP address, this is where it listens for incoming clients. This is the IP address clients can connect to. Set to 0 for automatic detection
 +
|-
 +
| sv_ipv6
 +
| string
 +
| Server communication IPv6 address, this is where it listens for incoming clients. This is the IPv6 address bound for anything but game traffic (currently). Set to 0 for automatic detection
 +
|-
 +
| sv_port
 +
| int
 +
| Server communication port, this is where it listens for incoming clients. Remember to open this port in your firewall
 +
|-
 +
| sv_deltapos_modifier
 +
| f32
 +
| Controls the threshold for delta packet updating. Value higher than 1 will reduce bandwidth, lower increase
 +
|-
 +
| sv_compression
 +
| bool
 +
| Compress network data or not. Disabling compression may improve performance. DO NOT change this while running the server!
 +
|-
 +
| sv_fastdeltas
 +
| bool
 +
| Faster deltas mean less CPU intensive but more bandwidth used
 +
|-
 +
| n_disconnectwait
 +
| int
 +
| The time to wait before truly closing the communication
 +
|-
 +
!
 +
!
 +
! '''Map Generator'''
 +
|-
 +
| m_width
 +
| int
 +
| Map generator width
 +
|-
 +
| m_height
 +
| int
 +
| Map generator height
 +
|-
 +
| m_seed
 +
| int
 +
| Map generator seed
 +
|-
 +
| m_generator
 +
| string
 +
| Map generator file config file path. e.g. Maps/generator_ctf_mountain.cfg
 +
|-
 +
!
 +
!
 +
! '''Voting'''
 +
|-
 +
| g_kickvote_percent
 +
| f32
 +
| Percentage of players needed for a kick vote to pass (0-100)
 +
|-
 +
| g_mapvote_percent
 +
| f32
 +
| Percentage of players needed for a map vote to pass (0-100)
 +
|-
 +
| g_vote_time
 +
| int
 +
| How long (in seconds) does the voting last
 +
|-
 +
| g_kickvote_bantime
 +
| int
 +
| How long (in minutes) is the player banned after a kick vote
 +
|-
 +
!
 +
!
 +
! '''Slots'''
 +
|-
 +
| sv_maxplayers
 +
| int
 +
| Maximum number of players allowed in the game
 +
|-
 +
| sv_enable_joinfull
 +
| bool
 +
| If set to 1 then privileged users (with the join_full seclev feature) may join the server when full
 +
|-
 +
| sv_reservedslots
 +
| int
 +
| Number of reserved slots (additional slots on top of the max, accessible only to privileged players)
 +
|-
 +
| sv_spectatorslots
 +
| int
 +
| Number of slots specifically for spectators. Set to 0 for spectators to use the same slot pool as every other player
 +
|-
 +
|}
  
−
Then a big ol' list of the properties, with their descriptions. Link to their own articles only if more detail is required.
 
  
 +
Enum (keys):
 +
 +
Whilst not truly global properties, this seems like a good enough place as any to document the keys enum - which is essentially a set of globally available constants.
 
{| class="wikitableShiny" border="1"
 
{| class="wikitableShiny" border="1"
 
|-
 
|-
−
! width="200" | '''Property'''
+
! '''Name'''
−
! width="200" | '''Description'''
+
! '''Description'''
−
|-  
+
|-
−
| [[bluh]]
+
| key_up
−
| {{:bluh}}
+
|
 +
|-
 +
| key_down
 +
|
 +
|-
 +
| key_left
 +
|
 +
|-
 +
| key_right
 +
|
 +
|-
 +
| key_action1
 +
|
 +
|-
 +
| key_action2
 +
|
 +
|-
 +
| key_action3
 +
|
 +
|-
 +
| key_use
 +
|
 +
|-
 +
| key_inventory
 +
|
 +
|-
 +
| key_pickup
 +
|
 +
|-
 +
| key_bubbles
 +
|
 +
|-
 +
| key_taunts
 +
|
 +
|-
 +
| key_zoomin
 +
|
 +
|-
 +
| key_zoomout
 +
|
 +
|-
 +
| key_map
 +
|
 
|-
 
|-
 
|}
 
|}
  
 
[[Category:Scripting]]
 
[[Category:Scripting]]

Latest revision as of 12:32, 8 September 2012

Global properties are variables that are globally available (for reading/writing) in any script.

This is a list of all of the global properties provided by the KAG application (that is, not defined in a script).

Property Type Description
sv_name string Sets the server name displayed in server browser
sv_info string Sets the server info displayed in server browser
sv_password string Sets the server password
sv_rconpassword string Sets the server remote console password
sv_gold_only bool If set to 1 only premium account players can join (aka Gold Server)
sv_alloweditor int If set to 1 players that have RCON can start map editor on server
sv_maxping int Max ping allowed on server after which player is kicked. Large ping players will slow down server
sv_maxping_warnings int Because of ping spikes, warnings are issued if a player has ping over max number
sv_maxhack_warnings int Maximum amount of warnings where server thinks player is hacking
sv_gamemode string The gamemode that launched on start of dedicated server
sv_require_auth bool If set to 1 server checks client authentication via master server
sv_register bool Whether or not to register this server with the master list. You likely only want this set to 0 if this is a firewalled private server
sv_preferAF unsigned short int Server AF preference for whether clients connect using IPv4 or IPv6. Set to 0 for clients to use whichever performs better when both are available
sv_enableIPv6 bool Whether to use IPv6 globally. Set to 0 to disable IPv6 globally including for API calls (NOT RECOMMENDED!)
sv_ip string Server communication IP address, this is where it listens for incoming clients. This is the IP address clients can connect to. Set to 0 for automatic detection
sv_ipv6 string Server communication IPv6 address, this is where it listens for incoming clients. This is the IPv6 address bound for anything but game traffic (currently). Set to 0 for automatic detection
sv_port int Server communication port, this is where it listens for incoming clients. Remember to open this port in your firewall
sv_deltapos_modifier f32 Controls the threshold for delta packet updating. Value higher than 1 will reduce bandwidth, lower increase
sv_compression bool Compress network data or not. Disabling compression may improve performance. DO NOT change this while running the server!
sv_fastdeltas bool Faster deltas mean less CPU intensive but more bandwidth used
n_disconnectwait int The time to wait before truly closing the communication
Map Generator
m_width int Map generator width
m_height int Map generator height
m_seed int Map generator seed
m_generator string Map generator file config file path. e.g. Maps/generator_ctf_mountain.cfg
Voting
g_kickvote_percent f32 Percentage of players needed for a kick vote to pass (0-100)
g_mapvote_percent f32 Percentage of players needed for a map vote to pass (0-100)
g_vote_time int How long (in seconds) does the voting last
g_kickvote_bantime int How long (in minutes) is the player banned after a kick vote
Slots
sv_maxplayers int Maximum number of players allowed in the game
sv_enable_joinfull bool If set to 1 then privileged users (with the join_full seclev feature) may join the server when full
sv_reservedslots int Number of reserved slots (additional slots on top of the max, accessible only to privileged players)
sv_spectatorslots int Number of slots specifically for spectators. Set to 0 for spectators to use the same slot pool as every other player


Enum (keys):

Whilst not truly global properties, this seems like a good enough place as any to document the keys enum - which is essentially a set of globally available constants.

Name Description
key_up
key_down
key_left
key_right
key_action1
key_action2
key_action3
key_use
key_inventory
key_pickup
key_bubbles
key_taunts
key_zoomin
key_zoomout
key_map
Retrieved from "http://wiki.kag2d.com/index.php?title=Global_Properties&oldid=10635"