Sara/behaviour-tree-test
1
0
Fork 0
Code Issues Pull requests Projects Releases 2 Packages Wiki Activity Actions

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
No known key found for this signature in database
GPG key ID: 39E8F8BE30B0A49C
330 changed files with 2585 additions and 2474 deletions
Download patch file Download diff file Expand all files Collapse all files

26
doc/classes/EditorProperty.xml
View file

@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="EditorProperty" inherits="Container" category="Core" version="3.2">
<brief_description>
Custom control to edit properties for adding into the inspector
Custom control to edit properties for adding into the inspector.
</brief_description>
<description>
This control allows property editing for one or multiple properties into [EditorInspector]. It is added via [EditorInspectorPlugin].
@ -30,21 +30,21 @@
<argument index="3" name="changing" type="bool" default="false">
</argument>
<description>
If one (or many properties) changed, this must be called. "Field" is used in case your editor can modify fields separately (as an example, Vector3.x). The "changing" argument avoids the editor requesting this property to be refreshed (leave as false if unsure).
If one or several properties have changed, this must be called. [code]field[/code] is used in case your editor can modify fields separately (as an example, Vector3.x). The [code]changing[/code] argument avoids the editor requesting this property to be refreshed (leave as [code]false[/code] if unsure).
</description>
</method>
<method name="get_edited_object">
<return type="Object">
</return>
<description>
Get the edited object.
Gets the edited object.
</description>
</method>
<method name="get_edited_property">
<return type="String">
</return>
<description>
Get the edited property. If your editor is for a single property (added via [method EditorInspectorPlugin.parse_property]), then this will return it..
Gets the edited property. If your editor is for a single property (added via [method EditorInspectorPlugin.parse_property]), then this will return the property.
</description>
</method>
<method name="get_tooltip_text" qualifiers="const">
@ -60,7 +60,7 @@
<argument index="0" name="editor" type="Control">
</argument>
<description>
Add controls with this function if you want them on the bottom (below the label).
Adds controls with this function if you want them on the bottom (below the label).
</description>
</method>
<method name="update_property" qualifiers="virtual">
@ -82,10 +82,10 @@
Used by the inspector, when the property must draw with error color.
</member>
<member name="keying" type="bool" setter="set_keying" getter="is_keying">
Used by the inspector, when the property can add keys for animation/
Used by the inspector, when the property can add keys for animation.
</member>
<member name="label" type="String" setter="set_label" getter="get_label">
Set this property to change the label (if you want to show one)
Sets this property to change the label (if you want to show one).
</member>
<member name="read_only" type="bool" setter="set_read_only" getter="is_read_only">
Used by the inspector, when the property is read-only.
@ -98,7 +98,7 @@
<argument index="1" name="value" type="Array">
</argument>
<description>
Emit yourself if you want multiple properties modified at the same time. Do not use if added via [method EditorInspectorPlugin.parse_property]
Emit it if you want multiple properties modified at the same time. Do not use if added via [method EditorInspectorPlugin.parse_property].
</description>
</signal>
<signal name="object_id_selected">
@ -107,7 +107,7 @@
<argument index="1" name="id" type="int">
</argument>
<description>
Used by sub-inspectors. Emit if what was selected was an Object ID.
Used by sub-inspectors. Emit it if what was selected was an Object ID.
</description>
</signal>
<signal name="property_changed">
@ -125,14 +125,14 @@
<argument index="1" name="bool" type="String">
</argument>
<description>
Used internally, when a property was checked.
Emitted when a property was checked. Used internally.
</description>
</signal>
<signal name="property_keyed">
<argument index="0" name="property" type="String">
</argument>
<description>
Emit if you want to add this value as an animation key (check keying being enabled first).
Emit it if you want to add this value as an animation key (check for keying being enabled first).
</description>
</signal>
<signal name="property_keyed_with_value">
@ -141,7 +141,7 @@
<argument index="1" name="value" type="Nil">
</argument>
<description>
Emit if you want to key a property with a single value.
Emit it if you want to key a property with a single value.
</description>
</signal>
<signal name="resource_selected">
@ -159,7 +159,7 @@
<argument index="1" name="focusable_idx" type="int">
</argument>
<description>
Internal, used when selected.
Emitted when selected. Used internally.
</description>
</signal>
</signals>