search

UniTrader / ut_console

Adds Console-like functionality to the Chatwindow
0 stars 0 forks source link

Possible changes for Manual.pdf #1

Open ACryInShame opened 2 months ago

ACryInShame commented 2 months ago

The color explanation from Pg 4 should be after the "Using the commands of this mod" on Pg 2 as colors are used in the command overview and should be explained before being used.

All of the commands on Pg 4 look like they are unfinished and do not match the style of explanation on Pg 3

Typo on Pg 6, "unledd" should be unless

on Pg 5 you explained much about the properties but not the fact you are using <> to indicate a value in these properties

was the „ in „Root Properties“ on page 5 on purpose or was it suppose to be "Root Properties“?

Standard Properties on Pg 7-8 don't seem to be in any order and are all out of alignment making it really hard to read for some of the properties such as "masstrafficstartobjectmasstrafficendobject hasenginemod". maybe reducing 7 columns to 6 or 5 will make it easier to read by just extending it another page or so.

on Pg. 9 you changed your explanation structure again, making these inconsistencies makes what information you are trying to get across harder to understand. Please stick with a explanation format for all explanations. Maybe the format you used on Pg 3, even if it makes your PDF more pages.

The link on Pg 10 is unreadable with the dark background.

UniTrader commented 2 months ago
  1. the suggested part was in the previous Chapter, so it was unrelated for me - changing the order a bit
  2. Yeah, i indicated that the Commands Section is still Work in Progress. it is the part i was currently working on ;) just wanted to get some early feedback on the overall Structure. (also there are more Commands planned too)
  3. fixed.
  4. put in a sentence to explain this.
  5. the "" are intentional. Some Commands like &checkship take input like crewskill.12 but here crewskill denotes which input value for the command it is, its not the start of a property chain (the format is the same though since this was a freebie implementation wise). Will think about how to formulate this better, or maybe even change the syntax...
  6. This part is mostly intended as quick reference to search through if a certain property is available at all. The Explaination for them and the context they apply in is delivered with the game in form of the scriptproperties.html file. Also it is "unsorted" because the order is based on an "unsorted" scriptproperties.html since there it groups similar properties nicely (for example yaw, pitch and roll are one after another, in alphabetical order they would be all over the place), but yeah i agree that this part needs restructuring..
  7. These Properties are ones i added for the purpose of using in this Console, so my thought was they need some more explaination than the Standard properties in the Chapter before where an explaination is included with the game, But also they dont need an as extensive explaination as the commands itself, since they dont have such things as usage, parameters, (text) output or effects by themselves. All of them just get a new value from a previous value. (for example $ship.sector.name / ABC-123.sector.name starts with an object reference, then gets which sector this object is in, and then gets the name of that Sector) => I think i should add a Chapter explaining Property Chains and reference it in the Section about Properties to clarify that

Thans for the Feedback, will implement these changes now, and close this when done.