godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-05 22:09:56 +03:00
Code Issues Packages Projects Releases Wiki Activity

Drop extraneous escapes before underscores

Browse Source
This commit is contained in:
Rémi Verschelde
2016-02-10 18:57:06 +01:00
parent 948eaa07fe
commit 411a9e5ce6
48 changed files with 344 additions and 344 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
reference/binary_serialization_api.rst
View File

@@ -312,7 +312,7 @@ This field is padded to 4 bytes.
+---------------------+-------+-----------+--------------------------------------------------+
| Offset | Len | Type | Description |
+=====================+=======+===========+==================================================+
| 4 | 4 | Integer | Format (see FORMAT\_\* in "Image":class\_image |
| 4 | 4 | Integer | Format (see FORMAT\_\* in "Image":class_image |
+---------------------+-------+-----------+--------------------------------------------------+
| 8 | 4 | Integer | Mip-Maps (0 means no mip-maps). |
+---------------------+-------+-----------+--------------------------------------------------+
@@ -463,8 +463,8 @@ Every string is is padded to 4 bytes.
+===========================================+=======+===========+================+
| 4 | 4 | Integer | Array Length |
+-------------------------------------------+-------+-----------+----------------+
| 8..8+length\_8\|4\|Float\| X Coordinate | 4 | Float | Y Coordinate |
| 8..12+length\_8 | | | |
| 8..8+length_8\|4\|Float\| X Coordinate | 4 | Float | Y Coordinate |
| 8..12+length_8 | | | |
+-------------------------------------------+-------+-----------+----------------+
27: vector3 array
@@ -473,8 +473,8 @@ Every string is is padded to 4 bytes.
| Offset \| Len \| Type \| Description
| -- \| -- \| -- \| --
| 4\|4\|Integer\| Array Length
| 8..8+length\_12\|4\|Float\| X Coordinate
| 8..12+length\_12\|4\|Float\| Y Coordinate
| 8..8+length_12\|4\|Float\| X Coordinate
| 8..12+length_12\|4\|Float\| Y Coordinate
| 8..16+length\*12\|4\|Float\| Z Coordinate
28: color array
@@ -485,9 +485,9 @@ Every string is is padded to 4 bytes.
+============================================+=======+===========+================+
| 4 | 4 | Integer | Array Length |
+--------------------------------------------+-------+-----------+----------------+
| 8..8+length\_16\|4\|Float\| Red (0..1) | 4 | Float | Green (0..1) |
| 8..12+length\_16 | | | |
| 8..8+length_16\|4\|Float\| Red (0..1) | 4 | Float | Green (0..1) |
| 8..12+length_16 | | | |
+--------------------------------------------+-------+-----------+----------------+
| 8..16+length\_16\|4\|Float\| Blue (0..1) | 4 | Float | Alpha (0..1) |
| 8..20+length\_16 | | | |
| 8..16+length_16\|4\|Float\| Blue (0..1) | 4 | Float | Alpha (0..1) |
| 8..20+length_16 | | | |
+--------------------------------------------+-------+-----------+----------------+

10
reference/compiling_for_android.rst
View File

@@ -28,10 +28,10 @@ For compiling under Windows, the following is required:
Setting Up SCons
----------------
Set the environment variable ANDROID\_HOME to point to the Android
Set the environment variable ANDROID_HOME to point to the Android
SDK.
Set the environment variable ANDROID\_NDK\_ROOT to point to the
Set the environment variable ANDROID_NDK_ROOT to point to the
Android NDK.
To set those environment variables on Windows, press Windows+R, type
@@ -78,12 +78,12 @@ alternatively if you are under unix you can symlink:
user@host:~/godot$ ln -s bin/libgodot.android..so platform/android/java/libs/armeabi/libgodot_android.so
Remember that only *one* of libgodot\_android.so must exist for each
Remember that only *one* of libgodot_android.so must exist for each
platform, for each build type (release, debug, etc), it must be
replaced.
**Note**: The file inside libs/armeabi must be renamed to
**"libgodot\_android.so"**, or else unsatisfied link error will happen
**"libgodot_android.so"**, or else unsatisfied link error will happen
at runtime.
If you also want to include support for x86 Android, add the following
@@ -221,7 +221,7 @@ Application exits immediately
If the application runs but exits immediately, there might be one of the
following reasons:
- libgodot\_android.so is not in libs/armeabi
- libgodot_android.so is not in libs/armeabi
- Device does not support armv7 (try compiling yourself for armv6)
- Device is Intel, and apk is compiled for ARM.

10
reference/core_types.rst
View File

@@ -26,10 +26,10 @@ one cycle. It makes code more readable too.
For files or memory sizes, ``size_t`` is used, which is warranted to be
64 bits.
For Unicode characters, CharType instead of wchar\_t is used, because
many architectures have 4 bytes long wchar\_t, where 2 bytes might be
For Unicode characters, CharType instead of wchar_t is used, because
many architectures have 4 bytes long wchar_t, where 2 bytes might be
desired. However, by default, this has not been forced and CharType maps
directly to wchar\_t.
directly to wchar_t.
References:
~~~~~~~~~~~
@@ -198,7 +198,7 @@ is fast.
References:
~~~~~~~~~~~
- `core/string\_db.h <https://github.com/okamstudio/godot/blob/master/core/string_db.h>`__
- `core/string_db.h <https://github.com/okamstudio/godot/blob/master/core/string_db.h>`__
Math types
----------
@@ -220,7 +220,7 @@ referencing them fast.
References:
~~~~~~~~~~~
- `core/path\_db.h <https://github.com/okamstudio/godot/blob/master/core/path_db.h>`__
- `core/path_db.h <https://github.com/okamstudio/godot/blob/master/core/path_db.h>`__
RID
---

2
reference/creating_android_modules.rst
View File

@@ -306,7 +306,7 @@ Godot crashes upon load
Check ``adb logcat`` for possible problems, then:
- Make sure libgodot\_android.so is in the libs/armeabi folder
- Make sure libgodot_android.so is in the libs/armeabi folder
- Check that the methods used in the Java singleton only use simple
Java datatypes, more complex ones are not supported.

4
reference/gdscript.rst
View File

@@ -819,7 +819,7 @@ Setters/Getters
It is often useful to know when an member variable changed. It may
also be desired to encapsulate its access. For this, GDScript provides
a *setter\_/\_getter* helper using the ``setget`` keyword.
a *setter_/_getter* helper using the ``setget`` keyword.
Just add it at the end of the variable definition line like this:
@@ -966,7 +966,7 @@ single callback and the sender must be identified:
b.connect("pressed",self,"_button_pressed",[b])
Finally, emitting a custom signal is done by using the
Object.emit\_signal method:
Object.emit_signal method:
::

2
reference/introduction_to_the_buildsystem.rst
View File

@@ -141,7 +141,7 @@ Target controls optimization and debug flags. Each mode means:
- **debug**: Build with C++ debugging symbols, runtime checks (performs
checks and reports error) and none to little optimization.
- **release\_debug**: Build without C++ debugging symbols and
- **release_debug**: Build without C++ debugging symbols and
optimization, but keep the runtime checks (performs checks and
reports errors). Official binaries use this configuration.
- **release**: Build without symbols, with optimization and with little

218
reference/locales.rst
View File

@@ -11,307 +11,307 @@ based on the Unix standard locale strings:
+==============+====================================+
| ar | Arabic |
+--------------+------------------------------------+
| ar\_AE | Arabic (United Arab Emirates) |
| ar_AE | Arabic (United Arab Emirates) |
+--------------+------------------------------------+
| ar\_BH | Arabic (Bahrain) |
| ar_BH | Arabic (Bahrain) |
+--------------+------------------------------------+
| ar\_DZ | Arabic (Algeria) |
| ar_DZ | Arabic (Algeria) |
+--------------+------------------------------------+
| ar\_EG | Arabic (Egypt) |
| ar_EG | Arabic (Egypt) |
+--------------+------------------------------------+
| ar\_IQ | Arabic (Iraq) |
| ar_IQ | Arabic (Iraq) |
+--------------+------------------------------------+
| ar\_JO | Arabic (Jordan) |
| ar_JO | Arabic (Jordan) |
+--------------+------------------------------------+
| ar\_KW | Arabic (Kuwait) |
| ar_KW | Arabic (Kuwait) |
+--------------+------------------------------------+
| ar\_LB | Arabic (Lebanon) |
| ar_LB | Arabic (Lebanon) |
+--------------+------------------------------------+
| ar\_LY | Arabic (Libya) |
| ar_LY | Arabic (Libya) |
+--------------+------------------------------------+
| ar\_MA | Arabic (Morocco) |
| ar_MA | Arabic (Morocco) |
+--------------+------------------------------------+
| ar\_OM | Arabic (Oman) |
| ar_OM | Arabic (Oman) |
+--------------+------------------------------------+
| ar\_QA | Arabic (Qatar) |
| ar_QA | Arabic (Qatar) |
+--------------+------------------------------------+
| ar\_SA | Arabic (Saudi Arabia) |
| ar_SA | Arabic (Saudi Arabia) |
+--------------+------------------------------------+
| ar\_SD | Arabic (Sudan) |
| ar_SD | Arabic (Sudan) |
+--------------+------------------------------------+
| ar\_SY | Arabic (Syria) |
| ar_SY | Arabic (Syria) |
+--------------+------------------------------------+
| ar\_TN | Arabic (Tunisia) |
| ar_TN | Arabic (Tunisia) |
+--------------+------------------------------------+
| ar\_YE | Arabic (Yemen) |
| ar_YE | Arabic (Yemen) |
+--------------+------------------------------------+
| be | Belarusian |
+--------------+------------------------------------+
| be\_BY | Belarusian (Belarus) |
| be_BY | Belarusian (Belarus) |
+--------------+------------------------------------+
| bg | Bulgarian |
+--------------+------------------------------------+
| bg\_BG | Bulgarian (Bulgaria) |
| bg_BG | Bulgarian (Bulgaria) |
+--------------+------------------------------------+
| ca | Catalan |
+--------------+------------------------------------+
| ca\_ES | Catalan (Spain) |
| ca_ES | Catalan (Spain) |
+--------------+------------------------------------+
| cs | Czech |
+--------------+------------------------------------+
| cs\_CZ | Czech (Czech Republic) |
| cs_CZ | Czech (Czech Republic) |
+--------------+------------------------------------+
| da | Danish |
+--------------+------------------------------------+
| da\_DK | Danish (Denmark) |
| da_DK | Danish (Denmark) |
+--------------+------------------------------------+
| de | German |
+--------------+------------------------------------+
| de\_AT | German (Austria) |
| de_AT | German (Austria) |
+--------------+------------------------------------+
| de\_CH | German (Switzerland) |
| de_CH | German (Switzerland) |
+--------------+------------------------------------+
| de\_DE | German (Germany) |
| de_DE | German (Germany) |
+--------------+------------------------------------+
| de\_LU | German (Luxembourg) |
| de_LU | German (Luxembourg) |
+--------------+------------------------------------+
| el | Greek |
+--------------+------------------------------------+
| el\_CY | Greek (Cyprus) |
| el_CY | Greek (Cyprus) |
+--------------+------------------------------------+
| el\_GR | Greek (Greece) |
| el_GR | Greek (Greece) |
+--------------+------------------------------------+
| en | English |
+--------------+------------------------------------+
| en\_AU | English (Australia) |
| en_AU | English (Australia) |
+--------------+------------------------------------+
| en\_CA | English (Canada) |
| en_CA | English (Canada) |
+--------------+------------------------------------+
| en\_GB | English (United Kingdom) |
| en_GB | English (United Kingdom) |
+--------------+------------------------------------+
| en\_IE | English (Ireland) |
| en_IE | English (Ireland) |
+--------------+------------------------------------+
| en\_IN | English (India) |
| en_IN | English (India) |
+--------------+------------------------------------+
| en\_MT | English (Malta) |
| en_MT | English (Malta) |
+--------------+------------------------------------+
| en\_NZ | English (New Zealand) |
| en_NZ | English (New Zealand) |
+--------------+------------------------------------+
| en\_PH | English (Philippines) |
| en_PH | English (Philippines) |
+--------------+------------------------------------+
| en\_SG | English (Singapore) |
| en_SG | English (Singapore) |
+--------------+------------------------------------+
| en\_US | English (United States) |
| en_US | English (United States) |
+--------------+------------------------------------+
| en\_ZA | English (South Africa) |
| en_ZA | English (South Africa) |
+--------------+------------------------------------+
| es | Spanish |
+--------------+------------------------------------+
| es\_AR | Spanish (Argentina) |
| es_AR | Spanish (Argentina) |
+--------------+------------------------------------+
| es\_BO | Spanish (Bolivia) |
| es_BO | Spanish (Bolivia) |
+--------------+------------------------------------+
| es\_CL | Spanish (Chile) |
| es_CL | Spanish (Chile) |
+--------------+------------------------------------+
| es\_CO | Spanish (Colombia) |
| es_CO | Spanish (Colombia) |
+--------------+------------------------------------+
| es\_CR | Spanish (Costa Rica) |
| es_CR | Spanish (Costa Rica) |
+--------------+------------------------------------+
| es\_DO | Spanish (Dominican Republic) |
| es_DO | Spanish (Dominican Republic) |
+--------------+------------------------------------+
| es\_EC | Spanish (Ecuador) |
| es_EC | Spanish (Ecuador) |
+--------------+------------------------------------+
| es\_ES | Spanish (Spain) |
| es_ES | Spanish (Spain) |
+--------------+------------------------------------+
| es\_GT | Spanish (Guatemala) |
| es_GT | Spanish (Guatemala) |
+--------------+------------------------------------+
| es\_HN | Spanish (Honduras) |
| es_HN | Spanish (Honduras) |
+--------------+------------------------------------+
| es\_MX | Spanish (Mexico) |
| es_MX | Spanish (Mexico) |
+--------------+------------------------------------+
| es\_NI | Spanish (Nicaragua) |
| es_NI | Spanish (Nicaragua) |
+--------------+------------------------------------+
| es\_PA | Spanish (Panama) |
| es_PA | Spanish (Panama) |
+--------------+------------------------------------+
| es\_PE | Spanish (Peru) |
| es_PE | Spanish (Peru) |
+--------------+------------------------------------+
| es\_PR | Spanish (Puerto Rico) |
| es_PR | Spanish (Puerto Rico) |
+--------------+------------------------------------+
| es\_PY | Spanish (Paraguay) |
| es_PY | Spanish (Paraguay) |
+--------------+------------------------------------+
| es\_SV | Spanish (El Salvador) |
| es_SV | Spanish (El Salvador) |
+--------------+------------------------------------+
| es\_US | Spanish (United States) |
| es_US | Spanish (United States) |
+--------------+------------------------------------+
| es\_UY | Spanish (Uruguay) |
| es_UY | Spanish (Uruguay) |
+--------------+------------------------------------+
| es\_VE | Spanish (Venezuela) |
| es_VE | Spanish (Venezuela) |
+--------------+------------------------------------+
| et | Estonian |
+--------------+------------------------------------+
| et\_EE | Estonian (Estonia) |
| et_EE | Estonian (Estonia) |
+--------------+------------------------------------+
| fi | Finnish |
+--------------+------------------------------------+
| fi\_FI | Finnish (Finland) |
| fi_FI | Finnish (Finland) |
+--------------+------------------------------------+
| fr | French |
+--------------+------------------------------------+
| fr\_BE | French (Belgium) |
| fr_BE | French (Belgium) |
+--------------+------------------------------------+
| fr\_CA | French (Canada) |
| fr_CA | French (Canada) |
+--------------+------------------------------------+
| fr\_CH | French (Switzerland) |
| fr_CH | French (Switzerland) |
+--------------+------------------------------------+
| fr\_FR | French (France) |
| fr_FR | French (France) |
+--------------+------------------------------------+
| fr\_LU | French (Luxembourg) |
| fr_LU | French (Luxembourg) |
+--------------+------------------------------------+
| ga | Irish |
+--------------+------------------------------------+
| ga\_IE | Irish (Ireland) |
| ga_IE | Irish (Ireland) |
+--------------+------------------------------------+
| hi | Hindi (India) |
+--------------+------------------------------------+
| hi\_IN | Hindi (India) |
| hi_IN | Hindi (India) |
+--------------+------------------------------------+
| hr | Croatian |
+--------------+------------------------------------+
| hr\_HR | Croatian (Croatia) |
| hr_HR | Croatian (Croatia) |
+--------------+------------------------------------+
| hu | Hungarian |
+--------------+------------------------------------+
| hu\_HU | Hungarian (Hungary) |
| hu_HU | Hungarian (Hungary) |
+--------------+------------------------------------+
| in | Indonesian |
+--------------+------------------------------------+
| in\_ID | Indonesian (Indonesia) |
| in_ID | Indonesian (Indonesia) |
+--------------+------------------------------------+
| is | Icelandic |
+--------------+------------------------------------+
| is\_IS | Icelandic (Iceland) |
| is_IS | Icelandic (Iceland) |
+--------------+------------------------------------+
| it | Italian |
+--------------+------------------------------------+
| it\_CH | Italian (Switzerland) |
| it_CH | Italian (Switzerland) |
+--------------+------------------------------------+
| it\_IT | Italian (Italy) |
| it_IT | Italian (Italy) |
+--------------+------------------------------------+
| iw | Hebrew |
+--------------+------------------------------------+
| iw\_IL | Hebrew (Israel) |
| iw_IL | Hebrew (Israel) |
+--------------+------------------------------------+
| ja | Japanese |
+--------------+------------------------------------+
| ja\_JP | Japanese (Japan) |
| ja_JP | Japanese (Japan) |
+--------------+------------------------------------+
| ja\_JP\_JP | Japanese (Japan,JP) |
| ja_JP_JP | Japanese (Japan,JP) |
+--------------+------------------------------------+
| ko | Korean |
+--------------+------------------------------------+
| ko\_KR | Korean (South Korea) |
| ko_KR | Korean (South Korea) |
+--------------+------------------------------------+
| lt | Lithuanian |
+--------------+------------------------------------+
| lt\_LT | Lithuanian (Lithuania) |
| lt_LT | Lithuanian (Lithuania) |
+--------------+------------------------------------+
| lv | Latvian |
+--------------+------------------------------------+
| lv\_LV | Latvian (Latvia) |
| lv_LV | Latvian (Latvia) |
+--------------+------------------------------------+
| mk | Macedonian |
+--------------+------------------------------------+
| mk\_MK | Macedonian (Macedonia) |
| mk_MK | Macedonian (Macedonia) |
+--------------+------------------------------------+
| ms | Malay |
+--------------+------------------------------------+
| ms\_MY | Malay (Malaysia) |
| ms_MY | Malay (Malaysia) |
+--------------+------------------------------------+
| mt | Maltese |
+--------------+------------------------------------+
| mt\_MT | Maltese (Malta) |
| mt_MT | Maltese (Malta) |
+--------------+------------------------------------+
| nl | Dutch |
+--------------+------------------------------------+
| nl\_BE | Dutch (Belgium) |
| nl_BE | Dutch (Belgium) |
+--------------+------------------------------------+
| nl\_NL | Dutch (Netherlands) |
| nl_NL | Dutch (Netherlands) |
+--------------+------------------------------------+
| no | Norwegian |
+--------------+------------------------------------+
| no\_NO | Norwegian (Norway) |
| no_NO | Norwegian (Norway) |
+--------------+------------------------------------+
| no\_NO\_NY | Norwegian (Norway,Nynorsk) |
| no_NO_NY | Norwegian (Norway,Nynorsk) |
+--------------+------------------------------------+
| pl | Polish |
+--------------+------------------------------------+
| pl\_PL | Polish (Poland) |
| pl_PL | Polish (Poland) |
+--------------+------------------------------------+
| pt | Portuguese |
+--------------+------------------------------------+
| pt\_BR | Portuguese (Brazil) |
| pt_BR | Portuguese (Brazil) |
+--------------+------------------------------------+
| pt\_PT | Portuguese (Portugal) |
| pt_PT | Portuguese (Portugal) |
+--------------+------------------------------------+
| ro | Romanian |
+--------------+------------------------------------+
| ro\_RO | Romanian (Romania) |
| ro_RO | Romanian (Romania) |
+--------------+------------------------------------+
| ru | Russian |
+--------------+------------------------------------+
| ru\_RU | Russian (Russia) |
| ru_RU | Russian (Russia) |
+--------------+------------------------------------+
| sk | Slovak |
+--------------+------------------------------------+
| sk\_SK | Slovak (Slovakia) |
| sk_SK | Slovak (Slovakia) |
+--------------+------------------------------------+
| sl | Slovenian |
+--------------+------------------------------------+
| sl\_SI | Slovenian (Slovenia) |
| sl_SI | Slovenian (Slovenia) |
+--------------+------------------------------------+
| sq | Albanian |
+--------------+------------------------------------+
| sq\_AL | Albanian (Albania) |
| sq_AL | Albanian (Albania) |
+--------------+------------------------------------+
| sr | Serbian |
+--------------+------------------------------------+
| sr\_BA | Serbian (Bosnia and Herzegovina) |
| sr_BA | Serbian (Bosnia and Herzegovina) |
+--------------+------------------------------------+
| sr\_CS | Serbian (Serbia and Montenegro) |
| sr_CS | Serbian (Serbia and Montenegro) |
+--------------+------------------------------------+
| sr\_ME | Serbian (Montenegro) |
| sr_ME | Serbian (Montenegro) |
+--------------+------------------------------------+
| sr\_RS | Serbian (Serbia) |
| sr_RS | Serbian (Serbia) |
+--------------+------------------------------------+
| sv | Swedish |
+--------------+------------------------------------+
| sv\_SE | Swedish (Sweden) |
| sv_SE | Swedish (Sweden) |
+--------------+------------------------------------+
| th | Thai |
+--------------+------------------------------------+
| th\_TH | Thai (Thailand) |
| th_TH | Thai (Thailand) |
+--------------+------------------------------------+
| th\_TH\_TH | Thai (Thailand,TH) |
| th_TH_TH | Thai (Thailand,TH) |
+--------------+------------------------------------+
| tr | Turkish |
+--------------+------------------------------------+
| tr\_TR | Turkish (Turkey) |
| tr_TR | Turkish (Turkey) |
+--------------+------------------------------------+
| uk | Ukrainian |
+--------------+------------------------------------+
| uk\_UA | Ukrainian (Ukraine) |
| uk_UA | Ukrainian (Ukraine) |
+--------------+------------------------------------+
| vi | Vietnamese |
+--------------+------------------------------------+
| vi\_VN | Vietnamese (Vietnam) |
| vi_VN | Vietnamese (Vietnam) |
+--------------+------------------------------------+
| zh | Chinese |
+--------------+------------------------------------+
| zh\_CN | Chinese (China) |
| zh_CN | Chinese (China) |
+--------------+------------------------------------+
| zh\_HK | Chinese (Hong Kong) |
| zh_HK | Chinese (Hong Kong) |
+--------------+------------------------------------+
| zh\_SG | Chinese (Singapore) |
| zh_SG | Chinese (Singapore) |
+--------------+------------------------------------+
| zh\_TW | Chinese (Taiwan) |
| zh_TW | Chinese (Taiwan) |
+--------------+------------------------------------+

8
reference/object_class.rst
View File

@@ -85,7 +85,7 @@ string passing the name can be passed for brevity.
References:
~~~~~~~~~~~
- `core/object\_type\_db.h <https://github.com/okamstudio/godot/blob/master/core/object_type_db.h>`__
- `core/object_type_db.h <https://github.com/okamstudio/godot/blob/master/core/object_type_db.h>`__
Constants
---------
@@ -146,7 +146,7 @@ or
This is a string property, can take any string but the editor will only
allow the defined hint ones. Since no hint flags were specified, the
default ones are PROPERTY\_USAGE\_STORAGE and PROPERTY\_USAGE\_EDITOR.
default ones are PROPERTY_USAGE_STORAGE and PROPERTY_USAGE_EDITOR.
There are plenty of hints and usages available in object.h, give them a
check.
@@ -285,7 +285,7 @@ the same time.
References:
~~~~~~~~~~~
- `core/io/resource\_loader.h <https://github.com/okamstudio/godot/blob/master/core/io/resource_loader.h>`__
- `core/io/resource_loader.h <https://github.com/okamstudio/godot/blob/master/core/io/resource_loader.h>`__
Resource saving
---------------
@@ -304,4 +304,4 @@ be bundled with the saved resource and assigned sub-IDs, like
References:
~~~~~~~~~~~
- `core/io/resource\_saver.h <https://github.com/okamstudio/godot/blob/master/core/io/resource_saver.h>`__
- `core/io/resource_saver.h <https://github.com/okamstudio/godot/blob/master/core/io/resource_saver.h>`__

22
reference/services_for_ios.rst
View File

@@ -45,7 +45,7 @@ the 'pending events' queue. Example:
show_error()
Remember that when a call returns OK, the API will *always* produce an
event through the pending\_event interface, even if it's an error, or a
event through the pending_event interface, even if it's an error, or a
network timeout, etc. You should be able to, for example, safely block
the interface waiting for a reply from the server. If any of the APIs
don't behave this way it should be treated as a bug.
@@ -61,7 +61,7 @@ The pending event interface consists of 2 methods:
Store Kit
---------
Implemented in platform/iphone/in\_app\_store.mm
Implemented in platform/iphone/in_app_store.mm
The Store Kit API is accessible through the "InAppStore" singleton (will
always be available from gdscript). It is initialized automatically. It
@@ -70,7 +70,7 @@ has 2 methods for purchasing:
- ``Error purchase(Variant p_params);``
- ``Error request_product_info(Variant p_params);``
and the pending\_event interface
and the pending_event interface
::
@@ -117,7 +117,7 @@ On success:
"product_id": "the product id requested"
}
request\_product\_info
request_product_info
~~~~~~~~~~~~~~~~~~~~~~
Requests the product info on a list of product IDs.
@@ -153,7 +153,7 @@ The response event will be a dictionary with the following fields:
Game Center
-----------
Implemented in platform/iphone/game\_center.mm
Implemented in platform/iphone/game_center.mm
The Game Center API is available through the "GameCenter" singleton. It
has 6 methods:
@@ -167,7 +167,7 @@ has 6 methods:
plus the standard pending event interface.
post\_score
post_score
~~~~~~~~~~~
Posts a score to a Game Center leaderboard.
@@ -211,7 +211,7 @@ On success:
"result": "ok",
}
award\_achievement
award_achievement
~~~~~~~~~~~~~~~~~~
Modifies the progress of a Game Center achievement.
@@ -257,7 +257,7 @@ On success:
"result": "ok",
}
reset\_achievements
reset_achievements
~~~~~~~~~~~~~~~~~~~
Clears all Game Center achievements. The function takes no parameters.
@@ -286,7 +286,7 @@ On success:
"result": "ok",
}
request\_achievements
request_achievements
~~~~~~~~~~~~~~~~~~~~~
Request all the Game Center achievements the player has made progress
@@ -318,7 +318,7 @@ On success:
"progress": [ list of the progress made on each achievement ]
}
request\_achievement\_descriptions
request_achievement_descriptions
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Request the descriptions of all existing Game Center achievements
@@ -355,7 +355,7 @@ On success:
"replayable": [ list of booleans indicating whether each achievement can be earned more than once ]
}
show\_game\_center
show_game_center
~~~~~~~~~~~~~~~~~~
Displays the built in Game Center overlay showing leaderboards,

