Difference between revisions of "FF Commands"
(→Client) |
(→Client) |
||
| Line 7: | Line 7: | ||
=Client= | =Client= | ||
| − | '''One of the programmers will probably have to help me out with the technical definitions of commands and cvars''' | + | '''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. |
| + | |||
| + | '''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". How do we solve this issue and standardise everything? Are we going to name FF's client commands and cvars just like normal HL2 commands? It'd probably be quite clunky if we had prefixes for everything. | ||
==Examples of Commands== | ==Examples of Commands== | ||
| Line 17: | Line 19: | ||
* Spawn Holding Weapon as Class | * Spawn Holding Weapon as Class | ||
* Quickswitch Settings (allows player to set up two slots / weapons to quickswitch between using a single key -- again, this can be set up in the classname.cfg rather than requiring medic_quickswitch1, medic_quickswitch2 etc) | * Quickswitch Settings (allows player to set up two slots / weapons to quickswitch between using a single key -- again, this can be set up in the classname.cfg rather than requiring medic_quickswitch1, medic_quickswitch2 etc) | ||
| − | * Suicide When Changing Class ( | + | * Suicide When Changing Class (FF equivalent of "hud_autokill") |
| − | * Exec class configs automatically | + | * Exec class configs automatically (FF equivalent of TFC command whatever_ec) |
| − | * Exec map config automatically | + | * 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. | |
Please see the below categories for adding cleint/server commands/vars. I figure it's more logical to have separate pages for client/server. | Please see the below categories for adding cleint/server commands/vars. I figure it's more logical to have separate pages for client/server. | ||
Revision as of 06:58, 3 October 2005
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.
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.
Client
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.
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". How do we solve this issue and standardise everything? Are we going to name FF's client commands and cvars just like normal HL2 commands? It'd probably be quite clunky if we had prefixes for everything.
Examples of Commands
- Discard
- Medic call
- Engineer call
Examples of Cvars
- Spawn Holding Weapon as Class
- Quickswitch Settings (allows player to set up two slots / weapons to quickswitch between using a single key -- again, this can be set up in the classname.cfg rather than requiring medic_quickswitch1, medic_quickswitch2 etc)
- Suicide When Changing Class (FF equivalent of "hud_autokill")
- 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.
Please see the below categories for adding cleint/server commands/vars. I figure it's more logical to have separate pages for client/server.
Client
- Client commands & vars.
Server
- Server commands & vars.
