added bad flag documentation #5
Conversation
There was a problem hiding this comment.
I've reviewed only the first chunk, I'll get to the next batch later but this should let you get started with revisions.
I'm not sure why you have one sentence per line in the markdown files. Even though it'll render correctly on the site, that's not how we should be maintaining the docs. Please make it be one paragraph/line. Turn on word wrapping in your editor to make it easier to read if that's your problem.
_documentation/user/flags/jamming.md
Outdated
| Countering the effects of Jamming requires good knowledge of the map and layout, along with effective moment patterns and positioning. | ||
| If ricochet is enabled, one will not be able to notice shots coming from the rear, so avoiding areas where shots may ricochet into ones blind spot is recommended. | ||
| The position where one is, will determine a lot of the effectiveness of Jamming. | ||
| Corner sections or higher ground in a map may offer more visibility, but may also increase the risk of danger to oneself, but this varies based on the layout and design of the map. |
There was a problem hiding this comment.
Elaborate on what you mean by this
| The same in reverse applies to forward left turns, as it would involve approaching a shot, while hoping the speed and distance covered by the tank is enough to dodge it. | ||
| A left turn and forward moment can help in avoid some of these shots, but shots fired in a spread pattern will be almost impossible to dodge with this tactic. | ||
|
|
||
| ## Server Variables |
|
|
||
| ## Tactics | ||
|
|
||
| Left Turn Only prevents right turns and due to this, many tactics in avoiding shots are rendered ineffective. |
|
|
||
| Left Turn Only prevents right turns and due to this, many tactics in avoiding shots are rendered ineffective. | ||
|
|
||
| Countering the effects of Left Turn Only requires general map knowledge and some prediction skills. |
There was a problem hiding this comment.
This is getting repetitive for every bad flag... Let's just get rid of this statement from them all
There was a problem hiding this comment.
The 'countering the effects' or the statement above or both?
| Countering the effects of Momentum requires good prediction skills and being able to plan movements ahead of time. | ||
| The movement of a tank with Momentum is as if the input were delayed. | ||
| Speeding up, slowing down, turning to maximum speed have a delay, which is probably best described as acceleration limits. | ||
| Dodging shots requires earlier reaction time and prediction capabilities, as ones tank will react with slowed and delayed responses to movement. |
There was a problem hiding this comment.
| Dodging shots requires earlier reaction time and prediction capabilities, as ones tank will react with slowed and delayed responses to movement. | |
| Dodging shots requires earlier reaction time and prediction capabilities, as one's tank will react with slowed and delayed responses to movement. |
Grammar fix. But this sentence is starting to sound repetitive to me.
There was a problem hiding this comment.
Maybe a different tack:
This resistance to acceleration makes dodging more difficult.
The essence of dodging is "acceleration" (changes in the velocity vector) and momentum decreases your ability to do so.
| The movement of a tank with Momentum is as if the input were delayed. | ||
| Speeding up, slowing down, turning to maximum speed have a delay, which is probably best described as acceleration limits. | ||
| Dodging shots requires earlier reaction time and prediction capabilities, as ones tank will react with slowed and delayed responses to movement. | ||
| If the '_momentumFriction' variable is adjusted, this may cause a tank to slide quite a bit, depending on how the variable is set. |
There was a problem hiding this comment.
What does "quite a bit" mean? when the variable is higher is the acceleration limit longer or shorter?
There was a problem hiding this comment.
Good point by @allejo and this one might be a bit tricky; 0 is normal friction, then the closer to 0 the argument is, the slower the acceleration is.
| When against enemy players, this becomes especially critical as one must be able to avoid shots until they are able to return fire themselves. | ||
| By having good timing skills, one will able to reduce the effects of Trigger Happy. | ||
|
|
||
| ## Server Variables: |
|
|
||
| ## Tactics | ||
|
|
||
| Wide Angle will give one a much wider field of view, although dramatically reduces the size of objects which are far away. This causes it to become more difficult to judge distance and location correctly. |
| Wide Angle will give one a much wider field of view, although dramatically reduces the size of objects which are far away. This causes it to become more difficult to judge distance and location correctly. | ||
|
|
||
| Countering Wide Angle requires fine control or good radar skills, as either being able to aim precisely or using the radar for lining up shots will allow one to aim effectively, the same applies to dodging shots as well. | ||
| Bullets which appear on the outside window view will be much more difficult to judge their precise location and speed and one may incorrectly estimate their location, speed and heading. |
There was a problem hiding this comment.
| Bullets which appear on the outside window view will be much more difficult to judge their precise location and speed and one may incorrectly estimate their location, speed and heading. | |
| Bullets which appear on the outside window view will be much more difficult to judge their precise location and speed and one may incorrectly estimate their location, speed, and heading. |
| The main counter to the effects of Wide Angle is use of the radar, as radar is unaffected by the Wide Angle flag, the only minor change will be the indication of view of field, if enabled. | ||
| One is recommended to try to take advantage that a wider field of view may allow one to spot danger quicker, but should know that reaching safety will be more difficult. | ||
|
|
||
| ## Server Variables |
|
|
||
| Countering Wide Angle requires fine control or good radar skills, as either being able to aim precisely or using the radar for lining up shots will allow one to aim effectively, the same applies to dodging shots as well. | ||
| Bullets which appear on the outside window view will be much more difficult to judge their precise location and speed and one may incorrectly estimate their location, speed and heading. | ||
| The main counter to the effects of Wide Angle is use of the radar, as radar is unaffected by the Wide Angle flag, the only minor change will be the indication of view of field, if enabled. |
There was a problem hiding this comment.
| The main counter to the effects of Wide Angle is use of the radar, as radar is unaffected by the Wide Angle flag, the only minor change will be the indication of view of field, if enabled. | |
| The main counter to the effects of Wide Angle is the use of the radar, as radar is unaffected by the Wide Angle flag; the only minor change will be the indication of view of field. |
|
Don't be discouraged by the criticism; it's a lot harder to start from a blank slate than it is to critique. Giving us a starting point is of great value |
|
As a blanket policy, future PRs for new docs should be a one PR per page of documentation. As this PR is 140+ comments just through review comments, it's becoming really difficult to manage and view new comments. |
|
Yeah, it is getting somewhat difficult to read and manage. |
|
Updated with changes made. |
allejo
added
needs review
|
Thank you so much for your work and revisions on this, @Zehra! 🎉 I've made some grammatical and formatting changes that I pushed to your branch. Can I get a second (and maybe a third) pair of eyes on these files? |
allejo
removed
the
needs review
Bad flag documentation