I have updated and standardized the writing for the controllers a bit. This includes moving all the parts that are standard to the controllers into the editing page instead of having them copied exactly across nearly all the other controller pages.
Details
Details
- Reviewers
Kitt Zwovic (gandalf3) - Group Reviewers
Documentation - Commits
- rBM631: Update and consolidate game engine controller docs.
Diff Detail
Diff Detail
- Repository
- rBM Blender Manual
Event Timeline
Comment Actions
I found a few issues with syntax (unsurprisingly, given that you have no way of testing..)
Comments are inline.
But on the whole it looks good to me :) Nice work
| manual/game_engine/logic/controllers/and.rst | ||
|---|---|---|
| 20 | This syntax only works for linking to titles in the same file. To link to a target specified in another file with the .. _target-name: syntax, use :ref:`remaining parts <standard-controller-parts>` | |
| manual/game_engine/logic/controllers/editing.rst | ||
| 98 | #. Results in a numbered list, adding numbers after that results in too many numbers.  | |
| manual/game_engine/logic/controllers/expression.rst | ||
| 143 | Since this is a list of 1, this renders on the same line as 1. Expression. To fix, add another line between them (markdown style):
That said, having lists of 1 element may not be ideal | |
| manual/game_engine/logic/controllers/python.rst | ||
| 36 | The indentation is off here, preventing the list from auto incrementing. The lines after the #. Item should have 4 spaces (1 more than they have now). | |
| 39 | A bit of a nitpick, but it's rather unclear what "D" is imo (this is more of an issue with blender's UI than anything). Perhaps using it's full name "Use Debug" or maybe "D (Use Debug)" would be clearer? While I'm here, I also noticed that blender's tooltip for this option has more info than the manual entry. Ideally this would be reversed.. Perhaps you could describe why continuously reloading the file is useful and how it can be used? | |
| 44 | Not sure what this is doing here? | |
| manual/game_engine/logic/controllers/xor.rst | ||
| 19 | Another nitpick.. to my ear the phrasing "All the options are remaining parts standard to all controllers" sounds a tad awkward. What about using something like this? See :ref:`standard controller parts <standard-controller-parts>` for descriptions of the remaining options" | |
Comment Actions
@GiantCowFIlms Currently we're waiting for an updated diff which addresses any issues.
To upload a new diff, either click Update Diff in the top right corner of this revision or follow the instructions in step 5 here.