Commit Graph

71 Commits

Author SHA1 Message Date
Rémi Verschelde f5836b40d4
doc: Use self-closing tags for `return` and `argument`
For the time being we don't support writing a description for those, preferring
having all details in the method's description.

Using self-closing tags saves half the lines, and prevents contributors from
thinking that they should write the argument or return documentation there.

(cherry picked from commit 7adf4cc9b5)
2021-08-03 10:20:19 +02:00
PouleyKetchoupp 114da550ec Fix logic for showing tilemap debug collision
In editor: only when show_collision property is enabled
In game: only when 'Visible collision shapes' is enabled
2021-05-25 11:49:47 -07:00
Rémi Verschelde c3272997cd
doc: Update classref headers with 3.4 version 2021-04-26 13:15:29 +02:00
RoniPerson 79f4da78fb
Added missing `:` in gdscript example.
(cherry picked from commit 5870931a15)
2021-04-05 12:03:40 +02:00
Rémi Verschelde 72a547dc9d
TileMap: Make collision visibility opt-in
Supersedes #47204, see discussion there.
2021-03-30 23:39:37 +02:00
Rémi Verschelde 015973df04
doc: Make all tutorial links point to 3.3 branch of docs 2021-03-26 10:43:43 +01:00
Rémi Verschelde 1aba997d75
doc: Sync classref with 3.3 version bump 2021-03-23 13:40:34 +01:00
janglee 7b6cc3e687 Added `show_collision` property.
If true, collision shapes are shown in the editor and at run-time.
Requires Visible Collision Shapes to be enabled in the Debug menu,
for collision shapes to be visible at run-time.
2021-03-05 01:21:40 +05:30
David Buchmann 26e2eaf068 doc: Clarify TileMap `world_to_map` and `map_to_world` usage
Per discussion in #38551.
Fixes #31663.
Fixes #37394.
2021-02-16 14:52:51 +01:00
kleonc 995388cf6f
Docs: Fix TileMap::map_to_world description
(cherry picked from commit e62ec6c6b1)
2021-02-02 13:02:46 +01:00
Andrii Doroshenko (Xrayez) 0ff0fdef5c
Document shape metadata for `TileMap`
(cherry picked from commit 0c2dbd01dc)
2021-01-26 17:24:39 +01:00
Dustin Petersohn a7609d9c49
Improved documentation for TileMap.cell_y_sort
(cherry picked from commit 669f21d367)
2020-10-28 14:05:42 +01:00
Rémi Verschelde 4287af5148
doc: Make docs.godotengine.org links point to 3.2 branch 2020-10-19 16:10:01 +02:00
Aaron Franke 069ed4ec63
Link to demos from within the class reference
(cherry picked from commit 439be614f4)
2020-10-19 16:10:01 +02:00
Hugo Locurcio cc3b69cf7b
Reference the online documentation in collision layer/mask properties
See https://github.com/godotengine/godot-docs/pull/3863.

(cherry picked from commit c73c327bab)
2020-08-31 15:55:11 +02:00
skyace65 2e1e1af1d2
Add defaults to tilemap set_cell function example
(cherry picked from commit 43ab91ca02)
2020-08-31 15:29:41 +02:00
Hugo Locurcio e77313b3ed Clarify the `id` parameter in `TileMap.get_used_cells_by_id()` 2020-05-12 09:26:38 +02:00
lucaslcode cd10966652 clarify autotile_coord in docs
I had no idea what 'coordinate' meant in the context of autotiles, so just adding some clarification for future people who have the same problem.

(cherry picked from commit cbe73766e3)
2020-04-16 12:47:18 +02:00
Rémi Verschelde 2d20fc39aa doc: Drop unused 'category' property from header
We already removed it from the online docs with #35132.

Currently it can only be "Built-In Types" (Variant types) or "Core"
(everything else), which is of limited use.

