godotengine/godot
1
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2026-01-06 10:11:57 +03:00
Code Issues Packages Projects Releases Wiki Activity

Proofread and improve the whole class reference

Browse Source 
- 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
This commit is contained in:
Hugo Locurcio
2019-06-22 01:04:47 +02:00
parent 538c8eec15
commit f7f6115f76
330 changed files with 2585 additions and 2474 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
doc/classes/Gradient.xml
View File

@@ -1,10 +1,10 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="Gradient" inherits="Resource" category="Core" version="3.2">
<brief_description>
Color interpolator node.
A color interpolator resource which can be used to generate colors between user-defined color points.
</brief_description>
<description>
Given a set of colors, this node will interpolate them in order, meaning, that if you have color 1, color 2 and color 3, the ramp will interpolate (generate the colors between two colors) from color 1 to color 2 and from color 2 to color 3. Initially the ramp will have 2 colors (black and white), one (black) at ramp lower offset 0 and the other (white) at the ramp higher offset 1.
Given a set of colors, this resource will interpolate them in order. This means that if you have color 1, color 2 and color 3, the ramp will interpolate from color 1 to color 2 and from color 2 to color 3. The ramp will initially have 2 colors (black and white), one (black) at ramp lower offset 0 and the other (white) at the ramp higher offset 1.
</description>
<tutorials>
</tutorials>
@@ -17,7 +17,7 @@
<argument index="1" name="color" type="Color">
</argument>
<description>
Adds the specified color to the end of the ramp, with the specified offset
Adds the specified color to the end of the ramp, with the specified offset.
</description>
</method>
<method name="get_color" qualifiers="const">
@@ -26,7 +26,7 @@
<argument index="0" name="point" type="int">
</argument>
<description>
Returns the color of the ramp color at index [i]point[/i]
Returns the color of the ramp color at index [code]point[/code].
</description>
</method>
<method name="get_offset" qualifiers="const">
@@ -35,14 +35,14 @@
<argument index="0" name="point" type="int">
</argument>
<description>
Returns the offset of the ramp color at index [i]point[/i]
Returns the offset of the ramp color at index [code]point[/code].
</description>
</method>
<method name="get_point_count" qualifiers="const">
<return type="int">
</return>
<description>
Returns the number of colors in the ramp
Returns the number of colors in the ramp.
</description>
</method>
<method name="interpolate">
@@ -51,7 +51,7 @@
<argument index="0" name="offset" type="float">
</argument>
<description>
Returns the interpolated color specified by [i]offset[/i]
Returns the interpolated color specified by [code]offset[/code].
</description>
</method>
<method name="remove_point">
@@ -60,7 +60,7 @@
<argument index="0" name="offset" type="int">
</argument>
<description>
Removes the color at the index [i]offset[/i]
Removes the color at the index [code]offset[/code].
</description>
</method>
<method name="set_color">
@@ -71,7 +71,7 @@
<argument index="1" name="color" type="Color">
</argument>
<description>
Sets the color of the ramp color at index [i]point[/i]
Sets the color of the ramp color at index [code]point[/code].
</description>
</method>
<method name="set_offset">
@@ -82,7 +82,7 @@
<argument index="1" name="offset" type="float">
</argument>
<description>
Sets the offset for the ramp color at index [i]point[/i]
Sets the offset for the ramp color at index [code]point[/code].
</description>
</method>
</methods>