summaryrefslogtreecommitdiff
path: root/doc/classes/RayCast2D.xml
AgeCommit message (Collapse)Author
2022-08-22Expose the collider RID in Raycast nodesPaul Joannon
Create and expose the method `get_collider_rid` in `RayCast2D` and `Raycast3D`. This method returns the `RID` of the first object that the ray intersects, or an empty `RID` if no object is intersecting the fay (i.e. `is_colliding` returns `false`).
2022-08-11[doc] Use "param" instead of "code" to refer to parameters (4)Andy Maloney
2022-08-08Rename the argument tag to param in XML documentationYuri Sizov
2022-02-15Add an XML schema for documentationHugo Locurcio
This makes it easier to spot syntax errors when editing the class reference. The schema is referenced locally so validation can still work offline. Each class XML's schema conformance is also checked on GitHub Actions.
2022-01-28Improve some method bindings to use specific `Object` subtypesRémi Verschelde
This was made possible by changes to `VariantCaster` which now make it possible to pass any `Object`-derived type as pointer.
2021-11-15Replace Godot docs URL with `$DOCS_URL` in XML class referenceRémi Verschelde
2021-11-10Add raycast options to hit when starting inside / hit back facesPouleyKetchoupp
Makes the results consistent for all shape types with options to set the desired behavior.
2021-10-05doc: Fix style inconsistencies for `[b]Note:[/b]` paragraphsRémi Verschelde
And fix up formatting not supported by makerst.
2021-09-20Don't generate empty doc sections and reduce code duplicationAaron Franke
2021-08-12Uniformize layer names, script methods and documentationPouleyKetchoupp
- Back to 1-based layer names to make it clearer in editor UI - Layer bit accessors are renamed to layer value and 1-based too - Uniform errors and documentation in render and physics - Fix a few remaining collision_layer used in place of collision_mask
2021-07-30doc: Use self-closing tags for `return` and `argument`Rémi Verschelde
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.
2021-06-18Better format arguments in variant parserMichael Alexsander Silva Dias
2020-09-11doc: Sync classref with current sourceRémi Verschelde
Bind missing enums.
2020-09-10Rename RayCast's `cast_to` property to `target_position`Hugo Locurcio
`cast_to` is sometimes mistaken as a method rather than a property. `target_position` makes it more obvious that it's a property.
2020-08-31Merge pull request #40993 from Calinou/doc-collision-layer-maskRémi Verschelde
Reference the online documentation in collision layer/mask properties
2020-08-31Add link titles for all links in the class referenceHugo Locurcio
This makes them display in a nicer way in the editor help. (The title will display instead of the full URL.)
2020-08-03Reference the online documentation in collision layer/mask propertiesHugo Locurcio
See https://github.com/godotengine/godot-docs/pull/3863.
2020-07-13Commit other files changed by file_format.shAaron Franke
2020-07-03doc: Sync classref with current sourceRémi Verschelde
2020-01-31Update docs to version 4.0clayjohn
2020-01-26doc: Drop unused 'category' property from headerRémi Verschelde
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.
2019-11-07Added link to raycasting tutorial to RayCast/RayCast2DYuri Roubinsky
2019-06-30doc: Remove hardcoded default values from descriptionsRémi Verschelde
They are now generated automatically by doctool.
2019-06-30doc: Add default values to all propertiesRémi Verschelde
Thanks to @bojidar-bg's impressive work in #29380.
2019-06-27Proofread and improve the whole class referenceHugo Locurcio
- 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-05-23Change "Return" to "Returns" where necessary in XML documentationSean Heffernan
In many of the XML files it had been noted that when the documentation refers to a return value, both "Return" and "Returns" are used. This has now been fixed to only say "Returns". Fixes #28867
2019-04-19doc: Drop unused <demos> tagRémi Verschelde
2019-04-01doc: Bump version to 3.2Rémi Verschelde
2018-09-23[Docs] Remove double-spaces from descriptions, as well a couple other small ↵LikeLakers2
fixes
2018-08-30RayCast2D: Fix reporting old collider after collision endedRémi Verschelde
It now behaves the same as RayCast (3D). Fixed documentation accordingly and documented new configuration options. Supersedes and closes #20567.
2018-08-29doc: Sync classref with current sourceRémi Verschelde
2018-02-27doc: Remove status from hardcoded version stringRémi Verschelde
It has no practical use case and just generates noise for each alpha, beta, etc.
2018-02-19doc: Update version string in headerRémi Verschelde
2018-01-25doc: Sync with current sourceRémi Verschelde
Also enhance RigidBody docs as per https://github.com/godotengine/godot-docs/pull/1018 and fix the version tag in all files (not really stable yet, but it makes no sense to hardcode rc3 at this stage).
2018-01-18Added description to get_collision_mask_bit and set_collision_mask_bit in ↵Anutrix
RayCast2D.xml
2018-01-13doc: Update version string in XMLRémi Verschelde
2017-11-24doc: Remove setters and getters now exposed via properties/membersRémi Verschelde
2017-11-24doc: Update header version for 3.0-betaRémi Verschelde
2017-11-24doc: Sync classref with current sourceRémi Verschelde
2017-11-15doc: Remove revision.module_config from version stringRémi Verschelde
It is now "3.0-alpha" instead of "3.0.alpha.custom_build{,.mono}", limits unnecessary diffs.
2017-10-24classref: Sync with current sourceRémi Verschelde
[ci skip]
2017-10-22classref: Sync with current sourceRémi Verschelde
Also fix hyperlink references to same class as per the guidelines. [ci skip]
2017-10-21Rename RayCasts collision_layer to collision_maskPedro J. Estébanez
The point is that `RayCast`s are checked against objects' `collision_layer`(s), but they themselves are considered no to _belong_ to any layer. Therefore, the correct name for their property is `collision_mask`, rather than `collision_layer`. Only renaming is needed since the behavior was already the right one, only that it wasn't matching what users would expect from the name and description of the property. Fixes #7589, where it's also discussed.
2017-10-14[DOCS] Fix a few typos.Andreas Haas
2017-10-11doc: Sync classref with current sourceRémi Verschelde
Ensure that s/fixed_process/physics_process/ is handled properly. [ci skip]
2017-09-13doc: Sync classref with current sourceRémi Verschelde
[ci skip]
2017-09-12Changed the doc class generation to individual files per class. It is also ↵Juan Linietsky
possible to save module files in module directories and the build system will recognize them.