asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Merge pull request #2898 from est31/string_byte_format_doc

Browse source 
Document string <-> byte conversion methods
This commit is contained in:
Rémi Verschelde 2015-11-24 08:36:12 +01:00
commit 14145d516e
2 changed files with 13 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
core/variant_call.cpp
View file

@ -1291,8 +1291,8 @@ _VariantCall::addfunc(Variant::m_vtype,Variant::m_ret,_SCS(#m_method),VCALL(m_cl
ADDFUNC1(STRING,STRING,String,pad_decimals,INT,"digits",varray());
ADDFUNC1(STRING,STRING,String,pad_zeros,INT,"digits",varray());
ADDFUNC0(STRING,STRING,String,to_ascii,varray());
ADDFUNC0(STRING,STRING,String,to_utf8,varray());
ADDFUNC0(STRING,RAW_ARRAY,String,to_ascii,varray());
ADDFUNC0(STRING,RAW_ARRAY,String,to_utf8,varray());
ADDFUNC0(VECTOR2,VECTOR2,Vector2,normalized,varray());

8
doc/base/classes.xml
View file

@ -26372,12 +26372,14 @@ This method controls whether the position between two cached points is interpola
<return type="String">
</return>
<description>
Returns a copy of the array's contents formatted as String. Fast alternative to get_string_from_utf8(), assuming the content is ASCII-only (unlike the UTF-8 function, this function maps every byte to a character in the string, so any multibyte sequence will be torn apart).
</description>
</method>
<method name="get_string_from_utf8">
<return type="String">
</return>
<description>
Returns a copy of the array's contents formatted as String, assuming the array is formatted as UTF-8. Slower than get_string_from_ascii(), but works for UTF-8. Usually you should prefer this function over get_string_from_ascii() to support international input.
</description>
</method>
<method name="push_back">
@ -33134,9 +33136,10 @@ This method controls whether the position between two cached points is interpola
</description>
</method>
<method name="to_ascii">
<return type="String">
<return type="RawArray">
</return>
<description>
Convert the String (which is a character array) to RawArray (which is an array of bytes). The conversion is speeded up in comparison to to_utf8() with the assumption that all the characters the String contains are only ASCII characters.
</description>
</method>
<method name="to_float">
@ -33168,9 +33171,10 @@ This method controls whether the position between two cached points is interpola
</description>
</method>
<method name="to_utf8">
<return type="String">
<return type="RawArray">
</return>
<description>
Convert the String (which is an array of characters) to RawArray (which is an array of bytes). The conversion is a bit slower than to_ascii(), but supports all UTF-8 characters. Therefore, you should prefer this function over to_ascii().
</description>
</method>
<method name="xml_escape">