We might also want to consider dropping it from `ClassDB` altogether
in Godot 4.0.
2020-01-26 16:02:39 +01:00
Jummit b90ec3b442 finish TileMap docs 2019-11-02 11:49:40 +01:00
Rémi Verschelde 4f294b958f doc: Sync classref with current source
Fix a few missing bindings or unspecified argument names and default values.
2019-09-24 11:52:06 +02:00
Rémi Verschelde efd55631e2 doc: Sync classref with current source 2019-07-15 20:45:30 +02:00
Rémi Verschelde b25d1111c1 doc: Sync classref with current source 2019-07-04 12:15:49 +02:00
Ranoller 14e2a99129 Tilemap fix displaced textures and shapes and added center texture and compatibility mode
This commit fix #22989 #15249 #28206. Main problem is that tilemap displace textures in different tile origins in a strange way and doesn´t respect coincidence between texture and shapes in not uniform tiles. This issue is present in godot 3.0 and godot 3.1. To maintain compatibility are added a compatibility mode and a center texture option. Other related issues and pull request: #28896 #29487 #29519 #29961. Idications of #30204 are added
2019-07-02 17:12:58 +02:00
Rémi Verschelde 850a54a2a5 Fix uninitialized variables in Line2D, JSONParseResult and TileMap 2019-06-30 13:58:07 +02:00
Rémi Verschelde a78373ddc2 doc: Remove null default values that can't be determined
Applying #30187.
2019-06-30 13:58:07 +02:00
Rémi Verschelde b9aa13e591 doc: Remove hardcoded default values from descriptions
They are now generated automatically by doctool.
2019-06-30 13:58:07 +02:00
Rémi Verschelde c6cea6e9b3 doc: Add default values to all properties
Thanks to @bojidar-bg's impressive work in #29380.
2019-06-30 13:58:07 +02:00
Hugo Locurcio f7f6115f76
Proofread and improve the whole class reference
- Document a few more properties and methods
- Add more information to many classes
- Fix lots of typos and gramar mistakes
- Use [code] tags for parameters consistently
- Use [b] and [i] tags consistently
- Put "Warning:" and "Note:" on their own line to be more visible,
  and make them always bold
- Tweak formatting in code examples to be more readable
- Use double quotes consistently
- Add more links to third-party technologies
2019-06-27 22:30:19 +02:00
Rémi Verschelde 6af69f851a doc: Drop unused <demos> tag 2019-04-19 11:03:46 +02:00
Rémi Verschelde 09e94aa087 doc: Sync classref with current source 2019-04-15 14:49:41 +02:00
Michael Alexsander Silva Dias c8d0c61d91 Document TileMap's new 'set_cell' internal override capability 2019-04-05 12:40:57 -03:00
Mariano Javier Suligoy bfc3ba5af0
Merge pull request #27365 from Byteron/tile_map_negative_offset
TileMap, negative Y and X Offset
2019-04-05 09:24:32 -03:00
Aaron Winter 63e0fd7675 added negative X and negative Y offset to TileMap
clang-format

added negative X and negative Y offset to TileMap
2019-04-05 10:37:35 +02:00
Rémi Verschelde 39c868171e doc: Bump version to 3.2 2019-04-01 12:33:56 +02:00
MidZik ee77cba83e Clarified TileMap get_cell method behavior. 2019-02-12 22:44:39 -06:00
Demiu a0640f799b Docs: Fix TileMap::world_to_map description 2019-01-19 15:23:49 +01:00
Rémi Verschelde 2e39e38c10 doc: Sync classref with current source
Fix various code formatting issues and argument names.
2018-12-27 11:10:18 +01:00
Rémi Verschelde 6cdcde7114 doc: Add missing commas after "If true/false" 2018-12-20 13:47:12 +01:00
Rémi Verschelde 5f8af252e8 doc: Use HTTPS for docs.godotengine.org and point to latest branch
Fixes #23509.
2018-11-05 08:46:27 +01:00
LikeLakers2 eaac1e3b81 [Docs] Remove double-spaces from descriptions, as well a couple other small fixes 2018-09-23 16:13:30 -04:00
Rémi Verschelde 5267099a87 doc: Sync classref with current source 2018-08-29 22:25:11 +02:00
PJB3005 338217c30b Improve TileMap.get_used_cells docs. 2018-08-03 20:38:31 +02:00
Rémi Verschelde 391e46830f doc: Sync classref with current source
Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
Pieter-Jan Briers b2c797c584 Defer TileMap::update_dirty_quadrants once again.
This fixes #20323.

#11077 is now technically re-broken,
but you can now call update_dirty_quadrants as workaround.
2018-07-22 15:26:14 +02:00
robojumper 98b59cf2a3 Add support for tutorial links to makerst.py
Also change the <tutorials> structure to make use of individual <link> tags
2018-06-12 17:40:24 +02:00
Rémi Verschelde 4c5dd51eb9 Sync classref with current source
Also fix binding of Basis.slerp
2018-05-28 14:53:15 +02:00
Chris Bradfield 8bc4882dd3 [DOCS] Vector2/Vector3/TileMap wording fixes 2018-05-12 17:58:45 -07:00
Craigory V Coppola 0dd526e062 Docs update for several classes
Namely: Dictionary, GraphEdit, Object, TileMap, Script, ScollBar,
ScrollContainer and SplitContainer
2018-04-19 21:09:53 +02:00
Rémi Verschelde c81356153e
Merge pull request #16971 from Noshyaar/tilemap
TileMap: add fix_invalid_tiles
2018-03-13 13:57:58 +01:00