Help Document WeaponDef Tags

[FLOZi]

Hi folks!

As part of my ongoing documentation efforts (and before I can flesh out the wiki Units-WeaponDefs page in the 'new style') I am making a two-way table showing which weaponTypes implement which tags (File is excel 2007).

Currently there are three states,

• Green (x) - Implemented
• Orange (.) - No implementation desired for this weapontype
• Red (o) - Not implemented

Quite a few of the red cells should probably be orange, I've only really being filling that in for Melee and Shield as they are the least ambiguous.

Those marked with 'WeaponProjectile' mean that WeaponProjectile.cpp has some mention of the code so all WP based weapons (all except melee, rifle, shield) are marked as green - this may well not be the case, engine devs I could do with your help in these cases in particular.


So what does this have to do with anyone? Well I'd like people to look over what I've already done (especially those familiar with engine weapon code ) and feel free to contribute additional tags yourself - might be helpful to coordinate with me via pm or on lobby (#moddev).

WeaponTypes vs Tags.7z

(9.34 KiB) Downloaded 23 times

[Forboding Angel]

Put it on google docs flozi and share it with us.

[Forboding Angel]

Beat ya to it: https://docs.google.com/spreadsheet/ccc ... lR4OFJFdWc

[FLOZi]

Thanks Forb, good idea.

[Forboding Angel]

NP, I'm anal about this sort of stuff ;p I hate looking at spreadsheets so I figure if I'mma look at them, they are gonna be pretty (and I'm pretty big on having stuff like this "cloudbased" just cause it's a lot easier )

[FLOZi]

So a few things to potential contributors:

I'm going through WeaponDefHandler.cpp line by line, so the tags are in that order. Once this is complete I will use it to help decide how to group tags in the wiki page, as well as being a useful piece of doc in itself.

First thing to do is to add all the tag names, though I think everything in the visuals table (line 407 onwards) might be better done on a seperate sheet - they are tied much more closely to projectile types than weapontypes (though most weapons have their own projectiles of course, only BombDropper has same default projectile as Cannon (even Emg has it's own projectile) that I can think of)

[FLOZi]

All tags have now had a 'first draught' completed, much thanks to DeadnightWarrior, Forb, and anyone else who contributed. I'm now going through and double checking each tag and highlighting it blue once I'm sure the information is correct.

Would appreciate people willing to test (especially if they have a Rifle weapon that can reliably be tested with various tags) and of course, anyone semi-familiar with the engine code and grep or a similar tool.

[smoth]

Good on ya

[FLOZi]

Wiki update:

http://springrts.com/wiki/Flozi:Units-WeaponDefs

26 regular tags left to do and then another 26 visual tags.

Also note I modified the tag template so you can now link directly to individual tags eg:

http://springrts.com/wiki/Units-UnitDefs#Tag:yardmap

[knorke]

nice work :)
I want to propose something though:

imo should there need to be 2 lists.
1) A list that explains all tags:

tagA - blablabla
tagB - blablabla
tagC - blablabla
tagD - blablabla

has all tags, no matter for what weapons use them.

second list:
2) What weapon uses which tags:

weapon 1
tagA
tagB

weapon 2
tag A
tag C
tag D

In this list it would only have the tags without description.
(maybe with defaults because they can be different per weapon)

Atm that is mixed with list 1.
That makes it confusing if you "want to know all tags used by MissileLauncher" then the descriptions are cluttering too much imo.
Also you have to look in two places: Universal & MissileLauncher.
Basically it should be possible to click MissileLauncher and see all the tags it uses, in one place.
A table like one on google docu, looks nice but is imo too cumbersome to use.

Dividing into 2 lists would also solve some uncertainties like:

Universal
The following tags work for all or almost all WeaponTypes.

Or:

Overrides the map gravity for ballistic weapons.

Which weapons are ballastic? Some are obvious. (Cannon: yes, BeamLaser: no) But what about Rifle? FlameThrower?

[FLOZi]

Yes it's problematic.

I want to certainly keep at least one page with all tags listed (with at least some structure) for easy ctrl+f, but additional pages may be helpful also - the problem becomes maintenance without some extremely clever / verbose templating.

I am open to suggestions.

edit: reread what you said i.e. just the tag name - quite feasible now especially as you can now link directly to a particular tag on a page. This may be the way to go.

(Though I am personally still in favour of the abhorrent half-way house structure of the current page for the full details)

[FLOZi]

http://springrts.com/wiki/Units-WeaponDefs

Something something dark-side, something something complete.