Commit Graph

42 Commits

Author SHA1 Message Date
906a693934 Merge pull request #53852 from Calinou/particles-allow-negative-scale
Allow negative scale in Particles and CPUParticles
2022-08-05 22:34:43 +02:00
0a8d5d7098 Bump version to 3.6-beta 2022-08-05 18:51:38 +02:00
b087538119 Add an XML schema for documentation
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-03-16 23:01:02 +01:00
6dd593d579 Random initial color for all Particle Nodes 2021-12-10 16:35:25 +01:00
2fe15124de Document that RigidBody angular velocity is in degrees per second
This will be changed to radians per second in Godot 4.0, but it can't
be changed in 3.x to preserve compatibility with existing projects.
2021-12-07 18:38:03 +01:00
3ac2999f22 Replace Godot docs URL with $DOCS_URL in XML class reference 2021-11-15 17:22:47 +01:00
14c366ddd7 Bump version to 3.5-beta 2021-11-05 16:10:17 +01:00
c4a3560884 Allow negative scale in Particles and CPUParticles
This can be used to make 2D particles look more 3D-y with thoughtful use
of scale curve animation.
2021-10-15 19:06:30 +02:00
f0b37b1519 doc: Point URLs to 3.4 version of the online docs 2021-08-12 17:08:10 +02:00
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
fe616d443a Fix color properties of particle nodes/material
(cherry picked from commit 3a4a2198ed)
2021-07-15 10:25:35 +02:00
c3272997cd doc: Update classref headers with 3.4 version 2021-04-26 13:15:29 +02:00
015973df04 doc: Make all tutorial links point to 3.3 branch of docs 2021-03-26 10:43:43 +01:00
1aba997d75 doc: Sync classref with 3.3 version bump 2021-03-23 13:40:34 +01:00
cec16357ef Document the requirement to update GPU particle visibility
This also updates some option names in the editor for consistency
and accuracy.

See #44955.
2021-01-06 19:17:57 +01:00
f2b04e8865 Document that changing the particle amount resets emission
See #16352.
2020-12-11 15:38:55 +01:00
4287af5148 doc: Make docs.godotengine.org links point to 3.2 branch 2020-10-19 16:10:01 +02:00
2293cf61c6 Document the expected normal map coordinate system where relevant
(cherry picked from commit d8808fba85)
2020-05-05 13:41:29 +02:00
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
c5700f7464 Complete various class references 2020-01-26 00:27:51 -08:00
ba177ccaec doc: Misc updates for AnimationNode* and others
- Add some missing descriptions.
- Add links to tutorials for ARVR and AnimationTree.
- Style fixes.
- Engine changes:
  * Make `AnimationNodeTransition.input_<number>` properties internal
    so that they don't appear in the docs. They still appear in the
    inspector based on the actual number of inputs requested.
  * Drop unimplemented `CPUParticles.flatness`. It's only used for 3D
    particles in `ParticlesMaterial`, and thus only relevant for
    `CPUParticles3D`.
2020-01-23 12:37:33 +01:00
05c8654390 doc: Timer.autostart resets to false on start
Fixes #35289.
2020-01-19 10:18:11 +01:00
1de633205f Validate input in (CPU)Particles set_emission_shape()
Fixes #29777.

Co-authored-by: Cameron Reikes <cameronreikes@gmail.com>
2020-01-16 11:08:51 +01:00
efd55631e2 doc: Sync classref with current source 2019-07-15 20:45:30 +02:00
5ef3374258 added individual particle random lifetime 2019-07-14 23:22:40 -07:00
542489a866 DocData: Re-expose parametric setters and getters
Setters and getters have been hidden from the documentation when the matching
properties have been exposed, but some of them are parametric and require the
name or index of a given parameter to be used. So they need to be properly
documented with the type and name of the arguments they take.

For example, CPUParticles' `set_param(Parameter param, float value)`.
2019-07-04 14:08:16 +02:00
266dc732ba doc: Sync classref with current source 2019-07-02 12:04:26 +02:00
26f99beac3 CPUParticles2D: Fix gravity to be the same as in Particles2D and Area2D
This was likely a typo, 10 times the standard gravity is 98.0665
(ca. 98), not 98.8.
2019-06-30 13:58:07 +02:00
a78373ddc2 doc: Remove null default values that can't be determined
Applying #30187.
2019-06-30 13:58:07 +02:00
b9aa13e591 doc: Remove hardcoded default values from descriptions
They are now generated automatically by doctool.
2019-06-30 13:58:07 +02:00
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
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
054ac5c8f5 doc: Sync classref with current source
Fix a few bugs.
2019-06-18 15:07:31 +02:00
7d1ee6d3c3 change emit shape circle to sphere in CPUParticles2D 2019-06-17 11:59:31 -07:00
9a173e5814 doc: Fix formatting, typos and some descriptions in new docstrings 2019-06-15 00:11:41 +02:00
9f7713d98b [DOCS] Update CPUParticles[2D] classref 2019-06-14 10:39:54 -07:00
52dd0f8751 Implement missing orbit velocity for CPUParticles and CPUParticles2D
The relevant code was copied from (GPU) ParticlesMaterial but commented
out initially, and never ported.

Closes #29580.
2019-06-13 11:35:07 +02:00
6af69f851a doc: Drop unused <demos> tag 2019-04-19 11:03:46 +02:00
39c868171e doc: Bump version to 3.2 2019-04-01 12:33:56 +02:00
8fda8769d1 doc: Sync classref with current source 2018-12-04 21:57:07 +01:00
0babb60c74 doc: Sync classref with current source 2018-11-10 20:21:34 +07:00
5267099a87 doc: Sync classref with current source 2018-08-29 22:25:11 +02:00