summaryrefslogtreecommitdiffstats
path: root/doc/classes/LargeTexture.xml
diff options
context:
space:
mode:
authorHugo Locurcio <hugo.locurcio@hugo.pro>2019-06-22 01:04:47 +0200
committerHugo Locurcio <hugo.locurcio@hugo.pro>2019-06-27 22:30:19 +0200
commitf7f6115f7627df24a08a9a0882b2f573cc838eb1 (patch)
tree03fd75145084c88702dbbb7e54c42c7c02d54fa6 /doc/classes/LargeTexture.xml
parent538c8eec15d72b67e102f47f9df7624c29d14607 (diff)
downloadredot-engine-f7f6115f7627df24a08a9a0882b2f573cc838eb1.tar.gz
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
Diffstat (limited to 'doc/classes/LargeTexture.xml')
-rw-r--r--doc/classes/LargeTexture.xml16
1 files changed, 8 insertions, 8 deletions
diff --git a/doc/classes/LargeTexture.xml b/doc/classes/LargeTexture.xml
index 4611bc228e..b4267f55f0 100644
--- a/doc/classes/LargeTexture.xml
+++ b/doc/classes/LargeTexture.xml
@@ -1,11 +1,11 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="LargeTexture" inherits="Texture" category="Core" version="3.2">
<brief_description>
- A Texture capable of storing many smaller Textures with offsets.
+ A [Texture] capable of storing many smaller textures with offsets.
</brief_description>
<description>
- A Texture capable of storing many smaller Textures with offsets.
- You can dynamically add pieces([Texture]) to this [LargeTexture] using different offsets.
+ A [Texture] capable of storing many smaller textures with offsets.
+ You can dynamically add pieces ([Texture]s) to this [LargeTexture] using different offsets.
</description>
<tutorials>
</tutorials>
@@ -18,7 +18,7 @@
<argument index="1" name="texture" type="Texture">
</argument>
<description>
- Add another [Texture] to this [LargeTexture], starting on offset "ofs".
+ Adds [code]texture[/code] to this [LargeTexture], starting on offset [code]ofs[/code].
</description>
</method>
<method name="clear">
@@ -41,7 +41,7 @@
<argument index="0" name="idx" type="int">
</argument>
<description>
- Returns the offset of the piece with index "idx".
+ Returns the offset of the piece with the index [code]idx[/code].
</description>
</method>
<method name="get_piece_texture" qualifiers="const">
@@ -50,7 +50,7 @@
<argument index="0" name="idx" type="int">
</argument>
<description>
- Returns the [Texture] of the piece with index "idx".
+ Returns the [Texture] of the piece with the index [code]idx[/code].
</description>
</method>
<method name="set_piece_offset">
@@ -61,7 +61,7 @@
<argument index="1" name="ofs" type="Vector2">
</argument>
<description>
- Sets the offset of the piece with index "idx" to "ofs".
+ Sets the offset of the piece with the index [code]idx[/code] to [code]ofs[/code].
</description>
</method>
<method name="set_piece_texture">
@@ -72,7 +72,7 @@
<argument index="1" name="texture" type="Texture">
</argument>
<description>
- Sets the [Texture] of the piece with index "idx" to "texture".
+ Sets the [Texture] of the piece with index [code]idx[/code] to [code]texture[/code].
</description>
</method>
<method name="set_size">