godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doc: Document EncodedObjectAsID, expose its property 

(cherry picked from commit a9cff880d6)
This commit is contained in:
Rémi Verschelde 2019-06-26 10:50:45 +02:00
parent 021347e178
commit 558e268edd
3 changed files with 15 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
core/io/marshalls.cpp
View File

@ -37,13 +37,11 @@
#include <limits.h> #include <limits.h>
#include <stdio.h> #include <stdio.h>
#define _S(a) ((int32_t)a)
#define ERR_FAIL_ADD_OF(a, b, err) ERR_FAIL_COND_V(_S(b) < 0 || _S(a) < 0 || _S(a) > INT_MAX - _S(b), err)
#define ERR_FAIL_MUL_OF(a, b, err) ERR_FAIL_COND_V(_S(a) < 0 || _S(b) <= 0 || _S(a) > INT_MAX / _S(b), err)
void EncodedObjectAsID::_bind_methods() { void EncodedObjectAsID::_bind_methods() {
ClassDB::bind_method(D_METHOD("set_object_id", "id"), &EncodedObjectAsID::set_object_id); ClassDB::bind_method(D_METHOD("set_object_id", "id"), &EncodedObjectAsID::set_object_id);
ClassDB::bind_method(D_METHOD("get_object_id"), &EncodedObjectAsID::get_object_id); ClassDB::bind_method(D_METHOD("get_object_id"), &EncodedObjectAsID::get_object_id);
ADD_PROPERTY(PropertyInfo(Variant::INT, "object_id"), "set_object_id", "get_object_id");
} }
void EncodedObjectAsID::set_object_id(ObjectID p_id) { void EncodedObjectAsID::set_object_id(ObjectID p_id) {
@ -59,6 +57,10 @@ EncodedObjectAsID::EncodedObjectAsID() :
id(0) { id(0) {
} }
#define _S(a) ((int32_t)a)
#define ERR_FAIL_ADD_OF(a, b, err) ERR_FAIL_COND_V(_S(b) < 0 || _S(a) < 0 || _S(a) > INT_MAX - _S(b), err)
#define ERR_FAIL_MUL_OF(a, b, err) ERR_FAIL_COND_V(_S(a) < 0 || _S(b) <= 0 || _S(a) > INT_MAX / _S(b), err)
#define ENCODE_MASK 0xFF #define ENCODE_MASK 0xFF
#define ENCODE_FLAG_64 1 << 16 #define ENCODE_FLAG_64 1 << 16
#define ENCODE_FLAG_OBJECT_AS_ID 1 << 16 #define ENCODE_FLAG_OBJECT_AS_ID 1 << 16

22
doc/classes/EncodedObjectAsID.xml
View File

@ -1,27 +1,21 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="EncodedObjectAsID" inherits="Reference" category="Core" version="3.1.2"> <class name="EncodedObjectAsID" inherits="Reference" category="Core" version="3.1.2">
<brief_description> <brief_description>
Holds a reference to an [Object]'s instance ID.
</brief_description> </brief_description>
<description> <description>
Utility class which holds a reference to the internal identifier of an [Object] instance, as given by [method Object.get_instance_id]. This ID can then be used to retrieve the object instance with [method @GDScript.instance_from_id].
This class is used internally by the editor inspector and script debugger, but can also be used in plugins to pass and display objects as their IDs.
</description> </description>
<tutorials> <tutorials>
</tutorials> </tutorials>
<methods> <methods>
<method name="get_object_id" qualifiers="const">
<return type="int">
</return>
<description>
</description>
</method>
<method name="set_object_id">
<return type="void">
</return>
<argument index="0" name="id" type="int">
</argument>
<description>
</description>
</method>
</methods> </methods>
<members>
<member name="object_id" type="int" setter="set_object_id" getter="get_object_id">
The [Object] identifier stored in this [EncodedObjectAsID] instance. The object instance can be retrieved with [method @GDScript.instance_from_id].
</member>
</members>
<constants> <constants>
</constants> </constants>
</class> </class>

1
doc/classes/Object.xml
View File

@ -195,6 +195,7 @@
</return> </return>
<description> <description>
Returns the object's unique instance ID. Returns the object's unique instance ID.
This ID can be saved in [EncodedObjectAsID], and can be used to retrieve the object instance with [method @GDScript.instance_from_id].
</description> </description>
</method> </method>
<method name="get_meta" qualifiers="const"> <method name="get_meta" qualifiers="const">