FF Commands - Revision history

Hirohito at 19:57, 28 February 2008

2008-02-28T19:57:05Z

Defrag: /* Server */

2006-07-03T10:30:12Z

Server

Defrag at 16:22, 3 October 2005

2005-10-03T16:22:36Z

Defrag: /* Examples of Commands */

2005-10-03T16:21:31Z

Examples of Commands

Defrag at 16:21, 3 October 2005

2005-10-03T16:21:17Z

Defrag: /* Naming Style */

2005-10-03T16:19:39Z

Naming Style

Defrag at 16:18, 3 October 2005

2005-10-03T16:18:32Z

Defrag: /* Some Stuff */

2005-10-03T15:37:58Z

Some Stuff

Defrag: /* Some Stuff */

2005-10-03T15:36:49Z

Some Stuff

Defrag at 15:30, 3 October 2005

2005-10-03T15:30:08Z

← Older revision		Revision as of 19:57, 28 February 2008
Line 53:		Line 53:
	==Server==		==Server==
	* [[:Category:svars\|Server Commands & Variables]].		* [[:Category:svars\|Server Commands & Variables]].
		+	[[Category:Archives]]

@@ Line 52: / Line 52: @@
 * [[Commands:Client|Client]] commands & vars.
 ==Server==
-* [[Commands:Server|Server]] commands & vars.
+* [[:Category:svars|Server Commands & Variables]].

@@ Line 32: / Line 32: @@
 * Exec class configs automatically (FF equivalent of TFC command whatever_ec)
 * Exec map config automatically (FF equivalent of TFC command whatever_em)
 I haven't fully thought this through yet.  We do need a list of all the commands & cvars in the game, though.  This page is very very rough, and I haven't finalised its formatting.  I'm just jotting down some ideas & stuff without fleshing it out right now.

@@ Line 21: / Line 21: @@
 Here's some examples of the stuff that qualifies as commands or cvars (no formatting / naming is used, these are just examples of what goes into each category).
-==Examples of Commands==
+==Examples of Client Commands==
 * Discard
 * Medic call

@@ Line 36: / Line 36: @@
 '''This is more for the programmers to fill out, as they have a better grip on the game's contents than Dos or I do'''.
 ==Naming Style==
@@ Line 62: / Line 41: @@
 Generally, excluding prefixes, you should avoid underscores in command/variable names unless one word ends in a letter than the next word begins with.  For example: ff_waveenergy.  This would be better as ff_wave_energy.  However, it's always better to try and rename the cvar so this doesn't happen in the first place.  ff_waveenergy would become ff_wavepower (or whatever is suitable).
-Please see the below categories for adding client/server commands/vars.  I figure it's more logical to have separate pages for client/server.
+Please see the below categories for adding client/server commands/vars.  I figure it's more logical to have separate pages for client/server.  Each page has formatting details for writing the commands/vars.
 ==Client==

@@ Line 58: / Line 58: @@
 * ''Sets the prematch time in seconds.  When this period elapses, the round begins properly''.
-Please see the below categories for adding cleint/server commands/vars.  I figure it's more logical to have separate pages for client/server.
+==Naming Style==
 ==Client==

@@ Line 7: / Line 7: @@
 =Some Stuff=
-I'll move this to the discussion page in due course.
+I'll move a lot of this to the discussion page in due course.
 As I understand it, cvars are variables and store the client's preferences / setup.  Commands are simply things that send something to the engine and cause something to happen as a result.

@@ Line 40: / Line 40: @@
 * '''ffc_cvarname''' [value range / restrictions]
 * ''Description of cvar''
 ==Format of Client Commands==
 * '''commandname/+commandname''' [value range / restrictions (if applicable)]
 * ''Description of command''
 ==Format of Server Settings==
 * '''ff_servervarname''' [value range / restrictions (if applicable)]
 * ''Description of server setting''
+===Example===
 Please see the below categories for adding cleint/server commands/vars.  I figure it's more logical to have separate pages for client/server.

@@ Line 1: / Line 1: @@
-This page is somewhat hard to categorise.  It's for things that can be selected / influenced by the player.  Most of the items on this page should have corresponding entries in the [[Menu System]] controls / options page, unless it's an obscure option that is accessible by config only.  Common sense should be exercised, as this could get really cluttered.  For example, there's no need for ff_medic_sensitivity, as the player can simply use the sensitivity command and place it in the medic.cfg.
+This page is somewhat hard to categorise.  It's for things that can be selected / influenced by the player.  Most of the items on this page should have corresponding entries in the [[Menu System]] controls / options page, unless it's an obscure option that is accessible by config only.  Common sense should be exercised, as this could get really cluttered.  For example, there's no need for ffc_medic_sensitivity, as the player can simply use the sensitivity command and place it in the medic.cfg.
 None of the 'traditional' options that are inherent in the HL2 engine should be listed here.  By this, I mean movement commands, mouse parameters and so forth.  Simply list the '''additional''' things that FF features.
-These things are separated (kinda) into a couple of categories, client and server.  Client commands are further divided between commands and cvars.
+These things are separated (kinda) into a couple of categories, client and server.  Client settings are further divided between commands and cvars.
-=Content=
+=Some Stuff=
-'''One of the programmers will probably have to help me out with the technical definitions of commands and cvars'''.  As I understand it, cvars are variables and store the client's preferences / setup.  Commands are simply things that send something to the engine and cause something to happen as a result.
+I'll move this to the discussion page in due course.
 '''We need a consistent naming scheme''' for ff commands, if possible.  I'd like it if server vars/commands unique to ff had a prefix of some sort, like ff_roundtime etc.  However, I've noticed that many server commands in the CVS build use the common name like "mp_teamplay".
@@ Line 17: / Line 19: @@
 The reasoning is simple: It helps both the dev team and the gamer when they are tracking what is available in the mod.
-Here's some examples of the stuff that qualifies as commands or cvars.
+Here's some examples of the stuff that qualifies as commands or cvars (no formatting / naming is used, these are just examples of what goes into each category).
 ==Examples of Commands==
@@ Line 33: / Line 35: @@
 I haven't fully thought this through yet.  We do need a list of all the commands & cvars in the game, though.  This page is very very rough, and I haven't finalised its formatting.  I'm just jotting down some ideas & stuff without fleshing it out right now.
-This is more for the programmers to fill out, as they have a better grip on the game's contents than Dos or I do.
+'''This is more for the programmers to fill out, as they have a better grip on the game's contents than Dos or I do'''.
 Please see the below categories for adding cleint/server commands/vars.  I figure it's more logical to have separate pages for client/server.