130
reference/shading_language.rst
View File

@@ -147,37 +147,37 @@ follows:
| \| float *asin*\ ( float ) \| arc-Sine \|
| \| float *acos*\ ( float ) \| arc-Cosine \|
| \| float *atan*\ ( float ) \| arc-Tangent \|
| \| vec\_type *pow*\ ( vec\_type, float ) \| Power \|
| \| vec\_type *pow*\ ( vec\_type, vec\_type ) \| Power (Vec. Exponent)
| \| vec_type *pow*\ ( vec_type, float ) \| Power \|
| \| vec_type *pow*\ ( vec_type, vec_type ) \| Power (Vec. Exponent)
\|
| \| vec\_type *exp*\ ( vec\_type ) \| Base-e Exponential \|
| \| vec\_type *log*\ ( vec\_type ) \| Natural Logarithm \|
| \| vec\_type *sqrt*\ ( vec\_type ) \| Square Root \|
| \| vec\_type *abs*\ ( vec\_type ) \| Absolute \|
| \| vec\_type *sign*\ ( vec\_type ) \| Sign \|
| \| vec\_type *floor*\ ( vec\_type ) \| Floor \|
| \| vec\_type *trunc*\ ( vec\_type ) \| Trunc \|
| \| vec\_type *ceil*\ ( vec\_type ) \| Ceiling \|
| \| vec\_type *fract*\ ( vec\_type ) \| Fractional \|
| \| vec\_type *mod*\ ( vec\_type,vec\_type ) \| Remainder \|
| \| vec\_type *min*\ ( vec\_type,vec\_type ) \| Minimum \|
| \| vec\_type *min*\ ( vec\_type,vec\_type ) \| Maximum \|
| \| vec\_type *clamp*\ ( vec\_type value,vec\_type min, vec\_type max )
| \| vec_type *exp*\ ( vec_type ) \| Base-e Exponential \|
| \| vec_type *log*\ ( vec_type ) \| Natural Logarithm \|
| \| vec_type *sqrt*\ ( vec_type ) \| Square Root \|
| \| vec_type *abs*\ ( vec_type ) \| Absolute \|
| \| vec_type *sign*\ ( vec_type ) \| Sign \|
| \| vec_type *floor*\ ( vec_type ) \| Floor \|
| \| vec_type *trunc*\ ( vec_type ) \| Trunc \|
| \| vec_type *ceil*\ ( vec_type ) \| Ceiling \|
| \| vec_type *fract*\ ( vec_type ) \| Fractional \|
| \| vec_type *mod*\ ( vec_type,vec_type ) \| Remainder \|
| \| vec_type *min*\ ( vec_type,vec_type ) \| Minimum \|
| \| vec_type *min*\ ( vec_type,vec_type ) \| Maximum \|
| \| vec_type *clamp*\ ( vec_type value,vec_type min, vec_type max )
\| Clamp to Min-Max \|
| \| vec\_type *mix*\ ( vec\_type a,vec\_type b, float c ) \| Linear
| \| vec_type *mix*\ ( vec_type a,vec_type b, float c ) \| Linear
Interpolate \|
| \| vec\_type *mix*\ ( vec\_type a,vec\_type b, vec\_type c ) \| Linear
| \| vec_type *mix*\ ( vec_type a,vec_type b, vec_type c ) \| Linear
Interpolate (Vector Coef.)\|
| \| vec\_type *step*\ ( vec\_type a,vec\_type b) \| \` a[i] < b[i] ?
| \| vec_type *step*\ ( vec_type a,vec_type b) \| \` a[i] < b[i] ?
0.0 : 1.0\`\|
| \| vec\_type *smoothstep*\ ( vec\_type a,vec\_type b,vec\_type c) \|
| \| vec_type *smoothstep*\ ( vec_type a,vec_type b,vec_type c) \|
\|
| \| float *length*\ ( vec\_type ) \| Vector Length \|
| \| float *distance*\ ( vec\_type, vec\_type ) \| Distance between
| \| float *length*\ ( vec_type ) \| Vector Length \|
| \| float *distance*\ ( vec_type, vec_type ) \| Distance between
vector. \|
| \| float *dot*\ ( vec\_type, vec\_type ) \| Dot Product \|
| \| float *dot*\ ( vec_type, vec_type ) \| Dot Product \|
| \| vec3 *dot*\ ( vec3, vec3 ) \| Cross Product \|
| \| vec\_type *normalize*\ ( vec\_type ) \| Normalize to unit length \|
| \| vec_type *normalize*\ ( vec_type ) \| Normalize to unit length \|
| \| vec3 *reflect*\ ( vec3, vec3 ) \| Reflect \|
| \| color *tex*\ ( texture, vec2 ) \| Read from a texture in
noormalized coords \|
@@ -195,10 +195,10 @@ Material - VertexShader
~~~~~~~~~~~~~~~~~~~~~~~
| \|\ *. Variable \|*. Description \|
| \| const vec3 *SRC\_VERTEX* \| Model-Space Vertex \|
| \| const vec3 *SRC\_NORMAL* \| Model-Space Normal \|
| \| const vec3 *SRC\_TANGENT* \| Model-Space Tangent \|
| \| const float *SRC\_BINORMALF* \| Direction to Compute Binormal \|
| \| const vec3 *SRC_VERTEX* \| Model-Space Vertex \|
| \| const vec3 *SRC_NORMAL* \| Model-Space Normal \|
| \| const vec3 *SRC_TANGENT* \| Model-Space Tangent \|
| \| const float *SRC_BINORMALF* \| Direction to Compute Binormal \|
| \| vec3 *VERTEX* \| View-Space Vertex \|
| \| vec3 *NORMAL* \| View-Space Normal \|
| \| vec3 *TANGENT* \| View-Space Tangent \|
@@ -208,13 +208,13 @@ Material - VertexShader
| \| color *COLOR* \| Vertex Color \|
| \| out vec4 *VAR1* \| Varying 1 Output \|
| \| out vec4 *VAR2* \| Varying 2 Output \|
| \| out float *SPEC\_EXP* \| Specular Exponent (for Vertex Lighting) \|
| \| out float *POINT\_SIZE* \| Point Size (for points) \|
| \| const mat4 *WORLD\_MATRIX* \| Object World Matrix \|
| \| const mat4 *INV\_CAMERA\_MATRIX* \| Inverse Camera Matrix \|
| \| const mat4 *PROJECTION\_MATRIX* \| Projection Matrix \|
| \| const mat4 *MODELVIEW\_MATRIX* \| (InvCamera \* Projection) \|
| \| const float *INSTANCE\_ID* \| Instance ID (for multimesh)\|
| \| out float *SPEC_EXP* \| Specular Exponent (for Vertex Lighting) \|
| \| out float *POINT_SIZE* \| Point Size (for points) \|
| \| const mat4 *WORLD_MATRIX* \| Object World Matrix \|
| \| const mat4 *INV_CAMERA_MATRIX* \| Inverse Camera Matrix \|
| \| const mat4 *PROJECTION_MATRIX* \| Projection Matrix \|
| \| const mat4 *MODELVIEW_MATRIX* \| (InvCamera \* Projection) \|
| \| const float *INSTANCE_ID* \| Instance ID (for multimesh)\|
| \| const float *TIME* \| Time (in seconds) \|
Material - FragmentShader
@@ -235,7 +235,7 @@ Material - FragmentShader
+----------------------------------+----------------------------------------------------------------------------------+
| const vec3 *NORMALMAP* | Alternative to NORMAL, use for normal texture output. |
+----------------------------------+----------------------------------------------------------------------------------+
| const vec3 *NORMALMAP\_DEPTH* | Complementary to the above, allows changing depth of normalmap. |
| const vec3 *NORMALMAP_DEPTH* | Complementary to the above, allows changing depth of normalmap. |
+----------------------------------+----------------------------------------------------------------------------------+
| const vec2 *UV* | UV |
+----------------------------------+----------------------------------------------------------------------------------+
@@ -247,25 +247,25 @@ Material - FragmentShader
+----------------------------------+----------------------------------------------------------------------------------+
| const vec4 *VAR2* | Varying 2 |
+----------------------------------+----------------------------------------------------------------------------------+
| const vec2 *SCREEN\_UV* | Screen Texture Coordinate (for using with texscreen) |
| const vec2 *SCREEN_UV* | Screen Texture Coordinate (for using with texscreen) |
+----------------------------------+----------------------------------------------------------------------------------+
| const float *TIME* | Time (in seconds) |
+----------------------------------+----------------------------------------------------------------------------------+
| const vec2 *POINT\_COORD* | UV for point, when drawing point sprites. |
| const vec2 *POINT_COORD* | UV for point, when drawing point sprites. |
+----------------------------------+----------------------------------------------------------------------------------+
| out vec3 *DIFFUSE* | Diffuse Color |
+----------------------------------+----------------------------------------------------------------------------------+
| out vec4 *DIFFUSE\_ALPHA* | Diffuse Color with Alpha (using this sends geometry to alpha pipeline) |
| out vec4 *DIFFUSE_ALPHA* | Diffuse Color with Alpha (using this sends geometry to alpha pipeline) |
+----------------------------------+----------------------------------------------------------------------------------+
| out vec3 *SPECULAR* | Specular Color |
+----------------------------------+----------------------------------------------------------------------------------+
| out vec3 *EMISSION* | Emission Color |
+----------------------------------+----------------------------------------------------------------------------------+
| out float *SPEC\_EXP* | Specular Exponent (Fragment Version) |
| out float *SPEC_EXP* | Specular Exponent (Fragment Version) |
+----------------------------------+----------------------------------------------------------------------------------+
| out float *GLOW* | Glow |
+----------------------------------+----------------------------------------------------------------------------------+
| out mat4 *INV\_CAMERA\_MATRIX* | Inverse camera matrix, can be used to obtain world coords (see example below). |
| out mat4 *INV_CAMERA_MATRIX* | Inverse camera matrix, can be used to obtain world coords (see example below). |
+----------------------------------+----------------------------------------------------------------------------------+
Material - LightShader
@@ -276,23 +276,23 @@ Material - LightShader
+================================+===============================+
| const vec3 *NORMAL* | View-Space normal |
+--------------------------------+-------------------------------+
| const vec3 *LIGHT\_DIR* | View-Space Light Direction |
| const vec3 *LIGHT_DIR* | View-Space Light Direction |
+--------------------------------+-------------------------------+
| const vec3 *EYE\_VEC* | View-Space Eye-Point Vector |
| const vec3 *EYE_VEC* | View-Space Eye-Point Vector |
+--------------------------------+-------------------------------+
| const vec3 *DIFFUSE* | Material Diffuse Color |
+--------------------------------+-------------------------------+
| const vec3 *LIGHT\_DIFFUSE* | Light Diffuse Color |
| const vec3 *LIGHT_DIFFUSE* | Light Diffuse Color |
+--------------------------------+-------------------------------+
| const vec3 *SPECULAR* | Material Specular Color |
+--------------------------------+-------------------------------+
| const vec3 *LIGHT\_SPECULAR* | Light Specular Color |
| const vec3 *LIGHT_SPECULAR* | Light Specular Color |
+--------------------------------+-------------------------------+
| const float *SPECULAR\_EXP* | Specular Exponent |
| const float *SPECULAR_EXP* | Specular Exponent |
+--------------------------------+-------------------------------+
| const vec1 *SHADE\_PARAM* | Generic Shade Parameter |
| const vec1 *SHADE_PARAM* | Generic Shade Parameter |
+--------------------------------+-------------------------------+
| const vec2 *POINT\_COORD* | Current UV for Point Sprite |
| const vec2 *POINT_COORD* | Current UV for Point Sprite |
+--------------------------------+-------------------------------+
| out vec2 *LIGHT* | Resulting Light |
+--------------------------------+-------------------------------+
@@ -303,20 +303,20 @@ CanvasItem (2D) - VertexShader
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
| \|\ *. Variable \|*. Description \|
| \| const vec2 *SRC\_VERTEX* \| CanvasItem space vertex. \|
| \| const vec2 *SRC_VERTEX* \| CanvasItem space vertex. \|
| \| vec2 *UV* \| UV \|
| \| out vec2 *VERTEX* \| Output LocalSpace vertex. \|
| \| out vec2 *WORLD\_VERTEX* \| Output WorldSpace vertex. (use this or
| \| out vec2 *WORLD_VERTEX* \| Output WorldSpace vertex. (use this or
the one above) \|
| \| color *COLOR* \| Vertex Color \|
| \| out vec4 *VAR1* \| Varying 1 Output \|
| \| out vec4 *VAR2* \| Varying 2 Output \|
| \| out float *POINT\_SIZE* \| Point Size (for points) \|
| \| const mat4 *WORLD\_MATRIX* \| Object World Matrix \|
| \| const mat4 *EXTRA\_MATRIX* \| Extra (user supplied) matrix via
| \| out float *POINT_SIZE* \| Point Size (for points) \|
| \| const mat4 *WORLD_MATRIX* \| Object World Matrix \|
| \| const mat4 *EXTRA_MATRIX* \| Extra (user supplied) matrix via
:ref:`CanvasItem.draw_set_transform() <class_CanvasItem_draw_set_transform>`.
Identity by default. \|
| \| const mat4 *PROJECTION\_MATRIX* \| Projection Matrix (model coords
| \| const mat4 *PROJECTION_MATRIX* \| Projection Matrix (model coords
to screen).\|
| \| const float *TIME* \| Time (in seconds) \|
@@ -324,23 +324,23 @@ CanvasItem (2D) - FragmentShader
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
| \|\ *. Variable \|*. Description \|
| \| const vec4 *SRC\_COLOR* \| Vertex color \|
| \| const vec4 *SRC_COLOR* \| Vertex color \|
| \| const vec4 *POSITION* \| Screen Position \|
| \| vec2 *UV* \| UV \|
| \| out color *COLOR* \| Output Color \|
| \| out vec3 *NORMAL* \| Optional Normal (used for 2D Lighting) \|
| \| out vec3 *NORMALMAP* \| Optional Normal in standard normalmap
format (flipped y and Z from 0 to 1) \|
| \| out float *NORMALMAP\_DEPTH* \| Depth option for above normalmap
| \| out float *NORMALMAP_DEPTH* \| Depth option for above normalmap
output, default value is 1.0 \|
| \| const texture *TEXTURE* \| Current texture in use for CanvasItem \|
| \| const vec2 *TEXTURE\_PIXEL\_SIZE* \| Pixel size for current 2D
| \| const vec2 *TEXTURE_PIXEL_SIZE* \| Pixel size for current 2D
texture \|
| \| in vec4 *VAR1* \| Varying 1 Output \|
| \| in vec4 *VAR2* \| Varying 2 Output \|
| \| const vec2 *SCREEN\_UV*\ \| Screen Texture Coordinate (for using
| \| const vec2 *SCREEN_UV*\ \| Screen Texture Coordinate (for using
with texscreen) \|
| \| const vec2 *POINT\_COORD* \| Current UV for Point Sprite \|
| \| const vec2 *POINT_COORD* \| Current UV for Point Sprite \|
| \| const float *TIME*\ \| Time (in seconds) \|
CanvasItem (2D) - LightShader
@@ -352,18 +352,18 @@ CanvasItem (2D) - LightShader
| \| in vec2 *UV* \| UV \|
| \| in color *COLOR* \| Input Color \|
| \| const texture *TEXTURE* \| Current texture in use for CanvasItem \|
| \| const vec2 *TEXTURE\_PIXEL\_SIZE* \| Pixel size for current 2D
| \| const vec2 *TEXTURE_PIXEL_SIZE* \| Pixel size for current 2D
texture \|
| \| in vec4 *VAR1* \| Varying 1 Output \|
| \| in vec4 *VAR2* \| Varying 2 Output \|
| \| const vec2 *SCREEN\_UV*\ \| Screen Texture Coordinate (for using
| \| const vec2 *SCREEN_UV*\ \| Screen Texture Coordinate (for using
with texscreen) \|
| \| const vec2 *POINT\_COORD* \| Current UV for Point Sprite \|
| \| const vec2 *POINT_COORD* \| Current UV for Point Sprite \|
| \| const float *TIME*\ \| Time (in seconds) \|
| \| vec2 *LIGHT\_VEC* \| Vector from light to fragment, can be modified
| \| vec2 *LIGHT_VEC* \| Vector from light to fragment, can be modified
to alter shadow computation. \|
| \| const float *LIGHT\_HEIGHT* \| Height of Light \|
| \| const color *LIGHT\_COLOR* \| Color of Light \|
| \| const float *LIGHT_HEIGHT* \| Height of Light \|
| \| const color *LIGHT_COLOR* \| Color of Light \|
| \| out vec4 *LIGHT* \| Light Ouput (shader is ignored if this is not
used) \|
@@ -410,7 +410,7 @@ Obtaining world-space normal and position in material fragment program:
Notes
-----
| \* **Do not** use DIFFUSE\_ALPHA unless you really intend to use
| \* **Do not** use DIFFUSE_ALPHA unless you really intend to use
transparency. Transparent materials must be sorted by depth and slow
down the rendering pipeline. For opaque materials, just use DIFFUSE.
| \* **Do not** use DISCARD unless you really need it. Discard makes