diff options
Diffstat (limited to 'doc')
56 files changed, 5848 insertions, 26995 deletions
diff --git a/doc/Doxyfile b/doc/Doxyfile new file mode 100644 index 0000000000..c1904f17c9 --- /dev/null +++ b/doc/Doxyfile @@ -0,0 +1,2432 @@ +# Doxyfile 1.8.9.1 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project. +# +# All text after a double hash (##) is considered a comment and is placed in +# front of the TAG it is preceding. +# +# All text after a single hash (#) is considered a comment and will be ignored. +# The format is: +# TAG = value [value, ...] +# For lists, items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (\" \"). + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the config file +# that follow. The default is UTF-8 which is also the encoding used for all text +# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv +# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv +# for the list of possible encodings. +# The default value is: UTF-8. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by +# double-quotes, unless you are using Doxywizard) that should identify the +# project for which the documentation is generated. This name is used in the +# title of most generated pages and in a few other places. +# The default value is: My Project. + +PROJECT_NAME = Godot + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. This +# could be handy for archiving the generated documentation or if some version +# control system is used. + +PROJECT_NUMBER = + +# Using the PROJECT_BRIEF tag one can provide an optional one line description +# for a project that appears at the top of each page and should give viewer a +# quick idea about the purpose of the project. Keep the description short. + +PROJECT_BRIEF = "Game Engine MIT" + +# With the PROJECT_LOGO tag one can specify a logo or an icon that is included +# in the documentation. The maximum height of the logo should not exceed 55 +# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy +# the logo to the output directory. + +PROJECT_LOGO = ../logo.png + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path +# into which the generated documentation will be written. If a relative path is +# entered, it will be relative to the location where doxygen was started. If +# left blank the current directory will be used. + +OUTPUT_DIRECTORY = ./_build/doxygen/ + +# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- +# directories (in 2 levels) under the output directory of each output format and +# will distribute the generated files over these directories. Enabling this +# option can be useful when feeding doxygen a huge amount of source files, where +# putting all generated files in the same directory would otherwise causes +# performance problems for the file system. +# The default value is: NO. + +CREATE_SUBDIRS = NO + +# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII +# characters to appear in the names of generated files. If set to NO, non-ASCII +# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode +# U+3044. +# The default value is: NO. + +ALLOW_UNICODE_NAMES = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, +# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), +# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, +# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), +# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, +# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, +# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, +# Ukrainian and Vietnamese. +# The default value is: English. + +OUTPUT_LANGUAGE = English + +# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member +# descriptions after the members that are listed in the file and class +# documentation (similar to Javadoc). Set to NO to disable this. +# The default value is: YES. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief +# description of a member or function before the detailed description +# +# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. +# The default value is: YES. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator that is +# used to form the text in various listings. Each string in this list, if found +# as the leading text of the brief description, will be stripped from the text +# and the result, after processing the whole list, is used as the annotated +# text. Otherwise, the brief description is used as-is. If left blank, the +# following values are used ($name is automatically replaced with the name of +# the entity):The $name class, The $name widget, The $name file, is, provides, +# specifies, contains, represents, a, an and the. + +ABBREVIATE_BRIEF = "The $name class" \ + "The $name widget" \ + "The $name file" \ + is \ + provides \ + specifies \ + contains \ + represents \ + a \ + an \ + the + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# doxygen will generate a detailed section even if there is only a brief +# description. +# The default value is: NO. + +ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. +# The default value is: NO. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path +# before files name in the file list and in the header files. If set to NO the +# shortest path that makes the file name unique will be used +# The default value is: YES. + +FULL_PATH_NAMES = YES + +# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. +# Stripping is only done if one of the specified strings matches the left-hand +# part of the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the path to +# strip. +# +# Note that you can specify absolute paths here, but also relative paths, which +# will be relative from the directory where doxygen is started. +# This tag requires that the tag FULL_PATH_NAMES is set to YES. + +STRIP_FROM_PATH = + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the +# path mentioned in the documentation of a class, which tells the reader which +# header file to include in order to use a class. If left blank only the name of +# the header file containing the class definition is used. Otherwise one should +# specify the list of include paths that are normally passed to the compiler +# using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but +# less readable) file names. This can be useful is your file systems doesn't +# support long names like on DOS, Mac, or CD-ROM. +# The default value is: NO. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the +# first line (until the first dot) of a Javadoc-style comment as the brief +# description. If set to NO, the Javadoc-style will behave just like regular Qt- +# style comments (thus requiring an explicit @brief command for a brief +# description.) +# The default value is: NO. + +JAVADOC_AUTOBRIEF = NO + +# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first +# line (until the first dot) of a Qt-style comment as the brief description. If +# set to NO, the Qt-style will behave just like regular Qt-style comments (thus +# requiring an explicit \brief command for a brief description.) +# The default value is: NO. + +QT_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a +# multi-line C++ special comment block (i.e. a block of //! or /// comments) as +# a brief description. This used to be the default behavior. The new default is +# to treat a multi-line C++ comment block as a detailed description. Set this +# tag to YES if you prefer the old behavior instead. +# +# Note that setting this tag to YES also means that rational rose comments are +# not recognized any more. +# The default value is: NO. + +MULTILINE_CPP_IS_BRIEF = NO + +# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the +# documentation from any documented member that it re-implements. +# The default value is: YES. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new +# page for each member. If set to NO, the documentation of a member will be part +# of the file/class/namespace that contains it. +# The default value is: NO. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen +# uses this value to replace tabs by spaces in code fragments. +# Minimum value: 1, maximum value: 16, default value: 4. + +TAB_SIZE = 4 + +# This tag can be used to specify a number of aliases that act as commands in +# the documentation. An alias has the form: +# name=value +# For example adding +# "sideeffect=@par Side Effects:\n" +# will allow you to put the command \sideeffect (or @sideeffect) in the +# documentation, which will result in a user-defined paragraph with heading +# "Side Effects:". You can put \n's in the value part of an alias to insert +# newlines. + +ALIASES = + +# This tag can be used to specify a number of word-keyword mappings (TCL only). +# A mapping has the form "name=value". For example adding "class=itcl::class" +# will allow you to use the command class in the itcl::class meaning. + +TCL_SUBST = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +# only. Doxygen will then generate output that is more tailored for C. For +# instance, some of the names that are used will be different. The list of all +# members will be omitted, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_FOR_C = NO + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or +# Python sources only. Doxygen will then generate output that is more tailored +# for that language. For instance, namespaces will be presented as packages, +# qualified scopes will look different, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources. Doxygen will then generate output that is tailored for Fortran. +# The default value is: NO. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for VHDL. +# The default value is: NO. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given +# extension. Doxygen has a built-in mapping, but you can override or extend it +# using this tag. The format is ext=language, where ext is a file extension, and +# language is one of the parsers supported by doxygen: IDL, Java, Javascript, +# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: +# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: +# Fortran. In the later case the parser tries to guess whether the code is fixed +# or free formatted code, this is the default for Fortran type files), VHDL. For +# instance to make doxygen treat .inc files as Fortran files (default is PHP), +# and .f files as C (default is Fortran), use: inc=Fortran f=C. +# +# Note: For files without extension you can use no_extension as a placeholder. +# +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise +# the files are not read by doxygen. + +EXTENSION_MAPPING = + +# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments +# according to the Markdown format, which allows for more readable +# documentation. See http://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you can +# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in +# case of backward compatibilities issues. +# The default value is: YES. + +MARKDOWN_SUPPORT = YES + +# When enabled doxygen tries to link words that correspond to documented +# classes, or namespaces to their corresponding documentation. Such a link can +# be prevented in individual cases by putting a % sign in front of the word or +# globally by setting AUTOLINK_SUPPORT to NO. +# The default value is: YES. + +AUTOLINK_SUPPORT = YES + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should set this +# tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); +# versus func(std::string) {}). This also make the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. +# The default value is: NO. + +BUILTIN_STL_SUPPORT = NO + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. +# The default value is: NO. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: +# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen +# will parse them like normal C++ but will assume all classes use public instead +# of private inheritance when no explicit protection keyword is present. +# The default value is: NO. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate +# getter and setter methods for a property. Setting this option to YES will make +# doxygen to replace the get and set methods by a property in the documentation. +# This will only work if the methods are indeed getting or setting a simple +# type. If this is not the case, or you want to show the methods anyway, you +# should set this option to NO. +# The default value is: YES. + +IDL_PROPERTY_SUPPORT = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. +# The default value is: NO. + +DISTRIBUTE_GROUP_DOC = NO + +# Set the SUBGROUPING tag to YES to allow class member groups of the same type +# (for instance a group of public functions) to be put as a subgroup of that +# type (e.g. under the Public Functions section). Set it to NO to prevent +# subgrouping. Alternatively, this can be done per class using the +# \nosubgrouping command. +# The default value is: YES. + +SUBGROUPING = YES + +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions +# are shown inside the group in which they are included (e.g. using \ingroup) +# instead of on a separate page (for HTML and Man pages) or section (for LaTeX +# and RTF). +# +# Note that this feature does not work in combination with +# SEPARATE_MEMBER_PAGES. +# The default value is: NO. + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions +# with only public data fields or simple typedef fields will be shown inline in +# the documentation of the scope in which they are defined (i.e. file, +# namespace, or group documentation), provided this scope is documented. If set +# to NO, structs, classes, and unions are shown on a separate page (for HTML and +# Man pages) or section (for LaTeX and RTF). +# The default value is: NO. + +INLINE_SIMPLE_STRUCTS = NO + +# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or +# enum is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically be +# useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. +# The default value is: NO. + +TYPEDEF_HIDES_STRUCT = NO + +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This +# cache is used to resolve symbols given their name and scope. Since this can be +# an expensive process and often the same symbol appears multiple times in the +# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small +# doxygen will become slower. If the cache is too large, memory is wasted. The +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 +# symbols. At the end of a run doxygen will report the cache usage and suggest +# the optimal cache size from a speed point of view. +# Minimum value: 0, maximum value: 9, default value: 0. + +LOOKUP_CACHE_SIZE = 0 + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in +# documentation are documented, even if no documentation was available. Private +# class members and static file members will be hidden unless the +# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. +# Note: This will also disable the warnings about undocumented members that are +# normally produced when WARNINGS is set to YES. +# The default value is: NO. + +EXTRACT_ALL = NO + +# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will +# be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIVATE = NO + +# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal +# scope will be included in the documentation. +# The default value is: NO. + +EXTRACT_PACKAGE = NO + +# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be +# included in the documentation. +# The default value is: NO. + +EXTRACT_STATIC = NO + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined +# locally in source files will be included in the documentation. If set to NO, +# only classes defined in header files are included. Does not have any effect +# for Java sources. +# The default value is: YES. + +EXTRACT_LOCAL_CLASSES = YES + +# This flag is only useful for Objective-C code. If set to YES, local methods, +# which are defined in the implementation section but not in the interface are +# included in the documentation. If set to NO, only methods in the interface are +# included. +# The default value is: NO. + +EXTRACT_LOCAL_METHODS = NO + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base name of +# the file that contains the anonymous namespace. By default anonymous namespace +# are hidden. +# The default value is: NO. + +EXTRACT_ANON_NSPACES = NO + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all +# undocumented members inside documented classes or files. If set to NO these +# members will be included in the various overviews, but no documentation +# section is generated. This option has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. If set +# to NO, these classes will be included in the various overviews. This option +# has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend +# (class|struct|union) declarations. If set to NO, these declarations will be +# included in the documentation. +# The default value is: NO. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any +# documentation blocks found inside the body of a function. If set to NO, these +# blocks will be appended to the function's detailed documentation block. +# The default value is: NO. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation that is typed after a +# \internal command is included. If the tag is set to NO then the documentation +# will be excluded. Set it to YES to include the internal documentation. +# The default value is: NO. + +INTERNAL_DOCS = NO + +# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file +# names in lower-case letters. If set to YES, upper-case letters are also +# allowed. This is useful if you have classes or files whose names only differ +# in case and if your file system supports case sensitive file names. Windows +# and Mac users are advised to set this option to NO. +# The default value is: system dependent. + +CASE_SENSE_NAMES = NO + +# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with +# their full class and namespace scopes in the documentation. If set to YES, the +# scope will be hidden. +# The default value is: NO. + +HIDE_SCOPE_NAMES = NO + +# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will +# append additional text to a page's title, such as Class Reference. If set to +# YES the compound reference will be hidden. +# The default value is: NO. + +HIDE_COMPOUND_REFERENCE= NO + +# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of +# the files that are included by a file in the documentation of that file. +# The default value is: YES. + +SHOW_INCLUDE_FILES = YES + +# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each +# grouped member an include statement to the documentation, telling the reader +# which file to include in order to use the member. +# The default value is: NO. + +SHOW_GROUPED_MEMB_INC = NO + +# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include +# files with double quotes in the documentation rather than with sharp brackets. +# The default value is: NO. + +FORCE_LOCAL_INCLUDES = NO + +# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the +# documentation for inline members. +# The default value is: YES. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the +# (detailed) documentation of file and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. +# The default value is: YES. + +SORT_MEMBER_DOCS = YES + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief +# descriptions of file, namespace and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. Note that +# this will also influence the order of the classes in the class list. +# The default value is: NO. + +SORT_BRIEF_DOCS = NO + +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the +# (brief and detailed) documentation of class members so that constructors and +# destructors are listed first. If set to NO the constructors will appear in the +# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. +# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief +# member documentation. +# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting +# detailed member documentation. +# The default value is: NO. + +SORT_MEMBERS_CTORS_1ST = NO + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy +# of group names into alphabetical order. If set to NO the group names will +# appear in their defined order. +# The default value is: NO. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by +# fully-qualified names, including namespaces. If set to NO, the class list will +# be sorted only by class name, not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the alphabetical +# list. +# The default value is: NO. + +SORT_BY_SCOPE_NAME = NO + +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper +# type resolution of all parameters of a function it will reject a match between +# the prototype and the implementation of a member function even if there is +# only one candidate or it is obvious which candidate to choose by doing a +# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still +# accept a match between prototype and implementation in such cases. +# The default value is: NO. + +STRICT_PROTO_MATCHING = NO + +# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo +# list. This list is created by putting \todo commands in the documentation. +# The default value is: YES. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test +# list. This list is created by putting \test commands in the documentation. +# The default value is: YES. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug +# list. This list is created by putting \bug commands in the documentation. +# The default value is: YES. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) +# the deprecated list. This list is created by putting \deprecated commands in +# the documentation. +# The default value is: YES. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional documentation +# sections, marked by \if <section_label> ... \endif and \cond <section_label> +# ... \endcond blocks. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the +# initial value of a variable or macro / define can have for it to appear in the +# documentation. If the initializer consists of more lines than specified here +# it will be hidden. Use a value of 0 to hide initializers completely. The +# appearance of the value of individual variables and macros / defines can be +# controlled using \showinitializer or \hideinitializer command in the +# documentation regardless of this setting. +# Minimum value: 0, maximum value: 10000, default value: 30. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at +# the bottom of the documentation of classes and structs. If set to YES, the +# list will mention the files that were used to generate the documentation. +# The default value is: YES. + +SHOW_USED_FILES = YES + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This +# will remove the Files entry from the Quick Index and from the Folder Tree View +# (if specified). +# The default value is: YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces +# page. This will remove the Namespaces entry from the Quick Index and from the +# Folder Tree View (if specified). +# The default value is: YES. + +SHOW_NAMESPACES = YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command command input-file, where command is the value of the +# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided +# by doxygen. Whatever the program writes to standard output is used as the file +# version. For an example see the documentation. + +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. To create the layout file +# that represents doxygen's defaults, run doxygen with the -l option. You can +# optionally specify a file name after the option, if omitted DoxygenLayout.xml +# will be used as the name of the layout file. +# +# Note that if you run doxygen from a directory containing a file called +# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE +# tag is left empty. + +LAYOUT_FILE = + +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing +# the reference definitions. This must be a list of .bib files. The .bib +# extension is automatically appended if omitted. This requires the bibtex tool +# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. +# For LaTeX the style of the bibliography can be controlled using +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the +# search path. See also \cite for info how to create references. + +CITE_BIB_FILES = + +#--------------------------------------------------------------------------- +# Configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated to +# standard output by doxygen. If QUIET is set to YES this implies that the +# messages are off. +# The default value is: NO. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES +# this implies that the warnings are on. +# +# Tip: Turn warnings on while writing the documentation. +# The default value is: YES. + +WARNINGS = YES + +# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate +# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: YES. + +WARN_IF_UNDOCUMENTED = YES + +# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some parameters +# in a documented function, or documenting parameters that don't exist or using +# markup commands wrongly. +# The default value is: YES. + +WARN_IF_DOC_ERROR = YES + +# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that +# are documented, but have no documentation for their parameters or return +# value. If set to NO, doxygen will only warn about wrong or incomplete +# parameter documentation, but not about the absence of documentation. +# The default value is: NO. + +WARN_NO_PARAMDOC = NO + +# The WARN_FORMAT tag determines the format of the warning messages that doxygen +# can produce. The string should contain the $file, $line, and $text tags, which +# will be replaced by the file and line number from which the warning originated +# and the warning text. Optionally the format may contain $version, which will +# be replaced by the version of the file (if it could be obtained via +# FILE_VERSION_FILTER) +# The default value is: $file:$line: $text. + +WARN_FORMAT = "$file:$line: $text" + +# The WARN_LOGFILE tag can be used to specify a file to which warning and error +# messages should be written. If left blank the output is written to standard +# error (stderr). + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# Configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag is used to specify the files and/or directories that contain +# documented source files. You may enter file names like myfile.cpp or +# directories like /usr/src/myproject. Separate the files or directories with +# spaces. +# Note: If this tag is empty the current directory is searched. + +INPUT = ../core/ ../main/ ../scene/ + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses +# libiconv (or the iconv built into libc) for the transcoding. See the libiconv +# documentation (see: http://www.gnu.org/software/libiconv) for the list of +# possible encodings. +# The default value is: UTF-8. + +INPUT_ENCODING = UTF-8 + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank the +# following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii, +# *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, +# *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, +# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, +# *.qsf, *.as and *.js. + +FILE_PATTERNS = *.c \ + *.cc \ + *.cxx \ + *.cpp \ + *.c++ \ + *.java \ + *.ii \ + *.ixx \ + *.ipp \ + *.i++ \ + *.inl \ + *.idl \ + *.ddl \ + *.odl \ + *.h \ + *.hh \ + *.hxx \ + *.hpp \ + *.h++ \ + *.cs \ + *.d \ + *.php \ + *.php4 \ + *.php5 \ + *.phtml \ + *.inc \ + *.m \ + *.markdown \ + *.md \ + *.mm \ + *.dox \ + *.py \ + *.f90 \ + *.f \ + *.for \ + *.tcl \ + *.vhd \ + *.vhdl \ + *.ucf \ + *.qsf \ + *.as \ + *.js + +# The RECURSIVE tag can be used to specify whether or not subdirectories should +# be searched for input files as well. +# The default value is: NO. + +RECURSIVE = YES + +# The EXCLUDE tag can be used to specify files and/or directories that should be +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. +# +# Note that relative paths are relative to the directory from which doxygen is +# run. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded +# from the input. +# The default value is: NO. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories for example use the pattern */test/* + +EXCLUDE_PATTERNS = + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# AClass::ANamespace, ANamespace::*Test +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories use the pattern */test/* + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or directories +# that contain example code fragments that are included (see the \include +# command). + +EXAMPLE_PATH = + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank all +# files are included. + +EXAMPLE_PATTERNS = * + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude commands +# irrespective of the value of the RECURSIVE tag. +# The default value is: NO. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or directories +# that contain images that are to be included in the documentation (see the +# \image command). + +IMAGE_PATH = + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command: +# +# <filter> <input-file> +# +# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the +# name of an input file. Doxygen will then use the output that the filter +# program writes to standard output. If FILTER_PATTERNS is specified, this tag +# will be ignored. +# +# Note that the filter must not add or remove lines; it is applied before the +# code is scanned, but not when the output code is generated. If lines are added +# or removed, the anchors will not be placed correctly. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: pattern=filter +# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how +# filters are used. If the FILTER_PATTERNS tag is empty or if none of the +# patterns match the file name, INPUT_FILTER is applied. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will also be used to filter the input files that are used for +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). +# The default value is: NO. + +FILTER_SOURCE_FILES = NO + +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and +# it is also possible to disable source filtering for a specific pattern using +# *.ext= (so without naming a filter). +# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. + +FILTER_SOURCE_PATTERNS = + +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that +# is part of the input, its contents will be placed on the main page +# (index.html). This can be useful if you have a project on for instance GitHub +# and want to reuse the introduction page also for the doxygen output. + +USE_MDFILE_AS_MAINPAGE = README.md + +#--------------------------------------------------------------------------- +# Configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will be +# generated. Documented entities will be cross-referenced with these sources. +# +# Note: To get rid of all source code in the generated output, make sure that +# also VERBATIM_HEADERS is set to NO. +# The default value is: NO. + +SOURCE_BROWSER = NO + +# Setting the INLINE_SOURCES tag to YES will include the body of functions, +# classes and enums directly into the documentation. +# The default value is: NO. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any +# special comment blocks from generated source code fragments. Normal C, C++ and +# Fortran comments will always remain visible. +# The default value is: YES. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented +# function all documented functions referencing it will be listed. +# The default value is: NO. + +REFERENCED_BY_RELATION = NO + +# If the REFERENCES_RELATION tag is set to YES then for each documented function +# all documented entities called/used by that function will be listed. +# The default value is: NO. + +REFERENCES_RELATION = NO + +# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set +# to YES then the hyperlinks from functions in REFERENCES_RELATION and +# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will +# link to the documentation. +# The default value is: YES. + +REFERENCES_LINK_SOURCE = YES + +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the +# source code will show a tooltip with additional information such as prototype, +# brief description and links to the definition and documentation. Since this +# will make the HTML file larger and loading of large files a bit slower, you +# can opt to disable this feature. +# The default value is: YES. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +SOURCE_TOOLTIPS = YES + +# If the USE_HTAGS tag is set to YES then the references to source code will +# point to the HTML generated by the htags(1) tool instead of doxygen built-in +# source browser. The htags tool is part of GNU's global source tagging system +# (see http://www.gnu.org/software/global/global.html). You will need version +# 4.8.6 or higher. +# +# To use it do the following: +# - Install the latest version of global +# - Enable SOURCE_BROWSER and USE_HTAGS in the config file +# - Make sure the INPUT points to the root of the source tree +# - Run doxygen as normal +# +# Doxygen will invoke htags (and that will in turn invoke gtags), so these +# tools must be available from the command line (i.e. in the search path). +# +# The result: instead of the source browser generated by doxygen, the links to +# source code will now point to the output of htags. +# The default value is: NO. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a +# verbatim copy of the header file for each class for which an include is +# specified. Set to NO to disable this. +# See also: Section \class. +# The default value is: YES. + +VERBATIM_HEADERS = YES + +# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the +# clang parser (see: http://clang.llvm.org/) for more accurate parsing at the +# cost of reduced performance. This can be particularly helpful with template +# rich C++ code for which doxygen's built-in parser lacks the necessary type +# information. +# Note: The availability of this option depends on whether or not doxygen was +# compiled with the --with-libclang option. +# The default value is: NO. + +CLANG_ASSISTED_PARSING = NO + +# If clang assisted parsing is enabled you can provide the compiler with command +# line options that you would normally use when invoking the compiler. Note that +# the include paths will already be set by doxygen for the files and directories +# specified with INPUT and INCLUDE_PATH. +# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. + +CLANG_OPTIONS = + +#--------------------------------------------------------------------------- +# Configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all +# compounds will be generated. Enable this if the project contains a lot of +# classes, structs, unions or interfaces. +# The default value is: YES. + +ALPHABETICAL_INDEX = YES + +# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in +# which the alphabetical index list will be split. +# Minimum value: 1, maximum value: 20, default value: 5. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +COLS_IN_ALPHA_INDEX = 5 + +# In case all classes in a project start with a common prefix, all classes will +# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag +# can be used to specify a prefix (or a list of prefixes) that should be ignored +# while generating the index headers. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output +# The default value is: YES. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. +# The default directory is: html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_OUTPUT = html + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each +# generated HTML page (for example: .htm, .php, .asp). +# The default value is: .html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a user-defined HTML header file for +# each generated HTML page. If the tag is left blank doxygen will generate a +# standard header. +# +# To get valid HTML the header file that includes any scripts and style sheets +# that doxygen needs, which is dependent on the configuration options used (e.g. +# the setting GENERATE_TREEVIEW). It is highly recommended to start with a +# default header using +# doxygen -w html new_header.html new_footer.html new_stylesheet.css +# YourConfigFile +# and then modify the file new_header.html. See also section "Doxygen usage" +# for information on how to generate the default header that doxygen normally +# uses. +# Note: The header is subject to change so you typically have to regenerate the +# default header when upgrading to a newer version of doxygen. For a description +# of the possible markers and block names see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each +# generated HTML page. If the tag is left blank doxygen will generate a standard +# footer. See HTML_HEADER for more information on how to generate a default +# footer and what special commands can be used inside the footer. See also +# section "Doxygen usage" for information on how to generate the default footer +# that doxygen normally uses. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FOOTER = + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style +# sheet that is used by each HTML page. It can be used to fine-tune the look of +# the HTML output. If left blank doxygen will generate a default style sheet. +# See also section "Doxygen usage" for information on how to generate the style +# sheet that doxygen normally uses. +# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as +# it is more robust and this tag (HTML_STYLESHEET) will in the future become +# obsolete. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_STYLESHEET = + +# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined +# cascading style sheets that are included after the standard style sheets +# created by doxygen. Using this option one can overrule certain style aspects. +# This is preferred over using HTML_STYLESHEET since it does not replace the +# standard style sheet and is therefore more robust against future updates. +# Doxygen will copy the style sheet files to the output directory. +# Note: The order of the extra style sheet files is of importance (e.g. the last +# style sheet in the list overrules the setting of the previous ones in the +# list). For an example see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_STYLESHEET = + +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that the +# files will be copied as-is; there are no commands or markers available. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_FILES = + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen +# will adjust the colors in the style sheet and background images according to +# this color. Hue is specified as an angle on a colorwheel, see +# http://en.wikipedia.org/wiki/Hue for more information. For instance the value +# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 +# purple, and 360 is red again. +# Minimum value: 0, maximum value: 359, default value: 220. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_HUE = 220 + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors +# in the HTML output. For a value of 0 the output will use grayscales only. A +# value of 255 will produce the most vivid colors. +# Minimum value: 0, maximum value: 255, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_SAT = 100 + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the +# luminance component of the colors in the HTML output. Values below 100 +# gradually make the output lighter, whereas values above 100 make the output +# darker. The value divided by 100 is the actual gamma applied, so 80 represents +# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not +# change the gamma. +# Minimum value: 40, maximum value: 240, default value: 80. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_GAMMA = 80 + +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML +# page will contain the date and time when the page was generated. Setting this +# to NO can help when comparing the output of multiple runs. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_TIMESTAMP = YES + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_SECTIONS = NO + +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries +# shown in the various tree structured indices initially; the user can expand +# and collapse entries dynamically later on. Doxygen will expand the tree to +# such a level that at most the specified number of entries are visible (unless +# a fully collapsed tree already exceeds this amount). So setting the number of +# entries 1 will produce a full collapsed tree by default. 0 is a special value +# representing an infinite number of entries and will result in a full expanded +# tree by default. +# Minimum value: 0, maximum value: 9999, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_INDEX_NUM_ENTRIES = 100 + +# If the GENERATE_DOCSET tag is set to YES, additional index files will be +# generated that can be used as input for Apple's Xcode 3 integrated development +# environment (see: http://developer.apple.com/tools/xcode/), introduced with +# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a +# Makefile in the HTML output directory. Running make will produce the docset in +# that directory and running make install will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at +# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html +# for more information. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_DOCSET = NO + +# This tag determines the name of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# The default value is: Doxygen generated docs. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# This tag specifies a string that should uniquely identify the documentation +# set bundle. This should be a reverse domain-name style string, e.g. +# com.mycompany.MyDocSet. Doxygen will append .docset to the name. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify +# the documentation publisher. This should be a reverse domain-name style +# string, e.g. com.mycompany.MyDocSet.documentation. +# The default value is: org.doxygen.Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. +# The default value is: Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_NAME = Publisher + +# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three +# additional HTML index files: index.hhp, index.hhc, and index.hhk. The +# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop +# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on +# Windows. +# +# The HTML Help Workshop contains a compiler that can convert all HTML output +# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML +# files are now used as the Windows 98 help format, and will replace the old +# Windows help format (.hlp) on all Windows platforms in the future. Compressed +# HTML files also contain an index, a table of contents, and you can search for +# words in the documentation. The HTML workshop also contains a viewer for +# compressed HTML files. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_HTMLHELP = NO + +# The CHM_FILE tag can be used to specify the file name of the resulting .chm +# file. You can add a path in front of the file if the result should not be +# written to the html output directory. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_FILE = + +# The HHC_LOCATION tag can be used to specify the location (absolute path +# including file name) of the HTML help compiler (hhc.exe). If non-empty, +# doxygen will try to run the HTML help compiler on the generated index.hhp. +# The file has to be specified with full path. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +HHC_LOCATION = + +# The GENERATE_CHI flag controls if a separate .chi index file is generated +# (YES) or that it should be included in the master .chm file (NO). +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +GENERATE_CHI = NO + +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) +# and project file content. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_INDEX_ENCODING = + +# The BINARY_TOC flag controls whether a binary table of contents is generated +# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it +# enables the Previous and Next buttons. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members to +# the table of contents of the HTML help documentation and to the tree view. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +TOC_EXPAND = NO + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that +# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help +# (.qch) of the generated HTML documentation. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify +# the file name of the resulting .qch file. The path specified is relative to +# the HTML output folder. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help +# Project output. For more information please see Qt Help Project / Namespace +# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_NAMESPACE = org.doxygen.Project + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt +# Help Project output. For more information please see Qt Help Project / Virtual +# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- +# folders). +# The default value is: doc. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_VIRTUAL_FOLDER = doc + +# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom +# filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's filter section matches. Qt Help Project / Filter Attributes (see: +# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_SECT_FILTER_ATTRS = + +# The QHG_LOCATION tag can be used to specify the location of Qt's +# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the +# generated .qhp file. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be +# generated, together with the HTML files, they form an Eclipse help plugin. To +# install this plugin and make it available under the help contents menu in +# Eclipse, the contents of the directory containing the HTML and XML files needs +# to be copied into the plugins directory of eclipse. The name of the directory +# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. +# After copying Eclipse needs to be restarted before the help appears. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the Eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have this +# name. Each documentation set should have its own identifier. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# If you want full control over the layout of the generated HTML pages it might +# be necessary to disable the index and replace it with your own. The +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top +# of each HTML page. A value of NO enables the index and the value YES disables +# it. Since the tabs in the index contain the same information as the navigation +# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +DISABLE_INDEX = NO + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. If the tag +# value is set to YES, a side panel will be generated containing a tree-like +# index structure (just like the one that is generated for HTML Help). For this +# to work a browser that supports JavaScript, DHTML, CSS and frames is required +# (i.e. any modern browser). Windows users are probably better off using the +# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can +# further fine-tune the look of the index. As an example, the default style +# sheet generated by doxygen has an example that shows how to put an image at +# the root of the tree instead of the PROJECT_NAME. Since the tree basically has +# the same information as the tab index, you could consider setting +# DISABLE_INDEX to YES when enabling this option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_TREEVIEW = NO + +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that +# doxygen will group on one line in the generated HTML documentation. +# +# Note that a value of 0 will completely suppress the enum values from appearing +# in the overview section. +# Minimum value: 0, maximum value: 20, default value: 4. +# This tag requires that the tag GENERATE_HTML is set to YES. + +ENUM_VALUES_PER_LINE = 4 + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used +# to set the initial width (in pixels) of the frame in which the tree is shown. +# Minimum value: 0, maximum value: 1500, default value: 250. +# This tag requires that the tag GENERATE_HTML is set to YES. + +TREEVIEW_WIDTH = 250 + +# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to +# external symbols imported via tag files in a separate window. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +EXT_LINKS_IN_WINDOW = NO + +# Use this tag to change the font size of LaTeX formulas included as images in +# the HTML documentation. When you change the font size after a successful +# doxygen run you need to manually remove any form_*.png images from the HTML +# output directory to force them to be regenerated. +# Minimum value: 8, maximum value: 50, default value: 10. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_FONTSIZE = 10 + +# Use the FORMULA_TRANPARENT tag to determine whether or not the images +# generated for formulas are transparent PNGs. Transparent PNGs are not +# supported properly for IE 6.0, but are supported on all modern browsers. +# +# Note that when changing this option you need to delete any form_*.png files in +# the HTML output directory before the changes have effect. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_TRANSPARENT = YES + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see +# http://www.mathjax.org) which uses client side Javascript for the rendering +# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX +# installed or if you want to formulas look prettier in the HTML output. When +# enabled you may also need to install MathJax separately and configure the path +# to it using the MATHJAX_RELPATH option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +USE_MATHJAX = NO + +# When MathJax is enabled you can set the default output format to be used for +# the MathJax output. See the MathJax site (see: +# http://docs.mathjax.org/en/latest/output.html) for more details. +# Possible values are: HTML-CSS (which is slower, but has the best +# compatibility), NativeMML (i.e. MathML) and SVG. +# The default value is: HTML-CSS. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_FORMAT = HTML-CSS + +# When MathJax is enabled you need to specify the location relative to the HTML +# output directory using the MATHJAX_RELPATH option. The destination directory +# should contain the MathJax.js script. For instance, if the mathjax directory +# is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax +# Content Delivery Network so you can quickly see the result without installing +# MathJax. However, it is strongly recommended to install a local copy of +# MathJax from http://www.mathjax.org before deployment. +# The default value is: http://cdn.mathjax.org/mathjax/latest. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest + +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax +# extension names that should be enabled during MathJax rendering. For example +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_EXTENSIONS = + +# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces +# of code that will be used on startup of the MathJax code. See the MathJax site +# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an +# example see the documentation. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_CODEFILE = + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box for +# the HTML output. The underlying search engine uses javascript and DHTML and +# should work on any modern browser. Note that when using HTML help +# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) +# there is already a search function so this one should typically be disabled. +# For large projects the javascript based search engine can be slow, then +# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to +# search using the keyboard; to jump to the search box use <access key> + S +# (what the <access key> is depends on the OS and browser, but it is typically +# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down +# key> to jump into the search results window, the results can be navigated +# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel +# the search. The filter options can be selected when the cursor is inside the +# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys> +# to select a filter and <Enter> or <escape> to activate or cancel the filter +# option. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +SEARCHENGINE = YES + +# When the SERVER_BASED_SEARCH tag is enabled the search engine will be +# implemented using a web server instead of a web client using Javascript. There +# are two flavors of web server based searching depending on the EXTERNAL_SEARCH +# setting. When disabled, doxygen will generate a PHP script for searching and +# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing +# and searching needs to be provided by external tools. See the section +# "External Indexing and Searching" for details. +# The default value is: NO. +# This tag requires that the tag SEARCHENGINE is set to YES. + +SERVER_BASED_SEARCH = NO + +# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP +# script for searching. Instead the search results are written to an XML file +# which needs to be processed by an external indexer. Doxygen will invoke an +# external search engine pointed to by the SEARCHENGINE_URL option to obtain the +# search results. +# +# Doxygen ships with an example indexer (doxyindexer) and search engine +# (doxysearch.cgi) which are based on the open source search engine library +# Xapian (see: http://xapian.org/). +# +# See the section "External Indexing and Searching" for details. +# The default value is: NO. +# This tag requires that the tag SEARCHENGINE is set to YES. + +EXTERNAL_SEARCH = NO + +# The SEARCHENGINE_URL should point to a search engine hosted by a web server +# which will return the search results when EXTERNAL_SEARCH is enabled. +# +# Doxygen ships with an example indexer (doxyindexer) and search engine +# (doxysearch.cgi) which are based on the open source search engine library +# Xapian (see: http://xapian.org/). See the section "External Indexing and +# Searching" for details. +# This tag requires that the tag SEARCHENGINE is set to YES. + +SEARCHENGINE_URL = + +# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed +# search data is written to a file for indexing by an external tool. With the +# SEARCHDATA_FILE tag the name of this file can be specified. +# The default file is: searchdata.xml. +# This tag requires that the tag SEARCHENGINE is set to YES. + +SEARCHDATA_FILE = searchdata.xml + +# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the +# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is +# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple +# projects and redirect the results back to the right project. +# This tag requires that the tag SEARCHENGINE is set to YES. + +EXTERNAL_SEARCH_ID = + +# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen +# projects other than the one defined by this configuration file, but that are +# all added to the same external search index. Each project needs to have a +# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of +# to a relative location where the documentation can be found. The format is: +# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ... +# This tag requires that the tag SEARCHENGINE is set to YES. + +EXTRA_SEARCH_MAPPINGS = + +#--------------------------------------------------------------------------- +# Configuration options related to the LaTeX output +#--------------------------------------------------------------------------- + +# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output. +# The default value is: YES. + +GENERATE_LATEX = NO + +# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. +# The default directory is: latex. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +LATEX_OUTPUT = latex + +# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be +# invoked. +# +# Note that when enabling USE_PDFLATEX this option is only used for generating +# bitmaps for formulas in the HTML output, but not in the Makefile that is +# written to the output directory. +# The default file is: latex. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +LATEX_CMD_NAME = latex + +# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate +# index for LaTeX. +# The default file is: makeindex. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +MAKEINDEX_CMD_NAME = makeindex + +# If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX +# documents. This may be useful for small projects and may help to save some +# trees in general. +# The default value is: NO. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +COMPACT_LATEX = NO + +# The PAPER_TYPE tag can be used to set the paper type that is used by the +# printer. +# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x +# 14 inches) and executive (7.25 x 10.5 inches). +# The default value is: a4. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +PAPER_TYPE = a4 + +# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names +# that should be included in the LaTeX output. To get the times font for +# instance you can specify +# EXTRA_PACKAGES=times +# If left blank no extra packages will be included. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +EXTRA_PACKAGES = + +# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the +# generated LaTeX document. The header should contain everything until the first +# chapter. If it is left blank doxygen will generate a standard header. See +# section "Doxygen usage" for information on how to let doxygen write the +# default header to a separate file. +# +# Note: Only use a user-defined header if you know what you are doing! The +# following commands have a special meaning inside the header: $title, +# $datetime, $date, $doxygenversion, $projectname, $projectnumber, +# $projectbrief, $projectlogo. Doxygen will replace $title with the empty +# string, for the replacement values of the other commands the user is referred +# to HTML_HEADER. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +LATEX_HEADER = + +# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the +# generated LaTeX document. The footer should contain everything after the last +# chapter. If it is left blank doxygen will generate a standard footer. See +# LATEX_HEADER for more information on how to generate a default footer and what +# special commands can be used inside the footer. +# +# Note: Only use a user-defined footer if you know what you are doing! +# This tag requires that the tag GENERATE_LATEX is set to YES. + +LATEX_FOOTER = + +# The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined +# LaTeX style sheets that are included after the standard style sheets created +# by doxygen. Using this option one can overrule certain style aspects. Doxygen +# will copy the style sheet files to the output directory. +# Note: The order of the extra style sheet files is of importance (e.g. the last +# style sheet in the list overrules the setting of the previous ones in the +# list). +# This tag requires that the tag GENERATE_LATEX is set to YES. + +LATEX_EXTRA_STYLESHEET = + +# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the LATEX_OUTPUT output +# directory. Note that the files will be copied as-is; there are no commands or +# markers available. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +LATEX_EXTRA_FILES = + +# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is +# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will +# contain links (just like the HTML output) instead of page references. This +# makes the output suitable for online browsing using a PDF viewer. +# The default value is: YES. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +PDF_HYPERLINKS = YES + +# If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate +# the PDF file directly from the LaTeX files. Set this option to YES, to get a +# higher quality PDF documentation. +# The default value is: YES. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +USE_PDFLATEX = YES + +# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode +# command to the generated LaTeX files. This will instruct LaTeX to keep running +# if errors occur, instead of asking the user for help. This option is also used +# when generating formulas in HTML. +# The default value is: NO. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +LATEX_BATCHMODE = NO + +# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the +# index chapters (such as File Index, Compound Index, etc.) in the output. +# The default value is: NO. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +LATEX_HIDE_INDICES = NO + +# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source +# code with syntax highlighting in the LaTeX output. +# +# Note that which sources are shown also depends on other settings such as +# SOURCE_BROWSER. +# The default value is: NO. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +LATEX_SOURCE_CODE = NO + +# The LATEX_BIB_STYLE tag can be used to specify the style to use for the +# bibliography, e.g. plainnat, or ieeetr. See +# http://en.wikipedia.org/wiki/BibTeX and \cite for more info. +# The default value is: plain. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +LATEX_BIB_STYLE = plain + +#--------------------------------------------------------------------------- +# Configuration options related to the RTF output +#--------------------------------------------------------------------------- + +# If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The +# RTF output is optimized for Word 97 and may not look too pretty with other RTF +# readers/editors. +# The default value is: NO. + +GENERATE_RTF = NO + +# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. +# The default directory is: rtf. +# This tag requires that the tag GENERATE_RTF is set to YES. + +RTF_OUTPUT = rtf + +# If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF +# documents. This may be useful for small projects and may help to save some +# trees in general. +# The default value is: NO. +# This tag requires that the tag GENERATE_RTF is set to YES. + +COMPACT_RTF = NO + +# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will +# contain hyperlink fields. The RTF file will contain links (just like the HTML +# output) instead of page references. This makes the output suitable for online +# browsing using Word or some other Word compatible readers that support those +# fields. +# +# Note: WordPad (write) and others do not support links. +# The default value is: NO. +# This tag requires that the tag GENERATE_RTF is set to YES. + +RTF_HYPERLINKS = NO + +# Load stylesheet definitions from file. Syntax is similar to doxygen's config +# file, i.e. a series of assignments. You only have to provide replacements, +# missing definitions are set to their default value. +# +# See also section "Doxygen usage" for information on how to generate the +# default style sheet that doxygen normally uses. +# This tag requires that the tag GENERATE_RTF is set to YES. + +RTF_STYLESHEET_FILE = + +# Set optional variables used in the generation of an RTF document. Syntax is +# similar to doxygen's config file. A template extensions file can be generated +# using doxygen -e rtf extensionFile. +# This tag requires that the tag GENERATE_RTF is set to YES. + +RTF_EXTENSIONS_FILE = + +# If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code +# with syntax highlighting in the RTF output. +# +# Note that which sources are shown also depends on other settings such as +# SOURCE_BROWSER. +# The default value is: NO. +# This tag requires that the tag GENERATE_RTF is set to YES. + +RTF_SOURCE_CODE = NO + +#--------------------------------------------------------------------------- +# Configuration options related to the man page output +#--------------------------------------------------------------------------- + +# If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for +# classes and files. +# The default value is: NO. + +GENERATE_MAN = NO + +# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. A directory man3 will be created inside the directory specified by +# MAN_OUTPUT. +# The default directory is: man. +# This tag requires that the tag GENERATE_MAN is set to YES. + +MAN_OUTPUT = man + +# The MAN_EXTENSION tag determines the extension that is added to the generated +# man pages. In case the manual section does not start with a number, the number +# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is +# optional. +# The default value is: .3. +# This tag requires that the tag GENERATE_MAN is set to YES. + +MAN_EXTENSION = .3 + +# The MAN_SUBDIR tag determines the name of the directory created within +# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by +# MAN_EXTENSION with the initial . removed. +# This tag requires that the tag GENERATE_MAN is set to YES. + +MAN_SUBDIR = + +# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it +# will generate one additional man file for each entity documented in the real +# man page(s). These additional files only source the real man page, but without +# them the man command would be unable to find the correct page. +# The default value is: NO. +# This tag requires that the tag GENERATE_MAN is set to YES. + +MAN_LINKS = NO + +#--------------------------------------------------------------------------- +# Configuration options related to the XML output +#--------------------------------------------------------------------------- + +# If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that +# captures the structure of the code including all documentation. +# The default value is: NO. + +GENERATE_XML = NO + +# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. +# The default directory is: xml. +# This tag requires that the tag GENERATE_XML is set to YES. + +XML_OUTPUT = xml + +# If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program +# listings (including syntax highlighting and cross-referencing information) to +# the XML output. Note that enabling this will significantly increase the size +# of the XML output. +# The default value is: YES. +# This tag requires that the tag GENERATE_XML is set to YES. + +XML_PROGRAMLISTING = YES + +#--------------------------------------------------------------------------- +# Configuration options related to the DOCBOOK output +#--------------------------------------------------------------------------- + +# If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files +# that can be used to generate PDF. +# The default value is: NO. + +GENERATE_DOCBOOK = NO + +# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in +# front of it. +# The default directory is: docbook. +# This tag requires that the tag GENERATE_DOCBOOK is set to YES. + +DOCBOOK_OUTPUT = docbook + +# If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the +# program listings (including syntax highlighting and cross-referencing +# information) to the DOCBOOK output. Note that enabling this will significantly +# increase the size of the DOCBOOK output. +# The default value is: NO. +# This tag requires that the tag GENERATE_DOCBOOK is set to YES. + +DOCBOOK_PROGRAMLISTING = NO + +#--------------------------------------------------------------------------- +# Configuration options for the AutoGen Definitions output +#--------------------------------------------------------------------------- + +# If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an +# AutoGen Definitions (see http://autogen.sf.net) file that captures the +# structure of the code including all documentation. Note that this feature is +# still experimental and incomplete at the moment. +# The default value is: NO. + +GENERATE_AUTOGEN_DEF = NO + +#--------------------------------------------------------------------------- +# Configuration options related to the Perl module output +#--------------------------------------------------------------------------- + +# If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module +# file that captures the structure of the code including all documentation. +# +# Note that this feature is still experimental and incomplete at the moment. +# The default value is: NO. + +GENERATE_PERLMOD = NO + +# If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary +# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI +# output from the Perl module output. +# The default value is: NO. +# This tag requires that the tag GENERATE_PERLMOD is set to YES. + +PERLMOD_LATEX = NO + +# If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely +# formatted so it can be parsed by a human reader. This is useful if you want to +# understand what is going on. On the other hand, if this tag is set to NO, the +# size of the Perl module output will be much smaller and Perl will parse it +# just the same. +# The default value is: YES. +# This tag requires that the tag GENERATE_PERLMOD is set to YES. + +PERLMOD_PRETTY = YES + +# The names of the make variables in the generated doxyrules.make file are +# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful +# so different doxyrules.make files included by the same Makefile don't +# overwrite each other's variables. +# This tag requires that the tag GENERATE_PERLMOD is set to YES. + +PERLMOD_MAKEVAR_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the preprocessor +#--------------------------------------------------------------------------- + +# If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all +# C-preprocessor directives found in the sources and include files. +# The default value is: YES. + +ENABLE_PREPROCESSING = YES + +# If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names +# in the source code. If set to NO, only conditional compilation will be +# performed. Macro expansion can be done in a controlled way by setting +# EXPAND_ONLY_PREDEF to YES. +# The default value is: NO. +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. + +MACRO_EXPANSION = NO + +# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then +# the macro expansion is limited to the macros specified with the PREDEFINED and +# EXPAND_AS_DEFINED tags. +# The default value is: NO. +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. + +EXPAND_ONLY_PREDEF = NO + +# If the SEARCH_INCLUDES tag is set to YES, the include files in the +# INCLUDE_PATH will be searched if a #include is found. +# The default value is: YES. +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. + +SEARCH_INCLUDES = YES + +# The INCLUDE_PATH tag can be used to specify one or more directories that +# contain include files that are not input files but should be processed by the +# preprocessor. +# This tag requires that the tag SEARCH_INCLUDES is set to YES. + +INCLUDE_PATH = + +# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard +# patterns (like *.h and *.hpp) to filter out the header-files in the +# directories. If left blank, the patterns specified with FILE_PATTERNS will be +# used. +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. + +INCLUDE_FILE_PATTERNS = + +# The PREDEFINED tag can be used to specify one or more macro names that are +# defined before the preprocessor is started (similar to the -D option of e.g. +# gcc). The argument of the tag is a list of macros of the form: name or +# name=definition (no spaces). If the definition and the "=" are omitted, "=1" +# is assumed. To prevent a macro definition from being undefined via #undef or +# recursively expanded use the := operator instead of the = operator. +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. + +PREDEFINED = + +# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this +# tag can be used to specify a list of macro names that should be expanded. The +# macro definition that is found in the sources will be used. Use the PREDEFINED +# tag if you want to use a different macro definition that overrules the +# definition found in the source code. +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. + +EXPAND_AS_DEFINED = + +# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will +# remove all references to function-like macros that are alone on a line, have +# an all uppercase name, and do not end with a semicolon. Such function macros +# are typically used for boiler-plate code, and will confuse the parser if not +# removed. +# The default value is: YES. +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. + +SKIP_FUNCTION_MACROS = YES + +#--------------------------------------------------------------------------- +# Configuration options related to external references +#--------------------------------------------------------------------------- + +# The TAGFILES tag can be used to specify one or more tag files. For each tag +# file the location of the external documentation should be added. The format of +# a tag file without this location is as follows: +# TAGFILES = file1 file2 ... +# Adding location for the tag files is done as follows: +# TAGFILES = file1=loc1 "file2 = loc2" ... +# where loc1 and loc2 can be relative or absolute paths or URLs. See the +# section "Linking to external documentation" for more information about the use +# of tag files. +# Note: Each tag file must have a unique name (where the name does NOT include +# the path). If a tag file is not located in the directory in which doxygen is +# run, you must also specify the path to the tagfile here. + +TAGFILES = + +# When a file name is specified after GENERATE_TAGFILE, doxygen will create a +# tag file that is based on the input files it reads. See section "Linking to +# external documentation" for more information about the usage of tag files. + +GENERATE_TAGFILE = + +# If the ALLEXTERNALS tag is set to YES, all external class will be listed in +# the class index. If set to NO, only the inherited external classes will be +# listed. +# The default value is: NO. + +ALLEXTERNALS = NO + +# If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed +# in the modules index. If set to NO, only the current project's groups will be +# listed. +# The default value is: YES. + +EXTERNAL_GROUPS = YES + +# If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in +# the related pages index. If set to NO, only the current project's pages will +# be listed. +# The default value is: YES. + +EXTERNAL_PAGES = YES + +# The PERL_PATH should be the absolute path and name of the perl script +# interpreter (i.e. the result of 'which perl'). +# The default file (with absolute path) is: /usr/bin/perl. + +PERL_PATH = /usr/bin/perl + +#--------------------------------------------------------------------------- +# Configuration options related to the dot tool +#--------------------------------------------------------------------------- + +# If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram +# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to +# NO turns the diagrams off. Note that this option also works with HAVE_DOT +# disabled, but it is recommended to install and use dot, since it yields more +# powerful graphs. +# The default value is: YES. + +CLASS_DIAGRAMS = YES + +# You can define message sequence charts within doxygen comments using the \msc +# command. Doxygen will then run the mscgen tool (see: +# http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the +# documentation. The MSCGEN_PATH tag allows you to specify the directory where +# the mscgen tool resides. If left empty the tool is assumed to be found in the +# default search path. + +MSCGEN_PATH = + +# You can include diagrams made with dia in doxygen documentation. Doxygen will +# then run dia to produce the diagram and insert it in the documentation. The +# DIA_PATH tag allows you to specify the directory where the dia binary resides. +# If left empty dia is assumed to be found in the default search path. + +DIA_PATH = + +# If set to YES the inheritance and collaboration graphs will hide inheritance +# and usage relations if the target is undocumented or is not a class. +# The default value is: YES. + +HIDE_UNDOC_RELATIONS = YES + +# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is +# available from the path. This tool is part of Graphviz (see: +# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent +# Bell Labs. The other options in this section have no effect if this option is +# set to NO +# The default value is: NO. + +HAVE_DOT = NO + +# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed +# to run in parallel. When set to 0 doxygen will base this on the number of +# processors available in the system. You can set it explicitly to a value +# larger than 0 to get control over the balance between CPU load and processing +# speed. +# Minimum value: 0, maximum value: 32, default value: 0. +# This tag requires that the tag HAVE_DOT is set to YES. + +DOT_NUM_THREADS = 0 + +# When you want a differently looking font in the dot files that doxygen +# generates you can specify the font name using DOT_FONTNAME. You need to make +# sure dot is able to find the font, which can be done by putting it in a +# standard location or by setting the DOTFONTPATH environment variable or by +# setting DOT_FONTPATH to the directory containing the font. +# The default value is: Helvetica. +# This tag requires that the tag HAVE_DOT is set to YES. + +DOT_FONTNAME = Helvetica + +# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of +# dot graphs. +# Minimum value: 4, maximum value: 24, default value: 10. +# This tag requires that the tag HAVE_DOT is set to YES. + +DOT_FONTSIZE = 10 + +# By default doxygen will tell dot to use the default font as specified with +# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set +# the path where dot can find it using this tag. +# This tag requires that the tag HAVE_DOT is set to YES. + +DOT_FONTPATH = + +# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for +# each documented class showing the direct and indirect inheritance relations. +# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO. +# The default value is: YES. +# This tag requires that the tag HAVE_DOT is set to YES. + +CLASS_GRAPH = YES + +# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a +# graph for each documented class showing the direct and indirect implementation +# dependencies (inheritance, containment, and class references variables) of the +# class with other documented classes. +# The default value is: YES. +# This tag requires that the tag HAVE_DOT is set to YES. + +COLLABORATION_GRAPH = YES + +# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for +# groups, showing the direct groups dependencies. +# The default value is: YES. +# This tag requires that the tag HAVE_DOT is set to YES. + +GROUP_GRAPHS = YES + +# If the UML_LOOK tag is set to YES, doxygen will generate inheritance and +# collaboration diagrams in a style similar to the OMG's Unified Modeling +# Language. +# The default value is: NO. +# This tag requires that the tag HAVE_DOT is set to YES. + +UML_LOOK = NO + +# If the UML_LOOK tag is enabled, the fields and methods are shown inside the +# class node. If there are many fields or methods and many nodes the graph may +# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the +# number of items for each type to make the size more manageable. Set this to 0 +# for no limit. Note that the threshold may be exceeded by 50% before the limit +# is enforced. So when you set the threshold to 10, up to 15 fields may appear, +# but if the number exceeds 15, the total amount of fields shown is limited to +# 10. +# Minimum value: 0, maximum value: 100, default value: 10. +# This tag requires that the tag HAVE_DOT is set to YES. + +UML_LIMIT_NUM_FIELDS = 10 + +# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and +# collaboration graphs will show the relations between templates and their +# instances. +# The default value is: NO. +# This tag requires that the tag HAVE_DOT is set to YES. + +TEMPLATE_RELATIONS = NO + +# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to +# YES then doxygen will generate a graph for each documented file showing the +# direct and indirect include dependencies of the file with other documented +# files. +# The default value is: YES. +# This tag requires that the tag HAVE_DOT is set to YES. + +INCLUDE_GRAPH = YES + +# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are +# set to YES then doxygen will generate a graph for each documented file showing +# the direct and indirect include dependencies of the file with other documented +# files. +# The default value is: YES. +# This tag requires that the tag HAVE_DOT is set to YES. + +INCLUDED_BY_GRAPH = YES + +# If the CALL_GRAPH tag is set to YES then doxygen will generate a call +# dependency graph for every global function or class method. +# +# Note that enabling this option will significantly increase the time of a run. +# So in most cases it will be better to enable call graphs for selected +# functions only using the \callgraph command. +# The default value is: NO. +# This tag requires that the tag HAVE_DOT is set to YES. + +CALL_GRAPH = NO + +# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller +# dependency graph for every global function or class method. +# +# Note that enabling this option will significantly increase the time of a run. +# So in most cases it will be better to enable caller graphs for selected +# functions only using the \callergraph command. +# The default value is: NO. +# This tag requires that the tag HAVE_DOT is set to YES. + +CALLER_GRAPH = NO + +# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical +# hierarchy of all classes instead of a textual one. +# The default value is: YES. +# This tag requires that the tag HAVE_DOT is set to YES. + +GRAPHICAL_HIERARCHY = YES + +# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the +# dependencies a directory has on other directories in a graphical way. The +# dependency relations are determined by the #include relations between the +# files in the directories. +# The default value is: YES. +# This tag requires that the tag HAVE_DOT is set to YES. + +DIRECTORY_GRAPH = YES + +# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images +# generated by dot. +# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order +# to make the SVG files visible in IE 9+ (other browsers do not have this +# requirement). +# Possible values are: png, jpg, gif and svg. +# The default value is: png. +# This tag requires that the tag HAVE_DOT is set to YES. + +DOT_IMAGE_FORMAT = png + +# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to +# enable generation of interactive SVG images that allow zooming and panning. +# +# Note that this requires a modern browser other than Internet Explorer. Tested +# and working are Firefox, Chrome, Safari, and Opera. +# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make +# the SVG files visible. Older versions of IE do not have SVG support. +# The default value is: NO. +# This tag requires that the tag HAVE_DOT is set to YES. + +INTERACTIVE_SVG = NO + +# The DOT_PATH tag can be used to specify the path where the dot tool can be +# found. If left blank, it is assumed the dot tool can be found in the path. +# This tag requires that the tag HAVE_DOT is set to YES. + +DOT_PATH = + +# The DOTFILE_DIRS tag can be used to specify one or more directories that +# contain dot files that are included in the documentation (see the \dotfile +# command). +# This tag requires that the tag HAVE_DOT is set to YES. + +DOTFILE_DIRS = + +# The MSCFILE_DIRS tag can be used to specify one or more directories that +# contain msc files that are included in the documentation (see the \mscfile +# command). + +MSCFILE_DIRS = + +# The DIAFILE_DIRS tag can be used to specify one or more directories that +# contain dia files that are included in the documentation (see the \diafile +# command). + +DIAFILE_DIRS = + +# When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the +# path where java can find the plantuml.jar file. If left blank, it is assumed +# PlantUML is not used or called during a preprocessing step. Doxygen will +# generate a warning when it encounters a \startuml command in this case and +# will not generate output for the diagram. + +PLANTUML_JAR_PATH = + +# When using plantuml, the specified paths are searched for files specified by +# the !include statement in a plantuml block. + +PLANTUML_INCLUDE_PATH = + +# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes +# that will be shown in the graph. If the number of nodes in a graph becomes +# larger than this value, doxygen will truncate the graph, which is visualized +# by representing a node as a red box. Note that doxygen if the number of direct +# children of the root node in a graph is already larger than +# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that +# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. +# Minimum value: 0, maximum value: 10000, default value: 50. +# This tag requires that the tag HAVE_DOT is set to YES. + +DOT_GRAPH_MAX_NODES = 50 + +# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs +# generated by dot. A depth value of 3 means that only nodes reachable from the +# root by following a path via at most 3 edges will be shown. Nodes that lay +# further from the root node will be omitted. Note that setting this option to 1 +# or 2 may greatly reduce the computation time needed for large code bases. Also +# note that the size of a graph can be further restricted by +# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. +# Minimum value: 0, maximum value: 1000, default value: 0. +# This tag requires that the tag HAVE_DOT is set to YES. + +MAX_DOT_GRAPH_DEPTH = 0 + +# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent +# background. This is disabled by default, because dot on Windows does not seem +# to support this out of the box. +# +# Warning: Depending on the platform used, enabling this option may lead to +# badly anti-aliased labels on the edges of a graph (i.e. they become hard to +# read). +# The default value is: NO. +# This tag requires that the tag HAVE_DOT is set to YES. + +DOT_TRANSPARENT = NO + +# Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output +# files in one run (i.e. multiple -o and -T options on the command line). This +# makes dot run faster, but since only newer versions of dot (>1.8.10) support +# this, this feature is disabled by default. +# The default value is: NO. +# This tag requires that the tag HAVE_DOT is set to YES. + +DOT_MULTI_TARGETS = NO + +# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page +# explaining the meaning of the various boxes and arrows in the dot generated +# graphs. +# The default value is: YES. +# This tag requires that the tag HAVE_DOT is set to YES. + +GENERATE_LEGEND = YES + +# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot +# files that are used to generate the various graphs. +# The default value is: YES. +# This tag requires that the tag HAVE_DOT is set to YES. + +DOT_CLEANUP = YES diff --git a/doc/Makefile b/doc/Makefile new file mode 100644 index 0000000000..286a5162af --- /dev/null +++ b/doc/Makefile @@ -0,0 +1,47 @@ +BASEDIR = $(CURDIR) +CLASSES = $(BASEDIR)/base/classes.xml +OUTPUTDIR = $(BASEDIR)/_build +TOOLSDIR = $(BASEDIR)/tools + +.ONESHELL: + +clean: + rm -rf $(OUTPUTDIR) + +doku: + rm -rf $(OUTPUTDIR)/doku + mkdir -p $(OUTPUTDIR)/doku + pushd $(OUTPUTDIR)/doku + python2 $(TOOLSDIR)/makedoku.py $(CLASSES) + popd + +doxygen: + rm -rf $(OUTPUTDIR)/doxygen + mkdir -p $(OUTPUTDIR)/doxygen + doxygen Doxyfile + +html: + rm -rf $(OUTPUTDIR)/html + mkdir -p $(OUTPUTDIR)/html + pushd $(OUTPUTDIR)/html + python2 $(TOOLSDIR)/makehtml.py -multipage $(CLASSES) + popd + +markdown: + rm -rf $(OUTPUTDIR)/markdown + mkdir -p $(OUTPUTDIR)/markdown + pushd $(OUTPUTDIR)/markdown + python2 $(TOOLSDIR)/makemd.py $(CLASSES) + popd + +rst: + rm -rf $(OUTPUTDIR)/rst + mkdir -p $(OUTPUTDIR)/rst + pushd $(OUTPUTDIR)/rst + echo "TODO" + popd + +textile: + rm -rf $(OUTPUTDIR)/textile + mkdir -p $(OUTPUTDIR)/textile + python3 $(TOOLSDIR)/makedocs.py --input $(CLASSES) --output $(OUTPUTDIR)/textile diff --git a/doc/base/classes.xml b/doc/base/classes.xml index 12f9062888..4a1e437694 100644 --- a/doc/base/classes.xml +++ b/doc/base/classes.xml @@ -432,7 +432,7 @@ <method name="convert"> <return type="Object"> </return> - <argument index="0" name="what" type="var"> + <argument index="0" name="what" type="Variant"> </argument> <argument index="1" name="type" type="int"> </argument> @@ -443,9 +443,9 @@ <method name="str"> <return type="String"> </return> - <argument index="0" name="what" type="var"> + <argument index="0" name="what" type="Variant"> </argument> - <argument index="1" name="..." type="var"> + <argument index="1" name="..." type="Variant"> </argument> <description> Convert one or more arguments to strings in the best way possible. @@ -454,9 +454,9 @@ <method name="str"> <return type="String"> </return> - <argument index="0" name="what" type="var"> + <argument index="0" name="what" type="Variant"> </argument> - <argument index="1" name="..." type="var"> + <argument index="1" name="..." type="Variant"> </argument> <description> Convert one or more arguments to strings in the best way possible. @@ -465,9 +465,9 @@ <method name="print"> <return type="Nil"> </return> - <argument index="0" name="what" type="var"> + <argument index="0" name="what" type="Variant"> </argument> - <argument index="1" name="..." type="var"> + <argument index="1" name="..." type="Variant"> </argument> <description> Print one or more arguments to strings in the best way possible to a console line. @@ -476,9 +476,9 @@ <method name="printt"> <return type="Nil"> </return> - <argument index="0" name="what" type="var"> + <argument index="0" name="what" type="Variant"> </argument> - <argument index="1" name="..." type="var"> + <argument index="1" name="..." type="Variant"> </argument> <description> Print one or more arguments to the console with a tab between each argument. @@ -487,9 +487,9 @@ <method name="prints"> <return type="Nil"> </return> - <argument index="0" name="what" type="var"> + <argument index="0" name="what" type="Variant"> </argument> - <argument index="1" name="..." type="var"> + <argument index="1" name="..." type="Variant"> </argument> <description> </description> @@ -497,9 +497,9 @@ <method name="printerr"> <return type="Nil"> </return> - <argument index="0" name="what" type="var"> + <argument index="0" name="what" type="Variant"> </argument> - <argument index="1" name="..." type="var"> + <argument index="1" name="..." type="Variant"> </argument> <description> Print one or more arguments to strings in the best way possible to standard error line. @@ -508,9 +508,9 @@ <method name="printraw"> <return type="Nil"> </return> - <argument index="0" name="what" type="var"> + <argument index="0" name="what" type="Variant"> </argument> - <argument index="1" name="..." type="var"> + <argument index="1" name="..." type="Variant"> </argument> <description> Print one or more arguments to strings in the best way possible to console. No newline is added at the end. @@ -519,25 +519,40 @@ <method name="var2str"> <return type="String"> </return> - <argument index="0" name="var" type="var"> + <argument index="0" name="var" type="Variant"> </argument> <description> Converts the value of a variable to a String. </description> </method> - <method name="str2var:var"> - <return type="Nil"> + <method name="str2var"> + <return type="Variant"> </return> <argument index="0" name="string" type="String"> </argument> <description> - Converts the value of a String to a variable. + </description> + </method> + <method name="var2bytes"> + <return type="RawArray"> + </return> + <argument index="0" name="var" type="Variant"> + </argument> + <description> + </description> + </method> + <method name="bytes2var"> + <return type="Variant"> + </return> + <argument index="0" name="bytes" type="RawArray"> + </argument> + <description> </description> </method> <method name="range"> <return type="Array"> </return> - <argument index="0" name="..." type="var"> + <argument index="0" name="..." type="Variant"> </argument> <description> Return an array with the given range. Range can be 1 argument N (0 to N-1), two arguments (initial, final-1) or three arguments (initial,final-1,increment). @@ -573,12 +588,26 @@ <method name="hash"> <return type="int"> </return> - <argument index="0" name="var:var" type="var"> + <argument index="0" name="var:Variant" type="Variant"> </argument> <description> Hashes the variable passed and returns an integer. </description> </method> + <method name="Color8"> + <return type="Color"> + </return> + <argument index="0" name="r8" type="int"> + </argument> + <argument index="1" name="g8" type="int"> + </argument> + <argument index="2" name="b8" type="int"> + </argument> + <argument index="3" name="a8" type="int"> + </argument> + <description> + </description> + </method> <method name="print_stack"> <return type="Nil"> </return> @@ -1371,6 +1400,10 @@ </constant> <constant name="JOY_ANALOG_2_Y" value="5"> </constant> + <constant name="JOY_ANALOG_L2" value="6"> + </constant> + <constant name="JOY_ANALOG_R2" value="7"> + </constant> <constant name="OK" value="0"> Functions that return [Error] return OK when everything went ok. Most functions don't return error anyway and/or just print errors to stdout. </constant> @@ -1603,7 +1636,7 @@ Axis-Aligned Bounding Box. </brief_description> <description> - AABB provides an 3D Axis-Aligned Bounding Box. It consists of a position and a size, and several utility functions. It is typically used for simple (fast) overlap tests. + AABB provides an 3D Axis-Aligned Bounding Box. It consists of a position, a size, and several utility functions. It is typically used for simple (fast) overlap tests. </description> <methods> <method name="encloses"> @@ -1628,7 +1661,7 @@ <return type="float"> </return> <description> - Get the area inside the [AABB]. + Get the area of the [AABB]. </description> </method> <method name="get_endpoint"> @@ -1697,7 +1730,7 @@ <argument index="0" name="by" type="float"> </argument> <description> - Return a copy of the AABB grown a given a mount of units towards all the sides. + Return a copy of the [AABB] grown a given amount of units towards all the sides. </description> </method> <method name="has_no_area"> @@ -1747,7 +1780,7 @@ <argument index="0" name="plane" type="Plane"> </argument> <description> - Return true if the AABB is at both sides of a plane. + Return true if the [AABB] is at both sides of a plane. </description> </method> <method name="intersects_segment"> @@ -1766,7 +1799,7 @@ <argument index="0" name="with" type="AABB"> </argument> <description> - Combine this [AABB] with another one, a larger one is returned that contains both. + Combine this [AABB] with another, a larger one is returned that contains both. </description> </method> <method name="AABB"> @@ -1849,6 +1882,8 @@ </description> </method> <method name="register_text_enter"> + <return type="LineEdit"> + </return> <argument index="0" name="line_edit" type="Object"> </argument> <description> @@ -2412,7 +2447,7 @@ </class> <class name="AnimationPlayer" inherits="Node" category="Core"> <brief_description> - Container and player of [Animaton] resources. + Container and player of [Animation] resources. </brief_description> <description> An animation player is used for general purpose playback of [Animation] resources. It contains a dictionary of animations (referenced by name) and custom blend times between their transitions. Additionally, animations can be played and blended in diferent channels. @@ -3257,6 +3292,12 @@ <argument index="0" name="enable" type="int"> </argument> <description> + Set the space override mode. This mode controls how an area affects gravity and damp. + AREA_SPACE_OVERRIDE_DISABLED: This area does not affect gravity/damp. These are generally areas that exist only to detect collisions, and objects entering or exiting them. + AREA_SPACE_OVERRIDE_COMBINE: This area adds its gravity/damp values to whatever has been calculated so far. This way, many overlapping areas can combine their physics to make interesting effects. + AREA_SPACE_OVERRIDE_COMBINE_REPLACE: This area adds its gravity/damp values to whatever has been calculated so far. Then stops taking into account the rest of the areas, even the default one. + AREA_SPACE_OVERRIDE_REPLACE: This area replaces any gravity/damp, even the default one, and stops taking into account the rest of the areas. + AREA_SPACE_OVERRIDE_REPLACE_COMBINE: This area replaces any gravity/damp calculated so far, but keeps calculating the rest of the areas, down to the default one. </description> </method> <method name="get_space_override_mode" qualifiers="const"> @@ -3481,133 +3522,162 @@ </class> <class name="Area2D" inherits="CollisionObject2D" category="Core"> <brief_description> - General purpose area detection and influence for 2D Phisics. + General purpose area detection and influence for 2D physics. </brief_description> <description> - General purpose area detection for 2D Phisics. Areas can be used for detection of objects that enter/exit them, as well as overriding space parameters (changing gravity, damping, etc). An Area2D can be set as a children to a RigidBody2D to generate a custom gravity field. For this, use SPACE_OVERRIDE_COMBINE and point gravity at the center of mass. + General purpose area detection for 2D physics. Areas can be used for detection of objects that enter/exit them, as well as overriding space parameters (changing gravity, damping, etc). For this, use any space override different from AREA_SPACE_OVERRIDE_DISABLE and point gravity at the center of mass. </description> <methods> <method name="set_space_override_mode"> <argument index="0" name="enable" type="int"> </argument> <description> + Set the space override mode. This mode controls how an area affects gravity and damp. + AREA_SPACE_OVERRIDE_DISABLED: This area does not affect gravity/damp. These are generally areas that exist only to detect collisions, and objects entering or exiting them. + AREA_SPACE_OVERRIDE_COMBINE: This area adds its gravity/damp values to whatever has been calculated so far. This way, many overlapping areas can combine their physics to make interesting effects. + AREA_SPACE_OVERRIDE_COMBINE_REPLACE: This area adds its gravity/damp values to whatever has been calculated so far. Then stops taking into account the rest of the areas, even the default one. + AREA_SPACE_OVERRIDE_REPLACE: This area replaces any gravity/damp, even the default one, and stops taking into account the rest of the areas. + AREA_SPACE_OVERRIDE_REPLACE_COMBINE: This area replaces any gravity/damp calculated so far, but keeps calculating the rest of the areas, down to the default one. </description> </method> <method name="get_space_override_mode" qualifiers="const"> <return type="int"> </return> <description> + Return the space override mode. </description> </method> <method name="set_gravity_is_point"> <argument index="0" name="enable" type="bool"> </argument> <description> - When overriding space parameters, areas can have a center of gravity as a point. + When overriding space parameters, this method sets whether this area has a center of gravity. To set/get the location of the center of gravity, use [method set_gravity_vector]/[method get_gravity_vector]. </description> </method> <method name="is_gravity_a_point" qualifiers="const"> <return type="bool"> </return> <description> - Return if gravity is a point. When overriding space parameters, areas can have a center of gravity as a point. + Return whether gravity is a point. A point gravity will attract objects towards it, as opposed to a gravity vector, which moves them in a given direction. </description> </method> <method name="set_gravity_distance_scale"> <argument index="0" name="distance_scale" type="float"> </argument> <description> + Set the falloff factor for point gravity. The greater this value is, the faster the strength of gravity decreases with the square of distance. </description> </method> <method name="get_gravity_distance_scale" qualifiers="const"> <return type="float"> </return> <description> + Return the falloff factor for point gravity. </description> </method> <method name="set_gravity_vector"> <argument index="0" name="vector" type="Vector2"> </argument> <description> - Set gravity vector. If gravity is a point, this will be the attraction center. + Set the gravity vector. This vector does not have to be normalized. + If gravity is a point (see [method is_gravity_a_point]), this will be the attraction center. </description> </method> <method name="get_gravity_vector" qualifiers="const"> <return type="Vector2"> </return> <description> + Return the gravity vector. If gravity is a point (see [method is_gravity_a_point]), this will be the attraction center. </description> </method> <method name="set_gravity"> <argument index="0" name="gravity" type="float"> </argument> <description> + Set the gravity intensity. This is useful to alter the force of gravity without altering its direction. + This value multiplies the gravity vector, whether it is the given vector ([method set_gravity_vector]), or a calculated one (when using a center of gravity). </description> </method> <method name="get_gravity" qualifiers="const"> <return type="float"> </return> <description> + Return the gravity intensity. </description> </method> <method name="set_linear_damp"> <argument index="0" name="linear_damp" type="float"> </argument> <description> + Set the rate at which objects stop moving in this area, if there are not any other forces moving it. The value is a fraction of its current speed, lost per second. Thus, a value of 1.0 should mean stopping immediately, and 0.0 means the object never stops. + In practice, as the fraction of speed lost gets smaller with each frame, a value of 1.0 does not mean the object will stop in exactly one second. Only when the physics calculations are done at 1 frame per second, it does stop in a second. </description> </method> <method name="get_linear_damp" qualifiers="const"> <return type="float"> </return> <description> + Return the linear damp rate. </description> </method> <method name="set_angular_damp"> <argument index="0" name="angular_damp" type="float"> </argument> <description> + Set the rate at which objects stop spinning in this area, if there are not any other forces making it spin. The value is a fraction of its current speed, lost per second. Thus, a value of 1.0 should mean stopping immediately, and 0.0 means the object never stops. + In practice, as the fraction of speed lost gets smaller with each frame, a value of 1.0 does not mean the object will stop in exactly one second. Only when the physics calculations are done at 1 frame per second, it does stop in a second. </description> </method> <method name="get_angular_damp" qualifiers="const"> <return type="float"> </return> <description> + Return the angular damp rate. </description> </method> <method name="set_priority"> <argument index="0" name="priority" type="float"> </argument> <description> + Set the order in which the area is processed. Greater values mean the area gets processed first. This is useful for areas which have an space override different from AREA_SPACE_OVERRIDE_DISABLED or AREA_SPACE_OVERRIDE_COMBINE, as they replace values, and are thus order-dependent. + Areas with the same priority value get evaluated in an unpredictable order, and should be differentiated if evaluation order is to be important. </description> </method> <method name="get_priority" qualifiers="const"> <return type="float"> </return> <description> + Return the processing order of this area. </description> </method> <method name="set_collision_mask"> <argument index="0" name="collision_mask" type="int"> </argument> <description> + Set the physics layers this area can scan for collisions. </description> </method> <method name="get_collision_mask" qualifiers="const"> <return type="int"> </return> <description> + Return the physics layers this area can scan for collisions. </description> </method> <method name="set_layer_mask"> <argument index="0" name="layer_mask" type="int"> </argument> <description> + Set the physics layers this area is in. + Collidable objects can exist in any of 32 different layers. These layers are not visual, but more of a tagging system instead. A collidable can use these layers/tags to select with which objects it can collide, using [method set_collision_mask]. + A contact is detected if object A is in any of the layers that object B scans, or object B is in any layer scanned by object A. </description> </method> <method name="get_layer_mask" qualifiers="const"> <return type="int"> </return> <description> + Return the physics layer this area is in. </description> </method> <method name="set_collision_mask_bit"> @@ -3616,6 +3686,7 @@ <argument index="1" name="value" type="bool"> </argument> <description> + Set/clear individual bits on the collision mask. This makes selecting the areas scanned easier. </description> </method> <method name="get_collision_mask_bit" qualifiers="const"> @@ -3624,6 +3695,7 @@ <argument index="0" name="bit" type="int"> </argument> <description> + Return an individual bit on the collision mask. </description> </method> <method name="set_layer_mask_bit"> @@ -3632,6 +3704,7 @@ <argument index="1" name="value" type="bool"> </argument> <description> + Set/clear individual bits on the layer mask. This makes getting an area in/out of only one layer easier. </description> </method> <method name="get_layer_mask_bit" qualifiers="const"> @@ -3640,42 +3713,49 @@ <argument index="0" name="bit" type="int"> </argument> <description> + Return an individual bit on the layer mask. </description> </method> <method name="set_enable_monitoring"> <argument index="0" name="enable" type="bool"> </argument> <description> + Set whether this area can detect bodies/areas entering/exiting it. </description> </method> <method name="is_monitoring_enabled" qualifiers="const"> <return type="bool"> </return> <description> + Return whether this area detects bodies/areas entering/exiting it. </description> </method> <method name="set_monitorable"> <argument index="0" name="enable" type="bool"> </argument> <description> + Set whether this area can be detected by other, monitoring, areas. Only areas need to be marked as monitorable. Bodies are always so. </description> </method> <method name="is_monitorable" qualifiers="const"> <return type="bool"> </return> <description> + Set whether this area can be detected by other, monitoring, areas. </description> </method> <method name="get_overlapping_bodies" qualifiers="const"> <return type="Array"> </return> <description> + Return a list of the bodies ([PhysicsBody2D]) that are totally or partially inside this area. </description> </method> <method name="get_overlapping_areas" qualifiers="const"> <return type="Array"> </return> <description> + Return a list of the areas that are totally or partially inside this area. </description> </method> <method name="overlaps_body" qualifiers="const"> @@ -3684,6 +3764,7 @@ <argument index="0" name="body" type="Object"> </argument> <description> + Return whether the body passed is totally or partially inside this area. </description> </method> <method name="overlaps_area" qualifiers="const"> @@ -3692,6 +3773,7 @@ <argument index="0" name="area" type="Object"> </argument> <description> + Return whether the area passed is totally or partially inside this area. </description> </method> </methods> @@ -3700,6 +3782,7 @@ <argument index="0" name="body" type="Object"> </argument> <description> + This signal is triggered only once when a body enters this area. The only parameter passed is the body that entered this area. </description> </signal> <signal name="body_enter_shape"> @@ -3712,12 +3795,14 @@ <argument index="3" name="area_shape" type="int"> </argument> <description> + This signal triggers only once when a body enters this area. The first parameter is the body's [RID]. The second one is the body as an object. The third one is the index of the shape of the body that entered this area, and the fourth one is the index of the shape in this area that repored the entering. </description> </signal> <signal name="area_enter"> <argument index="0" name="area" type="Object"> </argument> <description> + This signal is triggered only once when an area enters this area. The only parameter passed is the area that entered this area. </description> </signal> <signal name="area_enter_shape"> @@ -3730,12 +3815,14 @@ <argument index="3" name="area_shape" type="int"> </argument> <description> + This signal triggers only once when an area enters this area. The first parameter is the area's [RID]. The second one is the area as an object. The third one is the index of the shape entering this area, and the fourth one is the index of the shape in this area that reported the entering. </description> </signal> <signal name="body_exit"> <argument index="0" name="body" type="Object"> </argument> <description> + This signal is triggered only once when a body exits this area. The only parameter passed is the body that exited this area. </description> </signal> <signal name="body_exit_shape"> @@ -3748,12 +3835,14 @@ <argument index="3" name="area_shape" type="int"> </argument> <description> + This signal triggers only once when a body exits this area. The first parameter is the body's [RID]. The second one is the body as an object. The third one is the index of the shape exiting this area, and the fourth one is the index of the shape in this area that reported the exit. </description> </signal> <signal name="area_exit"> <argument index="0" name="area" type="Object"> </argument> <description> + This signal is triggered only once when an area exits this area. The only parameter passed is the area that exited this area. </description> </signal> <signal name="area_exit_shape"> @@ -3766,6 +3855,7 @@ <argument index="3" name="area_shape" type="int"> </argument> <description> + This signal triggers only once when an area exits this area. The first parameter is the area's [RID]. The second one is the area as an object. The third one is the index of the shape entering this area, and the fourth one is the index of the shape in this area that reported the entering. </description> </signal> </signals> @@ -3843,6 +3933,14 @@ Get whether this is a shared array instance. </description> </method> + <method name="pop_back"> + <description> + </description> + </method> + <method name="pop_front"> + <description> + </description> + </method> <method name="push_back"> <argument index="0" name="value" type="var"> </argument> @@ -3850,6 +3948,12 @@ Append an element at the end of the array. </description> </method> + <method name="push_front"> + <argument index="0" name="value" type="var"> + </argument> + <description> + </description> + </method> <method name="remove"> <argument index="0" name="pos" type="int"> </argument> @@ -4033,8 +4137,6 @@ </return> <argument index="0" name="sample" type="RID"> </argument> - <argument index="1" name="arg1" type="String"> - </argument> <description> Return the description of an audio sample. Mainly used for organization. </description> @@ -4078,7 +4180,7 @@ <method name="sample_set_data"> <argument index="0" name="sample" type="RID"> </argument> - <argument index="1" name="arg1" type="RawArray"> + <argument index="1" name="data" type="RawArray"> </argument> <description> Set the sample data for a given sample as an array of bytes. The length must be equal to the sample lenght expected in bytes or an error will be produced. @@ -5891,7 +5993,7 @@ </description> </method> <method name="set_zoom"> - <argument index="0" name="arg0" type="Vector2"> + <argument index="0" name="zoom" type="Vector2"> </argument> <description> </description> @@ -5914,6 +6016,18 @@ <description> </description> </method> + <method name="set_enable_follow_smoothing"> + <argument index="0" name="follow_smoothing" type="bool"> + </argument> + <description> + </description> + </method> + <method name="is_follow_smoothing_enabled" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> <method name="force_update_scroll"> <description> Force the camera to update scroll immediately. @@ -6006,6 +6120,12 @@ Hide the CanvasItem currently visible. </description> </method> + <method name="set_hidden"> + <argument index="0" name="hidden" type="bool"> + </argument> + <description> + </description> + </method> <method name="update"> <description> Queue the CanvasItem for update. NOTIFICATION_DRAW will be called on idle time to request redraw. @@ -6131,6 +6251,8 @@ </argument> <argument index="1" name="pos" type="Vector2"> </argument> + <argument index="2" name="modulate" type="Color" default="Color(1,1,1,1)"> + </argument> <description> Draw a texture at a given position. </description> @@ -6969,7 +7091,7 @@ Base node for 2D collisionables. </brief_description> <description> - CollisionObject2D is the base class for 2D physics collisionables. They can hold any number of 2D collision shapes. Usually, they are edited by placing [CollisionBody2D] and [CollisionPolygon2D] nodes as children. Such nodes are for reference and not present outside the editor, so code should use the regular shape API. + CollisionObject2D is the base class for 2D physics collisionables. They can hold any number of 2D collision shapes. Usually, they are edited by placing [CollisionShape2D] and/or [CollisionPolygon2D] nodes as children. Such nodes are for reference and not present outside the editor, so code should use the regular shape API. </description> <methods> <method name="_input_event" qualifiers="virtual"> @@ -6980,6 +7102,7 @@ <argument index="2" name="shape_idx" type="int"> </argument> <description> + This method can be used to override normal input processing. The first parameter is the viewport where the event took place. The second holds the input event received, and the third the shape of this object where it happened. </description> </method> <method name="add_shape"> @@ -6995,7 +7118,7 @@ <return type="int"> </return> <description> - Return the amount of shapes in the collision body. + Return the amount of shapes in the collision body. Because a [CollisionPolygon2D] can generate more than one [Shape2D], the amount returned does not have to match the sum of [CollisionShape2D] and [CollisionPolygon2D]. </description> </method> <method name="set_shape"> @@ -7022,6 +7145,7 @@ <argument index="1" name="enable" type="bool"> </argument> <description> + Set whether a shape is a trigger. A trigger shape detects collisions, but is otherwise unaffected by physics (i.e. colliding objects will not get blocked). </description> </method> <method name="get_shape" qualifiers="const"> @@ -7048,6 +7172,7 @@ <argument index="0" name="shape_idx" type="int"> </argument> <description> + Return whether a shape is a trigger. A trigger shape detects collisions, but is otherwise unaffected by physics (i.e. colliding objects will not get blocked). </description> </method> <method name="remove_shape"> @@ -7066,25 +7191,28 @@ <return type="RID"> </return> <description> - Return the RID of the object. + Return the RID of this object. </description> </method> <method name="set_pickable"> <argument index="0" name="enabled" type="bool"> </argument> <description> + Set whether this object is pickable. A pickable object can detect the mouse pointer enter/leave it and, if the mouse is inside it, report input events. </description> </method> <method name="is_pickable" qualifiers="const"> <return type="bool"> </return> <description> + Return whether this object is pickable. </description> </method> </methods> <signals> <signal name="mouse_enter"> <description> + This event fires only once when the mouse pointer enters any shape of this object. </description> </signal> <signal name="input_event"> @@ -7095,10 +7223,12 @@ <argument index="2" name="shape_idx" type="int"> </argument> <description> + This signal triggers when an input event fires over a shape. The first parameter is the viewport where the event took place. The second holds the input event received, and the third the shape of this object where it happened. </description> </signal> <signal name="mouse_exit"> <description> + This event fires only once when the mouse pointer exits all shapes of this object. </description> </signal> </signals> @@ -7112,7 +7242,7 @@ </description> <methods> <method name="set_build_mode"> - <argument index="0" name="arg0" type="int"> + <argument index="0" name="build_mode" type="int"> </argument> <description> </description> @@ -7187,7 +7317,7 @@ </description> </method> <method name="set_build_mode"> - <argument index="0" name="arg0" type="int"> + <argument index="0" name="build_mode" type="int"> </argument> <description> Set whether the polygon is to be a [ConvexPolygon2D] ([code]build_mode[/code]=0), or a [ConcavePolygon2D] ([code]build_mode[/code]=1). @@ -7201,7 +7331,7 @@ </description> </method> <method name="set_trigger"> - <argument index="0" name="arg0" type="bool"> + <argument index="0" name="trigger" type="bool"> </argument> <description> Set whether this polygon is a trigger. A trigger polygon detects collisions, but is otherwise unaffected by physics (i.e. colliding objects will not get blocked). @@ -7241,7 +7371,7 @@ </description> <methods> <method name="resource_changed"> - <argument index="0" name="arg0" type="Object"> + <argument index="0" name="resource" type="Object"> </argument> <description> </description> @@ -7464,6 +7594,14 @@ </member> <member name="v" type="float"> </member> + <member name="r8" type="int"> + </member> + <member name="g8" type="int"> + </member> + <member name="b8" type="int"> + </member> + <member name="a8" type="int"> + </member> </members> <constants> </constants> @@ -7671,6 +7809,66 @@ <description> </description> <methods> + <method name="add_point"> + <argument index="0" name="offset" type="float"> + </argument> + <argument index="1" name="color" type="Color"> + </argument> + <description> + </description> + </method> + <method name="remove_point"> + <argument index="0" name="offset" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_offset"> + <argument index="0" name="point" type="int"> + </argument> + <argument index="1" name="offset" type="float"> + </argument> + <description> + </description> + </method> + <method name="get_offset" qualifiers="const"> + <return type="float"> + </return> + <argument index="0" name="point" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_color"> + <argument index="0" name="point" type="int"> + </argument> + <argument index="1" name="color" type="Color"> + </argument> + <description> + </description> + </method> + <method name="get_color" qualifiers="const"> + <return type="Color"> + </return> + <argument index="0" name="point" type="int"> + </argument> + <description> + </description> + </method> + <method name="interpolate"> + <return type="Color"> + </return> + <argument index="0" name="offset" type="float"> + </argument> + <description> + </description> + </method> + <method name="get_point_count" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> <method name="set_offsets"> <argument index="0" name="offsets" type="RealArray"> </argument> @@ -7811,6 +8009,8 @@ </argument> <argument index="1" name="key" type="String"> </argument> + <argument index="2" name="default" type="var" default="NULL"> + </argument> <description> </description> </method> @@ -7841,7 +8041,7 @@ <method name="get_section_keys" qualifiers="const"> <return type="StringArray"> </return> - <argument index="0" name="arg0" type="String"> + <argument index="0" name="section" type="String"> </argument> <description> </description> @@ -8087,6 +8287,18 @@ Move the Control to a new position, relative to the top-left corner of the [i]window[/i] Control, and without changing current anchor mode. (see [method set_margin]). </description> </method> + <method name="set_rotation"> + <argument index="0" name="rotation" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_scale"> + <argument index="0" name="scale" type="Vector2"> + </argument> + <description> + </description> + </method> <method name="get_margin" qualifiers="const"> <return type="float"> </return> @@ -8123,6 +8335,18 @@ Returns the size of the Control, computed from all margins, however the size returned will [b]never be smaller than the minimum size reported by [method get_minimum_size][/b]. This means that even if end position of the Control rectangle is smaller than the begin position, the Control will still display and interact correctly. (see description, [method get_minimum_size], [method set_margin], [method set_anchor]). </description> </method> + <method name="get_rotation" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_scale" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + </description> + </method> <method name="get_custom_minimum_size" qualifiers="const"> <return type="Vector2"> </return> @@ -9539,7 +9763,7 @@ This approximation makes straight segments between each point, then subdivides t </description> </method> <method name="set_show_hidden_files"> - <argument index="0" name="arg0" type="bool"> + <argument index="0" name="show" type="bool"> </argument> <description> </description> @@ -10132,6 +10356,12 @@ This approximation makes straight segments between each point, then subdivides t <description> </description> </method> + <method name="get_length" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> <method name="set_autoplay"> <argument index="0" name="enabled" type="bool"> </argument> @@ -10152,24 +10382,18 @@ This approximation makes straight segments between each point, then subdivides t <description> </description> </method> - <method name="get_channel_volumeidx" qualifiers="const"> + <method name="get_channel_volume" qualifiers="const"> <return type="float"> </return> - <argument index="0" name="arg0" type="int"> + <argument index="0" name="idx" type="int"> </argument> <description> </description> </method> - <method name="get_length" qualifiers="const"> - <return type="float"> - </return> - <description> - </description> - </method> <method name="get_channel_last_note_time" qualifiers="const"> <return type="float"> </return> - <argument index="0" name="arg0" type="int"> + <argument index="0" name="idx" type="int"> </argument> <description> </description> @@ -10556,7 +10780,7 @@ This approximation makes straight segments between each point, then subdivides t </description> </method> <method name="set_show_hidden_files"> - <argument index="0" name="arg0" type="bool"> + <argument index="0" name="show" type="bool"> </argument> <description> </description> @@ -10618,6 +10842,8 @@ This approximation makes straight segments between each point, then subdivides t </theme_item> <theme_item name="folder" type="Texture"> </theme_item> + <theme_item name="reload" type="Texture"> + </theme_item> </theme_items> </class> <class name="FixedMaterial" inherits="Material" category="Core"> @@ -10856,9 +11082,9 @@ This approximation makes straight segments between each point, then subdivides t <method name="get_kerning_pair" qualifiers="const"> <return type="int"> </return> - <argument index="0" name="arg0" type="int"> + <argument index="0" name="char_a" type="int"> </argument> - <argument index="1" name="arg1" type="int"> + <argument index="1" name="char_b" type="int"> </argument> <description> Return a kerning pair as a difference. Kerning pairs are special cases where a typeface advance is determined by the next character. @@ -10969,6 +11195,18 @@ This approximation makes straight segments between each point, then subdivides t Draw character "char" into a canvas item using the font at a given "pos" position, with "modulate" color, and optionally kerning if "next" is apassed. clipping the width. "pos" specifies te baseline, not the top. To draw from the top, [i]ascent[/i] must be added to the Y axis. The width used by the character is returned, making this function useful for drawing strings character by character. </description> </method> + <method name="set_fallback"> + <argument index="0" name="fallback" type="Object"> + </argument> + <description> + </description> + </method> + <method name="get_fallback" qualifiers="const"> + <return type="Object"> + </return> + <description> + </description> + </method> </methods> <constants> </constants> @@ -11026,6 +11264,8 @@ This approximation makes straight segments between each point, then subdivides t </description> <methods> <method name="resume"> + <return type="Variant"> + </return> <argument index="0" name="arg" type="var" default="NULL"> </argument> <description> @@ -11632,7 +11872,7 @@ This approximation makes straight segments between each point, then subdivides t <method name="has_singleton" qualifiers="const"> <return type="bool"> </return> - <argument index="0" name="arg0" type="String"> + <argument index="0" name="name" type="String"> </argument> <description> </description> @@ -11640,7 +11880,7 @@ This approximation makes straight segments between each point, then subdivides t <method name="get_singleton" qualifiers="const"> <return type="Object"> </return> - <argument index="0" name="arg0" type="String"> + <argument index="0" name="name" type="String"> </argument> <description> </description> @@ -11648,7 +11888,7 @@ This approximation makes straight segments between each point, then subdivides t <method name="load_resource_pack"> <return type="bool"> </return> - <argument index="0" name="arg0" type="String"> + <argument index="0" name="pack" type="String"> </argument> <description> </description> @@ -11656,7 +11896,7 @@ This approximation makes straight segments between each point, then subdivides t <method name="save_custom"> <return type="int"> </return> - <argument index="0" name="arg0" type="String"> + <argument index="0" name="file" type="String"> </argument> <description> </description> @@ -12172,7 +12412,7 @@ This approximation makes straight segments between each point, then subdivides t </description> </method> <method name="resource_changed"> - <argument index="0" name="arg0" type="Object"> + <argument index="0" name="resource" type="Object"> </argument> <description> </description> @@ -13147,6 +13387,21 @@ returns:= "username=user&password=pass" <description> </description> </method> + <method name="Image"> + <return type="Image"> + </return> + <argument index="0" name="width" type="int"> + </argument> + <argument index="1" name="height" type="int"> + </argument> + <argument index="2" name="mipmaps" type="bool"> + </argument> + <argument index="3" name="format" type="int"> + </argument> + <description> + Create an empty image of a specific size and format. + </description> + </method> </methods> <constants> <constant name="COMPRESS_BC" value="0"> @@ -13291,6 +13546,10 @@ returns:= "username=user&password=pass" <description> </description> </method> + <method name="shrink_x2_and_keep_size"> + <description> + </description> + </method> <method name="set_size_override"> <argument index="0" name="size" type="Vector2"> </argument> @@ -13409,6 +13668,7 @@ returns:= "username=user&password=pass" <argument index="1" name="button" type="int"> </argument> <description> + Returns true if the joystick button at the given index is currently pressed. Returns false otherwise. (see JOY_* constans in [InputEvent]) </description> </method> <method name="is_action_pressed"> @@ -13419,6 +13679,31 @@ returns:= "username=user&password=pass" <description> </description> </method> + <method name="add_joy_mapping"> + <argument index="0" name="mapping" type="String"> + </argument> + <argument index="1" name="update_existing" type="bool" default="false"> + </argument> + <description> + Add a new mapping entry (in SDL2 format) to the mapping database. Optionally update already connected devices. + </description> + </method> + <method name="remove_joy_mapping"> + <argument index="0" name="guid" type="String"> + </argument> + <description> + Removes all mappings from the internal db that match the given uid. + </description> + </method> + <method name="is_joy_known"> + <return type="bool"> + </return> + <argument index="0" name="device" type="int"> + </argument> + <description> + Returns true if the specified device is known by the system. This means that it sets all button and axis indices exactly as defined in [InputEvent]. Unknown joysticks are not expected to match these constants, but you can still retrieve events from them. + </description> + </method> <method name="get_joy_axis"> <return type="float"> </return> @@ -13427,6 +13712,7 @@ returns:= "username=user&password=pass" <argument index="1" name="axis" type="int"> </argument> <description> + Returns the current value of the joystick axis at given index (see JOY_* enum in [InputEvent]) </description> </method> <method name="get_joy_name"> @@ -13435,6 +13721,16 @@ returns:= "username=user&password=pass" <argument index="0" name="device" type="int"> </argument> <description> + Returns the name of the joystick at the specified device index + </description> + </method> + <method name="get_joy_guid" qualifiers="const"> + <return type="String"> + </return> + <argument index="0" name="device" type="int"> + </argument> + <description> + Returns a SDL2 compatible device guid on platforms that use gamepad remapping. Returns "Default Gamepad" otherwise. </description> </method> <method name="get_accelerometer"> @@ -13474,13 +13770,13 @@ returns:= "username=user&password=pass" </description> </method> <method name="action_press"> - <argument index="0" name="arg0" type="String"> + <argument index="0" name="action" type="String"> </argument> <description> </description> </method> <method name="action_release"> - <argument index="0" name="arg0" type="String"> + <argument index="0" name="action" type="String"> </argument> <description> </description> @@ -14960,6 +15256,18 @@ returns:= "username=user&password=pass" <description> </description> </method> + <method name="set_exclude_nodes_from_collision"> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + </description> + </method> + <method name="get_exclude_nodes_from_collision" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> </methods> <constants> </constants> @@ -14976,7 +15284,7 @@ returns:= "username=user&password=pass" <argument index="0" name="node" type="NodePath"> </argument> <description> - Set the path to the A node for the joint. Must be of type PhysicsBody2D. + Set the path to the A node for the joint. Must be of type [PhysicsBody2D]. </description> </method> <method name="get_node_a" qualifiers="const"> @@ -14990,7 +15298,7 @@ returns:= "username=user&password=pass" <argument index="0" name="node" type="NodePath"> </argument> <description> - Set the path to the B node for the joint. Must be of type PhysicsBody2D. + Set the path to the B node for the joint. Must be of type [PhysicsBody2D]. </description> </method> <method name="get_node_b" qualifiers="const"> @@ -15012,6 +15320,18 @@ returns:= "username=user&password=pass" <description> </description> </method> + <method name="set_exclude_nodes_from_collision"> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + </description> + </method> + <method name="get_exclude_nodes_from_collision" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> </methods> <constants> </constants> @@ -15038,14 +15358,13 @@ returns:= "username=user&password=pass" <description> </description> </method> - <method name="can_move_to"> + <method name="can_teleport_to"> <return type="bool"> </return> <argument index="0" name="position" type="Vector3"> </argument> - <argument index="1" name="arg1" type="bool"> - </argument> <description> + Returns whether the KinematicBody can be teleported to the destination given as an argument, checking all collision shapes of the body against potential colliders at the destination. </description> </method> <method name="is_colliding" qualifiers="const"> @@ -15073,6 +15392,8 @@ returns:= "username=user&password=pass" </description> </method> <method name="get_collider" qualifiers="const"> + <return type="Object"> + </return> <description> </description> </method> @@ -15148,8 +15469,12 @@ returns:= "username=user&password=pass" </class> <class name="KinematicBody2D" inherits="PhysicsBody2D" category="Core"> <brief_description> + Kinematic body 2D node. </brief_description> <description> + Kinematic bodies are special types of bodies that are meant to be user-controlled. They are not affected by physics at all (to other types of bodies, such a character or a rigid body, these are the same as a static body). They have however, two main uses: + Simulated Motion: When these bodies are moved manually, either from code or from an AnimationPlayer (with process mode set to fixed), the physics will automatically compute an estimate of their linear and angular velocity. This makes them very useful for moving platforms or other AnimationPlayer-controlled objects (like a door, a bridge that opens, etc). + Kinematic Characters: KinematicBody2D also has an api for moving objects (the [method move] method) while performing collision tests. This makes them really useful to implement characters that collide against a world, but that don't require advanced physics. </description> <methods> <method name="move"> @@ -15158,6 +15483,7 @@ returns:= "username=user&password=pass" <argument index="0" name="rel_vec" type="Vector2"> </argument> <description> + Move the body in the given direction, stopping if there is an obstacle. </description> </method> <method name="move_to"> @@ -15166,6 +15492,7 @@ returns:= "username=user&password=pass" <argument index="0" name="position" type="Vector2"> </argument> <description> + Move the body to the given position. This is not a teleport, and the body will stop if there is an obstacle. </description> </method> <method name="test_move"> @@ -15174,66 +15501,82 @@ returns:= "username=user&password=pass" <argument index="0" name="rel_vec" type="Vector2"> </argument> <description> + Return true if there would be a collision if the body moved in the given direction. </description> </method> <method name="get_travel" qualifiers="const"> <return type="Vector2"> </return> <description> + Return the last movement done by the body. </description> </method> <method name="revert_motion"> <description> + Undo the last movement done by the body. </description> </method> <method name="is_colliding" qualifiers="const"> <return type="bool"> </return> <description> + Return whether the body is colliding with another. </description> </method> <method name="get_collision_pos" qualifiers="const"> <return type="Vector2"> </return> <description> + Return the point in space where the body is touching another. If there is no collision, this method will return (0,0), so collisions must be checked first with [method is_colliding]. </description> </method> <method name="get_collision_normal" qualifiers="const"> <return type="Vector2"> </return> <description> + Return the normal of the surface the body collided with. This is useful to implement sliding along a surface. </description> </method> <method name="get_collider_velocity" qualifiers="const"> <return type="Vector2"> </return> <description> + Return the velocity of the body that collided with this one. </description> </method> <method name="get_collider" qualifiers="const"> + <return type="Object"> + </return> <description> + Return the body that collided with this one. </description> </method> <method name="get_collider_shape" qualifiers="const"> <return type="int"> </return> <description> + Return the shape index from the body that collided with this one. If there is no collision, this method will return 0, so collisions must be checked first with [method is_colliding]. </description> </method> <method name="get_collider_metadata" qualifiers="const"> + <return type="Variant"> + </return> <description> + Return the metadata of the shape that collided with this body. If there is no collision, it will return 0, so collisions must be checked first with [method is_colliding]. Aditionally, this metadata can not be set with [method Object.set_meta], it must be set with [method Physics2DServer.body_set_shape_metadata]. </description> </method> <method name="set_collision_margin"> <argument index="0" name="pixels" type="float"> </argument> <description> + Set the collision margin for this object. A collision margin is an amount (in pixels) that all shapes will grow when computing collisions, to account for numerical imprecision. </description> </method> <method name="get_collision_margin" qualifiers="const"> <return type="float"> </return> <description> + Return the collision margin for this object. </description> </method> </methods> @@ -15538,7 +15881,7 @@ returns:= "username=user&password=pass" <method name="get_parameter" qualifiers="const"> <return type="float"> </return> - <argument index="0" name="arg0" type="int"> + <argument index="0" name="variable" type="int"> </argument> <description> </description> @@ -15554,7 +15897,7 @@ returns:= "username=user&password=pass" <method name="get_color" qualifiers="const"> <return type="Color"> </return> - <argument index="0" name="arg0" type="int"> + <argument index="0" name="color" type="int"> </argument> <description> </description> @@ -15891,6 +16234,8 @@ returns:= "username=user&password=pass" </constant> <constant name="MODE_MIX" value="2"> </constant> + <constant name="MODE_MASK" value="3"> + </constant> </constants> </class> <class name="LightOccluder2D" inherits="Node2D" category="Core"> @@ -16255,6 +16600,8 @@ returns:= "username=user&password=pass" </description> </method> <method name="base64_to_variant"> + <return type="Variant"> + </return> <argument index="0" name="base64_str" type="String"> </argument> <description> @@ -16843,9 +17190,9 @@ returns:= "username=user&password=pass" </argument> <argument index="1" name="arrays" type="Array"> </argument> - <argument index="2" name="morph_arrays" type="Array"> + <argument index="2" name="morph_arrays" type="Array" default="Array()"> </argument> - <argument index="3" name="arg3" type="bool" default="Array()"> + <argument index="3" name="alphasort" type="bool" default="false"> </argument> <description> Create a new surface ([method get_surface_count] that will become surf_idx for this. @@ -17518,7 +17865,7 @@ returns:= "username=user&password=pass" </description> </method> <method name="set_instance_count"> - <argument index="0" name="arg0" type="int"> + <argument index="0" name="count" type="int"> </argument> <description> Set the amount of instnces that is going to be drawn. Changing this number will erase all the existing instance transform and color data. @@ -17532,9 +17879,9 @@ returns:= "username=user&password=pass" </description> </method> <method name="set_instance_transform"> - <argument index="0" name="arg0" type="int"> + <argument index="0" name="instance" type="int"> </argument> - <argument index="1" name="arg1" type="Transform"> + <argument index="1" name="transform" type="Transform"> </argument> <description> Set the transform for a specific instance. @@ -17543,16 +17890,16 @@ returns:= "username=user&password=pass" <method name="get_instance_transform" qualifiers="const"> <return type="Transform"> </return> - <argument index="0" name="arg0" type="int"> + <argument index="0" name="instance" type="int"> </argument> <description> Return the transform of a specific instance. </description> </method> <method name="set_instance_color"> - <argument index="0" name="arg0" type="int"> + <argument index="0" name="instance" type="int"> </argument> - <argument index="1" name="arg1" type="Color"> + <argument index="1" name="color" type="Color"> </argument> <description> Set the color of a specific instance. @@ -17561,14 +17908,14 @@ returns:= "username=user&password=pass" <method name="get_instance_color" qualifiers="const"> <return type="Color"> </return> - <argument index="0" name="arg0" type="int"> + <argument index="0" name="instance" type="int"> </argument> <description> Get the color of a specific instance. </description> </method> <method name="set_aabb"> - <argument index="0" name="arg0" type="AABB"> + <argument index="0" name="visibility_aabb" type="AABB"> </argument> <description> Set the visibility AABB. If not provided, MultiMesh will not be visible. @@ -18269,8 +18616,11 @@ returns:= "username=user&password=pass" <method name="add_child"> <argument index="0" name="node" type="Node"> </argument> + <argument index="1" name="legible_unique_name" type="bool" default="false"> + </argument> <description> Add a child [Node]. Nodes can have as many children as they want, but every child must have a unique name. Children nodes are automatically deleted when the parent node is deleted, so deleting a whole scene is performed by deleting its topmost node. + The optional boolean argument enforces creating child node with human-readable names, based on the name of node being instanced instead of its type only. </description> </method> <method name="remove_child"> @@ -18412,7 +18762,7 @@ returns:= "username=user&password=pass" <method name="add_to_group"> <argument index="0" name="group" type="String"> </argument> - <argument index="1" name="arg1" type="bool" default="false"> + <argument index="1" name="persistent" type="bool" default="false"> </argument> <description> Add a node to a group. Groups are helpers to name and organize group of nodes, like for example: "Enemies", "Collectables", etc. A [Node] can be in any number of groups. Nodes can be assigned a group at any time, but will not be added to it until they are inside the scene tree (see [method is_inside_scene]). @@ -18701,6 +19051,8 @@ returns:= "username=user&password=pass" </constant> <constant name="NOTIFICATION_UNPAUSED" value="15"> </constant> + <constant name="NOTIFICATION_INSTANCED" value="20"> + </constant> <constant name="PAUSE_MODE_INHERIT" value="0"> </constant> <constant name="PAUSE_MODE_STOP" value="1"> @@ -18863,15 +19215,15 @@ returns:= "username=user&password=pass" </description> </method> <method name="edit_set_pivot"> - <argument index="0" name="arg0" type="Vector2"> + <argument index="0" name="pivot" type="Vector2"> </argument> <description> </description> </method> - <method name="get_relative_transform" qualifiers="const"> + <method name="get_relative_transform_to_parent" qualifiers="const"> <return type="Matrix32"> </return> - <argument index="0" name="arg0" type="Object"> + <argument index="0" name="parent" type="Object"> </argument> <description> </description> @@ -19340,7 +19692,7 @@ returns:= "username=user&password=pass" </description> </method> <method name="set_icon"> - <argument index="0" name="arg0" type="Image"> + <argument index="0" name="icon" type="Image"> </argument> <description> </description> @@ -19505,7 +19857,7 @@ returns:= "username=user&password=pass" </description> </method> <method name="print_resources_by_type"> - <argument index="0" name="arg0" type="StringArray"> + <argument index="0" name="types" type="StringArray"> </argument> <description> </description> @@ -19513,13 +19865,13 @@ returns:= "username=user&password=pass" <method name="native_video_play"> <return type="int"> </return> - <argument index="0" name="arg0" type="String"> + <argument index="0" name="path" type="String"> </argument> - <argument index="1" name="arg1" type="float"> + <argument index="1" name="volume" type="float"> </argument> - <argument index="2" name="arg2" type="String"> + <argument index="2" name="audio_track" type="String"> </argument> - <argument index="3" name="arg3" type="String"> + <argument index="3" name="subtitle_track" type="String"> </argument> <description> </description> @@ -19746,7 +20098,7 @@ returns:= "username=user&password=pass" <method name="notification"> <argument index="0" name="what" type="int"> </argument> - <argument index="1" name="arg1" type="bool" default="false"> + <argument index="1" name="reversed" type="bool" default="false"> </argument> <description> Notify the object of something. @@ -19884,6 +20236,8 @@ returns:= "username=user&password=pass" </description> </method> <method name="callv"> + <return type="Variant"> + </return> <argument index="0" name="method" type="String"> </argument> <argument index="1" name="arg_array" type="Array"> @@ -19894,7 +20248,7 @@ returns:= "username=user&password=pass" <method name="has_method" qualifiers="const"> <return type="bool"> </return> - <argument index="0" name="arg0" type="String"> + <argument index="0" name="method" type="String"> </argument> <description> </description> @@ -19906,6 +20260,14 @@ returns:= "username=user&password=pass" Return the list of signals as an array of dictionaries. </description> </method> + <method name="get_signal_connection_list" qualifiers="const"> + <return type="Array"> + </return> + <argument index="0" name="signal" type="String"> + </argument> + <description> + </description> + </method> <method name="connect"> <return type="int"> </return> @@ -20222,7 +20584,7 @@ returns:= "username=user&password=pass" </description> </method> <method name="select"> - <argument index="0" name="arg0" type="int"> + <argument index="0" name="idx" type="int"> </argument> <description> Select an item by index and make it the current item. @@ -20321,7 +20683,7 @@ returns:= "username=user&password=pass" <method name="flush"> <return type="int"> </return> - <argument index="0" name="arg0" type="bool"> + <argument index="0" name="verbose" type="bool"> </argument> <description> </description> @@ -20437,7 +20799,7 @@ returns:= "username=user&password=pass" <method name="put_var"> <return type="int"> </return> - <argument index="0" name="var" type="var"> + <argument index="0" name="var" type="Variant"> </argument> <description> </description> @@ -20658,7 +21020,7 @@ returns:= "username=user&password=pass" </description> </method> <method name="set_ignore_camera_zoom"> - <argument index="0" name="arg0" type="bool"> + <argument index="0" name="ignore" type="bool"> </argument> <description> </description> @@ -20921,7 +21283,7 @@ returns:= "username=user&password=pass" <method name="get_randomness" qualifiers="const"> <return type="float"> </return> - <argument index="0" name="arg0" type="int"> + <argument index="0" name="variable" type="int"> </argument> <description> Return the randomness for a specific variable of the particle system. Randomness produces small changes from the default each time a particle is emitted. @@ -20978,7 +21340,7 @@ returns:= "username=user&password=pass" </description> </method> <method name="set_emit_timeout"> - <argument index="0" name="arg0" type="float"> + <argument index="0" name="timeout" type="float"> </argument> <description> </description> @@ -21168,6 +21530,8 @@ returns:= "username=user&password=pass" </description> </method> <method name="set_texture"> + <return type="Texture"> + </return> <argument index="0" name="texture" type="Object"> </argument> <description> @@ -21192,6 +21556,8 @@ returns:= "username=user&password=pass" </description> </method> <method name="set_color_ramp"> + <return type="ColorRamp"> + </return> <argument index="0" name="color_ramp" type="Object"> </argument> <description> @@ -21325,6 +21691,10 @@ returns:= "username=user&password=pass" <description> </description> </method> + <method name="reset"> + <description> + </description> + </method> <method name="set_use_local_space"> <argument index="0" name="enable" type="bool"> </argument> @@ -22070,6 +22440,8 @@ This method controls whether the position between two cached points is interpola </description> </method> <method name="get_contact_collider_shape_metadata" qualifiers="const"> + <return type="Variant"> + </return> <argument index="0" name="contact_idx" type="int"> </argument> <description> @@ -22484,11 +22856,11 @@ This method controls whether the position between two cached points is interpola </description> </method> <method name="area_set_monitor_callback"> - <argument index="0" name="receiver" type="RID"> + <argument index="0" name="area" type="RID"> </argument> - <argument index="1" name="method" type="Object"> + <argument index="1" name="receiver" type="Object"> </argument> - <argument index="2" name="arg2" type="String"> + <argument index="2" name="method" type="String"> </argument> <description> </description> @@ -22798,9 +23170,9 @@ This method controls whether the position between two cached points is interpola </description> </method> <method name="body_set_one_way_collision_direction"> - <argument index="0" name="normal" type="RID"> + <argument index="0" name="body" type="RID"> </argument> - <argument index="1" name="arg1" type="Vector2"> + <argument index="1" name="normal" type="Vector2"> </argument> <description> </description> @@ -22808,15 +23180,15 @@ This method controls whether the position between two cached points is interpola <method name="body_get_one_way_collision_direction" qualifiers="const"> <return type="Vector2"> </return> - <argument index="0" name="arg0" type="RID"> + <argument index="0" name="body" type="RID"> </argument> <description> </description> </method> <method name="body_set_one_way_collision_max_depth"> - <argument index="0" name="normal" type="RID"> + <argument index="0" name="body" type="RID"> </argument> - <argument index="1" name="arg1" type="float"> + <argument index="1" name="depth" type="float"> </argument> <description> </description> @@ -22824,7 +23196,7 @@ This method controls whether the position between two cached points is interpola <method name="body_get_one_way_collision_max_depth" qualifiers="const"> <return type="float"> </return> - <argument index="0" name="arg0" type="RID"> + <argument index="0" name="body" type="RID"> </argument> <description> </description> @@ -22852,7 +23224,7 @@ This method controls whether the position between two cached points is interpola </argument> <argument index="2" name="method" type="String"> </argument> - <argument index="3" name="arg3" type="var"> + <argument index="3" name="userdata" type="var" default="NULL"> </argument> <description> </description> @@ -22976,7 +23348,7 @@ This method controls whether the position between two cached points is interpola <method name="get_process_info"> <return type="int"> </return> - <argument index="0" name="arg0" type="int"> + <argument index="0" name="process_info" type="int"> </argument> <description> </description> @@ -23015,11 +23387,20 @@ This method controls whether the position between two cached points is interpola </constant> <constant name="AREA_PARAM_PRIORITY" value="7"> </constant> + <constant name="AREA_SPACE_OVERRIDE_DISABLED" value="0"> + This area does not affect gravity/damp. These are generally areas that exist only to detect collisions, and objects entering or exiting them. + </constant> <constant name="AREA_SPACE_OVERRIDE_COMBINE" value="1"> + This area adds its gravity/damp values to whatever has been calculated so far. This way, many overlapping areas can combine their physics to make interesting effects. </constant> - <constant name="AREA_SPACE_OVERRIDE_DISABLED" value="0"> + <constant name="AREA_SPACE_OVERRIDE_COMBINE_REPLACE" value="2"> + This area adds its gravity/damp values to whatever has been calculated so far. Then stops taking into account the rest of the areas, even the default one. + </constant> + <constant name="AREA_SPACE_OVERRIDE_REPLACE" value="3"> + This area replaces any gravity/damp, even the default one, and stops taking into account the rest of the areas. </constant> - <constant name="AREA_SPACE_OVERRIDE_REPLACE" value="2"> + <constant name="AREA_SPACE_OVERRIDE_REPLACE_COMBINE" value="4"> + This area replaces any gravity/damp calculated so far, but keeps calculating the rest of the areas, down to the default one. </constant> <constant name="BODY_MODE_STATIC" value="0"> </constant> @@ -23307,7 +23688,7 @@ This method controls whether the position between two cached points is interpola </class> <class name="PhysicsBody" inherits="CollisionObject" category="Core"> <brief_description> - Base class for differnt types of Physics bodies. + Base class for different types of Physics bodies. </brief_description> <description> PhysicsBody is an abstract base class for implementing a physics body. All PhysicsBody types inherit from it. @@ -23343,32 +23724,40 @@ This method controls whether the position between two cached points is interpola </class> <class name="PhysicsBody2D" inherits="CollisionObject2D" category="Core"> <brief_description> + Base class for all objects affected by physics. </brief_description> <description> + PhysicsBody2D is an abstract base class for implementing a physics body. All [i]x[/i]Body2D types inherit from it. </description> <methods> <method name="set_layer_mask"> <argument index="0" name="mask" type="int"> </argument> <description> + Set the physics layers this area is in. + Collidable objects can exist in any of 32 different layers. These layers are not visual, but more of a tagging system instead. A collidable can use these layers/tags to select with which objects it can collide, using [method set_collision_mask]. + A contact is detected if object A is in any of the layers that object B scans, or object B is in any layer scanned by object A. </description> </method> <method name="get_layer_mask" qualifiers="const"> <return type="int"> </return> <description> + Return the physics layer this area is in. </description> </method> <method name="set_collision_mask"> <argument index="0" name="mask" type="int"> </argument> <description> + Set the physics layers this area can scan for collisions. </description> </method> <method name="get_collision_mask" qualifiers="const"> <return type="int"> </return> <description> + Return the physics layers this area can scan for collisions. </description> </method> <method name="set_collision_mask_bit"> @@ -23377,6 +23766,7 @@ This method controls whether the position between two cached points is interpola <argument index="1" name="value" type="bool"> </argument> <description> + Set/clear individual bits on the collision mask. This makes selecting the areas scanned easier. </description> </method> <method name="get_collision_mask_bit" qualifiers="const"> @@ -23385,6 +23775,7 @@ This method controls whether the position between two cached points is interpola <argument index="0" name="bit" type="int"> </argument> <description> + Return an individual bit on the collision mask. </description> </method> <method name="set_layer_mask_bit"> @@ -23393,6 +23784,7 @@ This method controls whether the position between two cached points is interpola <argument index="1" name="value" type="bool"> </argument> <description> + Set/clear individual bits on the layer mask. This makes getting a body in/out of only one layer easier. </description> </method> <method name="get_layer_mask_bit" qualifiers="const"> @@ -23401,42 +23793,49 @@ This method controls whether the position between two cached points is interpola <argument index="0" name="bit" type="int"> </argument> <description> + Return an individual bit on the collision mask. </description> </method> <method name="set_one_way_collision_direction"> <argument index="0" name="dir" type="Vector2"> </argument> <description> + Set a direction in which bodies can go through this one. If this value is different from (0,0), any movement within 90 degrees of this vector is considered a valid movement. Set this direction to (0,0) to disable one-way collisions. </description> </method> <method name="get_one_way_collision_direction" qualifiers="const"> <return type="Vector2"> </return> <description> + Return the direction used for one-way collision detection. </description> </method> <method name="set_one_way_collision_max_depth"> <argument index="0" name="depth" type="float"> </argument> <description> + Set how far a body can go through this one, when it allows one-way collisions (see [method set_one_way_collision_detection]). </description> </method> <method name="get_one_way_collision_max_depth" qualifiers="const"> <return type="float"> </return> <description> + Return how far a body can go through this one, when it allows one-way collisions. </description> </method> <method name="add_collision_exception_with"> <argument index="0" name="body" type="PhysicsBody2D"> </argument> <description> + Adds a body to the collision exception list. This list contains bodies that this body will not collide with. </description> </method> <method name="remove_collision_exception_with"> <argument index="0" name="body" type="PhysicsBody2D"> </argument> <description> + Removes a body from the collision exception list. </description> </method> </methods> @@ -23974,11 +24373,11 @@ This method controls whether the position between two cached points is interpola </description> </method> <method name="area_set_monitor_callback"> - <argument index="0" name="receiver" type="RID"> + <argument index="0" name="area" type="RID"> </argument> - <argument index="1" name="method" type="Object"> + <argument index="1" name="receiver" type="Object"> </argument> - <argument index="2" name="arg2" type="String"> + <argument index="2" name="method" type="String"> </argument> <description> </description> @@ -24038,8 +24437,6 @@ This method controls whether the position between two cached points is interpola </return> <argument index="0" name="body" type="RID"> </argument> - <argument index="1" name="arg1" type="int"> - </argument> <description> </description> </method> @@ -24584,7 +24981,7 @@ This method controls whether the position between two cached points is interpola <method name="get_process_info"> <return type="int"> </return> - <argument index="0" name="arg0" type="int"> + <argument index="0" name="process_info" type="int"> </argument> <description> </description> @@ -24751,11 +25148,20 @@ This method controls whether the position between two cached points is interpola </constant> <constant name="AREA_PARAM_PRIORITY" value="7"> </constant> + <constant name="AREA_SPACE_OVERRIDE_DISABLED" value="0"> + This area does not affect gravity/damp. These are generally areas that exist only to detect collisions, and objects entering or exiting them. + </constant> <constant name="AREA_SPACE_OVERRIDE_COMBINE" value="1"> + This area adds its gravity/damp values to whatever has been calculated so far. This way, many overlapping areas can combine their physics to make interesting effects. </constant> - <constant name="AREA_SPACE_OVERRIDE_DISABLED" value="0"> + <constant name="AREA_SPACE_OVERRIDE_COMBINE_REPLACE" value="2"> + This area adds its gravity/damp values to whatever has been calculated so far. Then stops taking into account the rest of the areas, even the default one. + </constant> + <constant name="AREA_SPACE_OVERRIDE_REPLACE" value="3"> + This area replaces any gravity/damp, even the default one, and stops taking into account the rest of the areas. </constant> - <constant name="AREA_SPACE_OVERRIDE_REPLACE" value="2"> + <constant name="AREA_SPACE_OVERRIDE_REPLACE_COMBINE" value="4"> + This area replaces any gravity/damp calculated so far, but keeps calculating the rest of the areas, down to the default one. </constant> <constant name="BODY_MODE_STATIC" value="0"> </constant> @@ -25566,7 +25972,7 @@ This method controls whether the position between two cached points is interpola <method name="set_item_checked"> <argument index="0" name="idx" type="int"> </argument> - <argument index="1" name="arg1" type="bool"> + <argument index="1" name="checked" type="bool"> </argument> <description> Set the checkstate status of the item at index "idx". @@ -26254,12 +26660,6 @@ This method controls whether the position between two cached points is interpola Return value mapped to 0 to 1 (unit) range. </description> </method> - <method name="get_rounded_values" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> <method name="set_val"> <argument index="0" name="value" type="float"> </argument> @@ -26307,11 +26707,17 @@ This method controls whether the position between two cached points is interpola </description> </method> <method name="set_rounded_values"> - <argument index="0" name="arg0" type="bool"> + <argument index="0" name="enabled" type="bool"> </argument> <description> </description> </method> + <method name="is_rounded_values" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> <method name="set_exp_unit_value"> <argument index="0" name="enabled" type="bool"> </argument> @@ -26372,14 +26778,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). + 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. + 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"> @@ -26734,8 +27140,10 @@ This method controls whether the position between two cached points is interpola </class> <class name="Rect2" category="Built-In Types"> <brief_description> + 2D Axis-aligned bounding box. </brief_description> <description> + Rect2 provides an 2D Axis-Aligned Bounding Box. It consists of a position, a size, and several utility functions. It is typically used for fast overlap tests. </description> <methods> <method name="clip"> @@ -26744,6 +27152,7 @@ This method controls whether the position between two cached points is interpola <argument index="0" name="b" type="Rect2"> </argument> <description> + Returns the intersection of this [Rect2] and b. </description> </method> <method name="encloses"> @@ -26752,6 +27161,7 @@ This method controls whether the position between two cached points is interpola <argument index="0" name="b" type="Rect2"> </argument> <description> + Returns true if this [Rect2] completely encloses another one. </description> </method> <method name="expand"> @@ -26760,12 +27170,14 @@ This method controls whether the position between two cached points is interpola <argument index="0" name="to" type="Vector2"> </argument> <description> + Return this [Rect2] expanded to include a given point. </description> </method> <method name="get_area"> <return type="float"> </return> <description> + Get the area of the [Rect2]. </description> </method> <method name="grow"> @@ -26774,12 +27186,14 @@ This method controls whether the position between two cached points is interpola <argument index="0" name="by" type="float"> </argument> <description> + Return a copy of the [Rect2] grown a given amount of units towards all the sides. </description> </method> <method name="has_no_area"> <return type="bool"> </return> <description> + Return true if the [Rect2] is flat or empty. </description> </method> <method name="has_point"> @@ -26788,6 +27202,7 @@ This method controls whether the position between two cached points is interpola <argument index="0" name="point" type="Vector2"> </argument> <description> + Return true if the [Rect2] contains a point. </description> </method> <method name="intersects"> @@ -26796,6 +27211,7 @@ This method controls whether the position between two cached points is interpola <argument index="0" name="b" type="Rect2"> </argument> <description> + Return true if the [Rect2] overlaps with another. </description> </method> <method name="merge"> @@ -26804,6 +27220,7 @@ This method controls whether the position between two cached points is interpola <argument index="0" name="b" type="Rect2"> </argument> <description> + Combine this [Rect2] with another, a larger one is returned that contains both. </description> </method> <method name="Rect2"> @@ -26814,6 +27231,7 @@ This method controls whether the position between two cached points is interpola <argument index="1" name="size" type="Vector2"> </argument> <description> + Construct a [Rect2] by position and size. </description> </method> <method name="Rect2"> @@ -26828,6 +27246,7 @@ This method controls whether the position between two cached points is interpola <argument index="3" name="height" type="float"> </argument> <description> + Construct a [Rect2] by x, y, width and height. </description> </method> </methods> @@ -26932,7 +27351,7 @@ This method controls whether the position between two cached points is interpola Lazy (non-greedy) quantifiers [code]*?[/code] Begining [code]^[/code] and end [code]$[/code] anchors Alternation [code]|[/code] - Backreferences [code]\1[/code] to [code]\9[/code] + Backreferences [code]\1[/code] and [code]\g{1}[/code] POSIX character classes [code][[:alnum:]][/code] Lookahead [code](?=)[/code], [code](?!)[/code] and lookbehind [code](?<=)[/code], [code](?<!)[/code] ASCII [code]\xFF[/code] and Unicode [code]\uFFFF[/code] code points (in a style similar to Python) @@ -26944,9 +27363,10 @@ This method controls whether the position between two cached points is interpola </return> <argument index="0" name="pattern" type="String"> </argument> - <argument index="1" name="expanded" type="bool" default="true"> + <argument index="1" name="capture" type="int" default="9"> </argument> <description> + Compiles and assign the regular expression pattern to use. The limit on the number of capturing groups can be specified or made unlimited if negative. </description> </method> <method name="find" qualifiers="const"> @@ -27097,7 +27517,7 @@ This method controls whether the position between two cached points is interpola <method name="duplicate"> <return type="Object"> </return> - <argument index="0" name="arg0" type="bool" default="false"> + <argument index="0" name="subresources" type="bool" default="false"> </argument> <description> </description> @@ -27286,7 +27706,7 @@ This method controls whether the position between two cached points is interpola <method name="get_dependencies"> <return type="StringArray"> </return> - <argument index="0" name="arg0" type="String"> + <argument index="0" name="path" type="String"> </argument> <description> </description> @@ -27294,7 +27714,7 @@ This method controls whether the position between two cached points is interpola <method name="has"> <return type="bool"> </return> - <argument index="0" name="arg0" type="String"> + <argument index="0" name="path" type="String"> </argument> <description> </description> @@ -27380,7 +27800,7 @@ This method controls whether the position between two cached points is interpola </argument> <argument index="1" name="resource" type="Resource"> </argument> - <argument index="2" name="arg2" type="int" default="0"> + <argument index="2" name="flags" type="int" default="0"> </argument> <description> Save a resource to disk, to a given path. @@ -27475,6 +27895,26 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> + <method name="push_table"> + <argument index="0" name="columns" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_table_column_expand"> + <argument index="0" name="column" type="int"> + </argument> + <argument index="1" name="expand" type="bool"> + </argument> + <argument index="2" name="ratio" type="int"> + </argument> + <description> + </description> + </method> + <method name="push_cell"> + <description> + </description> + </method> <method name="pop"> <description> </description> @@ -27525,6 +27965,12 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> + <method name="scroll_to_line"> + <argument index="0" name="line" type="int"> + </argument> + <description> + </description> + </method> <method name="set_tab_size"> <argument index="0" name="spaces" type="int"> </argument> @@ -27633,7 +28079,7 @@ This method controls whether the position between two cached points is interpola </constant> <constant name="LIST_DOTS" value="2"> </constant> - <constant name="ITEM_MAIN" value="0"> + <constant name="ITEM_FRAME" value="0"> </constant> <constant name="ITEM_TEXT" value="1"> </constant> @@ -27653,10 +28099,14 @@ This method controls whether the position between two cached points is interpola </constant> <constant name="ITEM_LIST" value="9"> </constant> - <constant name="ITEM_META" value="10"> + <constant name="ITEM_META" value="11"> </constant> </constants> <theme_items> + <theme_item name="table_vseparation" type="int"> + </theme_item> + <theme_item name="table_hseparation" type="int"> + </theme_item> <theme_item name="line_separation" type="int"> </theme_item> <theme_item name="default_color" type="Color"> @@ -27970,7 +28420,7 @@ This method controls whether the position between two cached points is interpola Rigid body 2D node. </brief_description> <description> - Rigid body 2D node. This node is used for placing rigid bodies in the scene. It can contain a number of shapes, and also shift state between regular Rigid Body to Character or even Static. + Rigid body 2D node. This node is used for placing rigid bodies in the scene. It can contain a number of shapes, and also shift state between regular Rigid body, Kinematic, Character or Static. Character mode forbids the node from being rotated. This node can have a custom force integrator function, for writing complex physics motion behavior per node. As a warning, don't change this node position every frame or very often. Sporadic changes work fine, but physics runs at a different granularity (fixed hz) than usual rendering (process callback) and maybe even in a separate thread, so changing this from a process loop will yield strange behavior. </description> @@ -27993,7 +28443,7 @@ This method controls whether the position between two cached points is interpola <return type="int"> </return> <description> - Return the current body mode, see [set_mode]. + Return the current body mode, see [method set_mode]. </description> </method> <method name="set_mass"> @@ -28014,14 +28464,14 @@ This method controls whether the position between two cached points is interpola <argument index="0" name="weight" type="float"> </argument> <description> - Set the body mass given standard earth-weight (gravity 9.8). Not really useful for 2D since most measures for this node are in pixels. + Set the body weight given standard earth-weight (gravity 9.8). Not really useful for 2D since most measures for this node are in pixels. </description> </method> <method name="get_weight" qualifiers="const"> <return type="float"> </return> <description> - Return the body mass given standard earth-weight (gravity 9.8). + Return the body weight given standard earth-weight (gravity 9.8). </description> </method> <method name="set_friction"> @@ -28042,7 +28492,7 @@ This method controls whether the position between two cached points is interpola <argument index="0" name="bounce" type="float"> </argument> <description> - Set the body bounciness, from 0 (no bounce) to 1 (bounce). + Set the body bounciness, from 0 (no bounce) to 1 (full bounce). </description> </method> <method name="get_bounce" qualifiers="const"> @@ -28056,36 +28506,42 @@ This method controls whether the position between two cached points is interpola <argument index="0" name="gravity_scale" type="float"> </argument> <description> + Set The gravity factor. This factor multiplies gravity intensity just for this body. </description> </method> <method name="get_gravity_scale" qualifiers="const"> <return type="float"> </return> <description> + Return the gravity factor. </description> </method> <method name="set_linear_damp"> <argument index="0" name="linear_damp" type="float"> </argument> <description> + Set the linear damp for this body. If this value is different from -1, any linear damp derived from the world or areas will be overriden. </description> </method> <method name="get_linear_damp" qualifiers="const"> <return type="float"> </return> <description> + Return the linear damp for this body. </description> </method> <method name="set_angular_damp"> <argument index="0" name="angular_damp" type="float"> </argument> <description> + Set the angular damp for this body. If this value is different from -1, any angular damp derived from the world or areas will be overriden. </description> </method> <method name="get_angular_damp" qualifiers="const"> <return type="float"> </return> <description> + Return the angular damp for this body. </description> </method> <method name="set_linear_velocity"> @@ -28099,7 +28555,7 @@ This method controls whether the position between two cached points is interpola <return type="Vector2"> </return> <description> - Return the body linear velocity. This changes by physics granularity. See [set_linear_velocity]. + Return the body linear velocity. This changes by physics granularity. See [method set_linear_velocity]. </description> </method> <method name="set_angular_velocity"> @@ -28113,7 +28569,7 @@ This method controls whether the position between two cached points is interpola <return type="float"> </return> <description> - Return the body angular velocity. This changes by physics granularity. See [set_angular_velocity]. + Return the body angular velocity. This changes by physics granularity. See [method set_angular_velocity]. </description> </method> <method name="set_max_contacts_reported"> @@ -28127,14 +28583,14 @@ This method controls whether the position between two cached points is interpola <return type="int"> </return> <description> - Return the maximum contacts that can be reported. See [set_max_contacts_reported]. + Return the maximum contacts that can be reported. See [method set_max_contacts_reported]. </description> </method> <method name="set_use_custom_integrator"> <argument index="0" name="enable" type="bool"> </argument> <description> - Set to true if the body shall not do any internal force integration at all (like gravity or air friction). Only the [_integrate_forces] will be able to integrate them if overrided. + Set to true if the body shall not do any internal force integration at all (like gravity or air friction). Only the [method _integrate_forces] will be able to integrate them if overrided. </description> </method> <method name="is_using_custom_integrator"> @@ -28148,7 +28604,7 @@ This method controls whether the position between two cached points is interpola <argument index="0" name="enabled" type="bool"> </argument> <description> - Enable contact monitoring. (the signals to notify when a body entered/exited collision). + Enable contact monitoring. This allows the body to emit signals when it collides with another. </description> </method> <method name="is_contact_monitor_enabled" qualifiers="const"> @@ -28162,19 +28618,22 @@ This method controls whether the position between two cached points is interpola <argument index="0" name="mode" type="int"> </argument> <description> + Set the continuous collision detection mode from the enum CCD_MODE_*. + Coninuous collision detection tries to predict where a moving body will collide, instead of moving it and correcting its movement if it collided. The first is more precise, and misses less impacts by small, fast-moving objects. The second is faster to compute, but can miss small, fat-moving objects. </description> </method> <method name="get_continuous_collision_detection_mode" qualifiers="const"> <return type="int"> </return> <description> + Return whether this body is using continuous collision detection. </description> </method> <method name="set_axis_velocity"> <argument index="0" name="axis_velocity" type="Vector2"> </argument> <description> - Set an axis velocity. The velocity in the given vector axis will be set as the given vector length. (This is useful for jumping behavior). + Set an axis velocity. The velocity in the given vector axis will be set as the given vector length. This is useful for jumping behavior. </description> </method> <method name="apply_impulse"> @@ -28183,31 +28642,35 @@ This method controls whether the position between two cached points is interpola <argument index="1" name="impulse" type="Vector2"> </argument> <description> - Apply a positioned impulse (which will be affected by the body mass and shape). + Apply a positioned impulse (which will be affected by the body mass and shape). This is the equivalent of hitting a billiard ball with a cue: a force that is applied once, and only once. </description> </method> <method name="set_applied_force"> <argument index="0" name="force" type="Vector2"> </argument> <description> + Set the applied force vector. This is the equivalent of pushing a box over the ground: the force applied is applied constantly. </description> </method> <method name="get_applied_force" qualifiers="const"> <return type="Vector2"> </return> <description> + Return the applied force vector. </description> </method> <method name="set_sleeping"> <argument index="0" name="sleeping" type="bool"> </argument> <description> + Set whether a body is isleeping or not. Sleeping bodies are not affected by forces until a collision or an [method apply_impulse]/[method set_applied_force] wakes them up. Until then, they behave like a static body. </description> </method> <method name="is_sleeping" qualifiers="const"> <return type="bool"> </return> <description> + Return whether the body is sleeping. </description> </method> <method name="set_can_sleep"> @@ -28215,13 +28678,14 @@ This method controls whether the position between two cached points is interpola </argument> <description> Set the body ability to fall asleep when not moving. This saves an enormous amount of processor time when there are plenty of rigid bodies (non static) in a scene. + Sleeping bodies are not affected by forces until a collision or an [method apply_impulse]/[method set_applied_force] wakes them up. Until then, they behave like a static body. </description> </method> <method name="is_able_to_sleep" qualifiers="const"> <return type="bool"> </return> <description> - Return true if the body has the ability to fall asleep when not moving. See [set_can_sleep]. + Return true if the body has the ability to fall asleep when not moving. See [method set_can_sleep]. </description> </method> <method name="test_motion"> @@ -28234,12 +28698,14 @@ This method controls whether the position between two cached points is interpola <argument index="2" name="result" type="Physics2DTestMotionResult" default="NULL"> </argument> <description> + Return whether the body would collide, if it tried to move in the given vector. This method allows two extra parameters: A margin, which increases slightly the size of the shapes involved in the collision detection, and an object of type [Physics2DTestMotionResult], which will store additional information about the collision (should there be one). </description> </method> <method name="get_colliding_bodies" qualifiers="const"> <return type="Array"> </return> <description> + Return a list of the bodies colliding with this one. </description> </method> </methods> @@ -28248,7 +28714,7 @@ This method controls whether the position between two cached points is interpola <argument index="0" name="body" type="Object"> </argument> <description> - Emitted when a new body enters into contact with this one. Contact monitor and contacts reported must be enabled for this to work. + Emitted when a body enters into contact with this one. Contact monitor and contacts reported must be enabled for this to work. </description> </signal> <signal name="body_enter_shape"> @@ -28261,7 +28727,8 @@ This method controls whether the position between two cached points is interpola <argument index="3" name="local_shape" type="int"> </argument> <description> - Emitted when a new body sub-shape enters into contact with this one. Contact monitor and contacts reported must be enabled for this to work. + Emitted when a body enters into contact with this one. Contact monitor and contacts reported must be enabled for this to work. + This signal not only receives the body that collided with this one, but also its [RID] (body_id), the shape index from the colliding body (body_shape), and the shape index from this body (local_shape) the other body collided with. </description> </signal> <signal name="body_exit"> @@ -28282,26 +28749,31 @@ This method controls whether the position between two cached points is interpola </argument> <description> Emitted when a body shape exits contact with this one. Contact monitor and contacts reported must be enabled for this to work. + This signal not only receives the body that stopped colliding with this one, but also its [RID] (body_id), the shape index from the colliding body (body_shape), and the shape index from this body (local_shape) the other body stopped colliding with. </description> </signal> </signals> <constants> <constant name="MODE_STATIC" value="1"> - Static mode (does not move, can't be moved). + Static mode. The body behaves like a [StaticBody2D], and can only move by user code. </constant> <constant name="MODE_KINEMATIC" value="3"> + Kinematic body. The body behaves like a [KinematicBody2D], and can only move by user code. </constant> <constant name="MODE_RIGID" value="0"> - Rigid body, can move and rotate. + Rigid body. This is the "natural" state of a rigid body. It is affected by forces, and can move, rotate, and be affected by user code. </constant> <constant name="MODE_CHARACTER" value="2"> - Character body, can move but not rotate. + Character body. This behaves like a rigid body, but can not rotate. </constant> <constant name="CCD_MODE_DISABLED" value="0"> + Disables continuous collision detection. This is the fastest way to detect body collisions, but can miss small, fast-moving objects. </constant> <constant name="CCD_MODE_CAST_RAY" value="1"> + Enables continuous collision detection by raycasting. It is faster than shapecasting, but less precise. </constant> <constant name="CCD_MODE_CAST_SHAPE" value="2"> + Enables continuous collision detection by shapecasting. It is the slowest CCD method, and the most precise. </constant> </constants> </class> @@ -29242,7 +29714,7 @@ This method controls whether the position between two cached points is interpola <method name="get_nodes_in_group"> <return type="Array"> </return> - <argument index="0" name="arg0" type="String"> + <argument index="0" name="group" type="String"> </argument> <description> </description> @@ -29253,6 +29725,14 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> + <method name="has_group" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + </description> + </method> <method name="set_auto_accept_quit"> <argument index="0" name="enabled" type="bool"> </argument> @@ -29847,13 +30327,13 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="scalar_const_node_get_value"> + <method name="scalar_const_node_get_value" qualifiers="const"> + <return type="float"> + </return> <argument index="0" name="shader_type" type="int"> </argument> <argument index="1" name="id" type="int"> </argument> - <argument index="2" name="arg2" type="float"> - </argument> <description> </description> </method> @@ -29867,13 +30347,13 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="vec_const_node_get_value"> + <method name="vec_const_node_get_value" qualifiers="const"> + <return type="Vector3"> + </return> <argument index="0" name="shader_type" type="int"> </argument> <argument index="1" name="id" type="int"> </argument> - <argument index="2" name="arg2" type="Vector3"> - </argument> <description> </description> </method> @@ -29887,13 +30367,13 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="rgb_const_node_get_value"> + <method name="rgb_const_node_get_value" qualifiers="const"> + <return type="Color"> + </return> <argument index="0" name="shader_type" type="int"> </argument> <argument index="1" name="id" type="int"> </argument> - <argument index="2" name="arg2" type="Color"> - </argument> <description> </description> </method> @@ -29907,13 +30387,13 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="xform_const_node_get_value"> + <method name="xform_const_node_get_value" qualifiers="const"> + <return type="Transform"> + </return> <argument index="0" name="shader_type" type="int"> </argument> <argument index="1" name="id" type="int"> </argument> - <argument index="2" name="arg2" type="Transform"> - </argument> <description> </description> </method> @@ -29927,13 +30407,13 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="texture_node_get_filter_size"> + <method name="texture_node_get_filter_size" qualifiers="const"> + <return type="int"> + </return> <argument index="0" name="shader_type" type="int"> </argument> <argument index="1" name="id" type="int"> </argument> - <argument index="2" name="arg2" type="int"> - </argument> <description> </description> </method> @@ -29947,13 +30427,13 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="texture_node_get_filter_strength"> + <method name="texture_node_get_filter_strength" qualifiers="const"> + <return type="float"> + </return> <argument index="0" name="shader_type" type="int"> </argument> <argument index="1" name="id" type="float"> </argument> - <argument index="2" name="arg2" type="float"> - </argument> <description> </description> </method> @@ -30380,6 +30860,8 @@ This method controls whether the position between two cached points is interpola </description> </method> <method name="node_get_state" qualifiers="const"> + <return type="Variant"> + </return> <argument index="0" name="shader_type" type="int"> </argument> <argument index="1" name="id" type="int"> @@ -30642,12 +31124,14 @@ This method controls whether the position between two cached points is interpola <method name="set_shader_param"> <argument index="0" name="param" type="String"> </argument> - <argument index="1" name="value" type="var"> + <argument index="1" name="value" type="Variant"> </argument> <description> </description> </method> <method name="get_shader_param" qualifiers="const"> + <return type="Variant"> + </return> <argument index="0" name="param" type="String"> </argument> <description> @@ -30723,6 +31207,8 @@ This method controls whether the position between two cached points is interpola </description> </method> <method name="collide_and_get_contacts"> + <return type="Variant"> + </return> <argument index="0" name="local_xform" type="Matrix32"> </argument> <argument index="1" name="with_shape" type="Shape2D"> @@ -30735,6 +31221,8 @@ This method controls whether the position between two cached points is interpola </description> </method> <method name="collide_with_motion_and_get_contacts"> + <return type="Variant"> + </return> <argument index="0" name="local_xform" type="Matrix32"> </argument> <argument index="1" name="local_motion" type="Vector2"> @@ -31289,6 +31777,12 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> + <method name="set_hidden"> + <argument index="0" name="hidden" type="bool"> + </argument> + <description> + </description> + </method> <method name="set_notify_local_transform"> <argument index="0" name="enable" type="bool"> </argument> @@ -31577,7 +32071,7 @@ This method controls whether the position between two cached points is interpola </description> </method> <method name="play"> - <argument index="0" name="arg0" type="float" default="0"> + <argument index="0" name="offset" type="float" default="0"> </argument> <description> </description> @@ -32410,7 +32904,7 @@ This method controls whether the position between two cached points is interpola <argument index="0" name="vel" type="Vector2"> </argument> <description> - Set a constant linear velocity for the body. + Set a constant linear velocity for the body. This does not move the body, but affects other bodies touching it, as if it was moving. </description> </method> <method name="set_constant_angular_velocity"> @@ -32424,7 +32918,7 @@ This method controls whether the position between two cached points is interpola <return type="Vector2"> </return> <description> - Return the constant linear velocity for the body. + Return the constant linear velocity for the body. This does not rotate the body, but affects other bodies touching it, as if it was rotating. </description> </method> <method name="get_constant_angular_velocity" qualifiers="const"> @@ -32438,24 +32932,28 @@ This method controls whether the position between two cached points is interpola <argument index="0" name="friction" type="float"> </argument> <description> + Set the body friction, from 0 (frictionless) to 1 (full friction). </description> </method> <method name="get_friction" qualifiers="const"> <return type="float"> </return> <description> + Return the body friction. </description> </method> <method name="set_bounce"> <argument index="0" name="bounce" type="float"> </argument> <description> + Set the body bounciness, from 0 (not bouncy) to 1 (bouncy). </description> </method> <method name="get_bounce" qualifiers="const"> <return type="float"> </return> <description> + Return the body bounciness. </description> </method> </methods> @@ -32506,6 +33004,178 @@ This method controls whether the position between two cached points is interpola Return a chunk data with the received bytes. The amount of bytes to be received can be requested in the "bytes" argument. If not enough bytes are available, the function will return how many were actually received. This function returns two values, an [Error] code, and a data array. </description> </method> + <method name="get_available_bytes" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="set_big_endian"> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + </description> + </method> + <method name="is_big_endian_enabled" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="put_8"> + <argument index="0" name="val" type="int"> + </argument> + <description> + </description> + </method> + <method name="put_u8"> + <argument index="0" name="val" type="int"> + </argument> + <description> + </description> + </method> + <method name="put_16"> + <argument index="0" name="val" type="int"> + </argument> + <description> + </description> + </method> + <method name="put_u16"> + <argument index="0" name="val" type="int"> + </argument> + <description> + </description> + </method> + <method name="put_32"> + <argument index="0" name="val" type="int"> + </argument> + <description> + </description> + </method> + <method name="put_u32"> + <argument index="0" name="val" type="int"> + </argument> + <description> + </description> + </method> + <method name="put_64"> + <argument index="0" name="val" type="int"> + </argument> + <description> + </description> + </method> + <method name="put_u64"> + <argument index="0" name="val" type="int"> + </argument> + <description> + </description> + </method> + <method name="put_float"> + <argument index="0" name="val" type="float"> + </argument> + <description> + </description> + </method> + <method name="put_double"> + <argument index="0" name="val" type="float"> + </argument> + <description> + </description> + </method> + <method name="put_utf8_string"> + <argument index="0" name="val" type="String"> + </argument> + <description> + </description> + </method> + <method name="put_var"> + <argument index="0" name="val" type="Variant"> + </argument> + <description> + </description> + </method> + <method name="get_8"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_u8"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_16"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_u16"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_32"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_u32"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_64"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_u64"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_float"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_double"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_string"> + <return type="String"> + </return> + <argument index="0" name="bytes" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_utf8_string"> + <return type="String"> + </return> + <argument index="0" name="bytes" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_var"> + <return type="Variant"> + </return> + <description> + </description> + </method> </methods> <constants> </constants> @@ -32637,7 +33307,7 @@ This method controls whether the position between two cached points is interpola </description> </method> <method name="play"> - <argument index="0" name="arg0" type="float" default="0"> + <argument index="0" name="offset" type="float" default="0"> </argument> <description> </description> @@ -32767,6 +33437,12 @@ This method controls whether the position between two cached points is interpola </description> </method> </methods> + <signals> + <signal name="finished"> + <description> + </description> + </signal> + </signals> <constants> </constants> </class> @@ -33139,7 +33815,7 @@ This method controls whether the position between two cached points is interpola <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. + 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"> @@ -33174,7 +33850,7 @@ This method controls whether the position between two cached points is interpola <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(). + 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"> @@ -33316,9 +33992,9 @@ This method controls whether the position between two cached points is interpola </description> </method> <method name="draw" qualifiers="const"> - <argument index="0" name="arg0" type="RID"> + <argument index="0" name="canvas_item" type="RID"> </argument> - <argument index="1" name="arg1" type="Rect2"> + <argument index="1" name="rect" type="Rect2"> </argument> <description> </description> @@ -33471,7 +34147,7 @@ This method controls whether the position between two cached points is interpola <method name="get_expand_margin_size" qualifiers="const"> <return type="float"> </return> - <argument index="0" name="arg0" type="int"> + <argument index="0" name="margin" type="int"> </argument> <description> Return the expand margin size (from enum MARGIN_*). Parts of the image below the size of the margin (and in the direction of the margin) will not expand. @@ -33512,7 +34188,7 @@ This method controls whether the position between two cached points is interpola <method name="get_margin_size" qualifiers="const"> <return type="float"> </return> - <argument index="0" name="arg0" type="int"> + <argument index="0" name="margin" type="int"> </argument> <description> </description> @@ -33528,7 +34204,7 @@ This method controls whether the position between two cached points is interpola <method name="get_expand_margin_size" qualifiers="const"> <return type="float"> </return> - <argument index="0" name="arg0" type="int"> + <argument index="0" name="margin" type="int"> </argument> <description> </description> @@ -33999,6 +34675,14 @@ This method controls whether the position between two cached points is interpola </theme_item> <theme_item name="font_color_fg" type="Color"> </theme_item> + <theme_item name="increment_hilite" type="Texture"> + </theme_item> + <theme_item name="decrement_hilite" type="Texture"> + </theme_item> + <theme_item name="increment" type="Texture"> + </theme_item> + <theme_item name="decrement" type="Texture"> + </theme_item> <theme_item name="font" type="Font"> </theme_item> <theme_item name="tab_fg" type="StyleBox"> @@ -34062,7 +34746,7 @@ This method controls whether the position between two cached points is interpola <method name="get_line" qualifiers="const"> <return type="String"> </return> - <argument index="0" name="arg0" type="int"> + <argument index="0" name="line" type="int"> </argument> <description> Return the text of a specific line. @@ -34071,7 +34755,7 @@ This method controls whether the position between two cached points is interpola <method name="cursor_set_column"> <argument index="0" name="column" type="int"> </argument> - <argument index="1" name="arg1" type="bool"> + <argument index="1" name="adjust_viewport" type="bool" default="false"> </argument> <description> </description> @@ -34079,7 +34763,7 @@ This method controls whether the position between two cached points is interpola <method name="cursor_set_line"> <argument index="0" name="line" type="int"> </argument> - <argument index="1" name="arg1" type="bool"> + <argument index="1" name="adjust_viewport" type="bool" default="false"> </argument> <description> </description> @@ -34421,7 +35105,7 @@ This method controls whether the position between two cached points is interpola </argument> <argument index="2" name="modulate" type="Color" default="Color(1,1,1,1)"> </argument> - <argument index="3" name="arg3" type="bool" default="false"> + <argument index="3" name="transpose" type="bool" default="false"> </argument> <description> </description> @@ -34435,7 +35119,7 @@ This method controls whether the position between two cached points is interpola </argument> <argument index="3" name="modulate" type="Color" default="Color(1,1,1,1)"> </argument> - <argument index="4" name="arg4" type="bool" default="false"> + <argument index="4" name="transpose" type="bool" default="false"> </argument> <description> </description> @@ -34449,7 +35133,7 @@ This method controls whether the position between two cached points is interpola </argument> <argument index="3" name="modulate" type="Color" default="Color(1,1,1,1)"> </argument> - <argument index="4" name="arg4" type="bool" default="false"> + <argument index="4" name="transpose" type="bool" default="false"> </argument> <description> </description> @@ -34524,7 +35208,7 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="set_scale"> + <method name="set_texture_scale"> <argument index="0" name="scale" type="Vector2"> </argument> <description> @@ -34572,7 +35256,7 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="get_scale" qualifiers="const"> + <method name="get_texture_scale" qualifiers="const"> <return type="Vector2"> </return> <description> @@ -34794,7 +35478,7 @@ This method controls whether the position between two cached points is interpola <method name="get_icon_list" qualifiers="const"> <return type="StringArray"> </return> - <argument index="0" name="arg0" type="String"> + <argument index="0" name="type" type="String"> </argument> <description> </description> @@ -34840,7 +35524,7 @@ This method controls whether the position between two cached points is interpola <method name="get_stylebox_list" qualifiers="const"> <return type="StringArray"> </return> - <argument index="0" name="arg0" type="String"> + <argument index="0" name="type" type="String"> </argument> <description> </description> @@ -34886,7 +35570,7 @@ This method controls whether the position between two cached points is interpola <method name="get_font_list" qualifiers="const"> <return type="StringArray"> </return> - <argument index="0" name="arg0" type="String"> + <argument index="0" name="type" type="String"> </argument> <description> </description> @@ -34932,7 +35616,7 @@ This method controls whether the position between two cached points is interpola <method name="get_color_list" qualifiers="const"> <return type="StringArray"> </return> - <argument index="0" name="arg0" type="String"> + <argument index="0" name="type" type="String"> </argument> <description> </description> @@ -34978,7 +35662,7 @@ This method controls whether the position between two cached points is interpola <method name="get_constant_list" qualifiers="const"> <return type="StringArray"> </return> - <argument index="0" name="arg0" type="String"> + <argument index="0" name="type" type="String"> </argument> <description> </description> @@ -34998,7 +35682,7 @@ This method controls whether the position between two cached points is interpola <method name="get_type_list" qualifiers="const"> <return type="StringArray"> </return> - <argument index="0" name="arg0" type="String"> + <argument index="0" name="type" type="String"> </argument> <description> </description> @@ -35044,6 +35728,16 @@ This method controls whether the position between two cached points is interpola </description> </method> <method name="wait_to_finish"> + <return type="Variant"> + </return> + <description> + </description> + </method> + <method name="set_name"> + <return type="Error"> + </return> + <argument index="0" name="name" type="String"> + </argument> <description> </description> </method> @@ -35283,6 +35977,18 @@ This method controls whether the position between two cached points is interpola Return the collision bounce parameter. </description> </method> + <method name="set_occluder_light_mask"> + <argument index="0" name="mask" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_occluder_light_mask" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> <method name="set_cell"> <argument index="0" name="x" type="int"> </argument> @@ -36148,19 +36854,19 @@ This method controls whether the position between two cached points is interpola <method name="translate" qualifiers="const"> <return type="String"> </return> - <argument index="0" name="arg0" type="String"> + <argument index="0" name="message" type="String"> </argument> <description> </description> </method> <method name="add_translation"> - <argument index="0" name="arg0" type="Object"> + <argument index="0" name="translation" type="Translation"> </argument> <description> </description> </method> <method name="remove_translation"> - <argument index="0" name="arg0" type="Object"> + <argument index="0" name="translation" type="Translation"> </argument> <description> </description> @@ -36198,17 +36904,17 @@ This method controls whether the position between two cached points is interpola </description> </method> <method name="set_column_min_width"> - <argument index="0" name="arg0" type="int"> + <argument index="0" name="column" type="int"> </argument> - <argument index="1" name="arg1" type="int"> + <argument index="1" name="min_width" type="int"> </argument> <description> </description> </method> <method name="set_column_expand"> - <argument index="0" name="arg0" type="int"> + <argument index="0" name="column" type="int"> </argument> - <argument index="1" name="arg1" type="bool"> + <argument index="1" name="expand" type="bool"> </argument> <description> </description> @@ -36216,13 +36922,13 @@ This method controls whether the position between two cached points is interpola <method name="get_column_width" qualifiers="const"> <return type="int"> </return> - <argument index="0" name="arg0" type="int"> + <argument index="0" name="column" type="int"> </argument> <description> </description> </method> <method name="set_hide_root"> - <argument index="0" name="arg0" type="bool"> + <argument index="0" name="enable" type="bool"> </argument> <description> </description> @@ -36682,6 +37388,8 @@ This method controls whether the position between two cached points is interpola </description> </method> <method name="remove_child"> + <return type="TreeItem"> + </return> <argument index="0" name="child" type="Object"> </argument> <description> @@ -36780,7 +37488,7 @@ This method controls whether the position between two cached points is interpola </argument> <argument index="1" name="button" type="Texture"> </argument> - <argument index="2" name="arg2" type="int"> + <argument index="2" name="button_idx" type="int"> </argument> <description> </description> @@ -37304,7 +38012,7 @@ This method controls whether the position between two cached points is interpola </argument> <argument index="1" name="property" type="String"> </argument> - <argument index="2" name="value" type="var"> + <argument index="2" name="value" type="Variant"> </argument> <description> </description> @@ -37314,7 +38022,7 @@ This method controls whether the position between two cached points is interpola </argument> <argument index="1" name="property" type="String"> </argument> - <argument index="2" name="value" type="var"> + <argument index="2" name="value" type="Variant"> </argument> <description> </description> @@ -37754,7 +38462,7 @@ This method controls whether the position between two cached points is interpola Vector class, which performs basic 3D vector math operations. </brief_description> <description> - Vector3 is one of the core classes of the engine, and includes several built-in helper functions to perform basic vecor math operations. + Vector3 is one of the core classes of the engine, and includes several built-in helper functions to perform basic vector math operations. </description> <methods> <method name="abs"> @@ -38342,6 +39050,12 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> + <method name="get_video_texutre"> + <return type="Texture"> + </return> + <description> + </description> + </method> </methods> <constants> </constants> @@ -38672,7 +39386,7 @@ This method controls whether the position between two cached points is interpola </description> </method> <method name="set_render_target_to_screen_rect"> - <argument index="0" name="arg0" type="Rect2"> + <argument index="0" name="rect" type="Rect2"> </argument> <description> </description> @@ -40144,6 +40858,14 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> + <method name="canvas_item_set_z"> + <argument index="0" name="arg0" type="RID"> + </argument> + <argument index="1" name="arg1" type="int"> + </argument> + <description> + </description> + </method> <method name="canvas_item_add_line"> <argument index="0" name="arg0" type="RID"> </argument> @@ -40589,6 +41311,8 @@ This method controls whether the position between two cached points is interpola </description> <methods> <method name="get_ref" qualifiers="const"> + <return type="Object"> + </return> <description> </description> </method> @@ -40800,7 +41524,7 @@ This method controls whether the position between two cached points is interpola <method name="get_attribute_name" qualifiers="const"> <return type="String"> </return> - <argument index="0" name="arg0" type="int"> + <argument index="0" name="idx" type="int"> </argument> <description> </description> @@ -40808,7 +41532,7 @@ This method controls whether the position between two cached points is interpola <method name="get_attribute_value" qualifiers="const"> <return type="String"> </return> - <argument index="0" name="arg0" type="int"> + <argument index="0" name="idx" type="int"> </argument> <description> </description> @@ -40816,7 +41540,7 @@ This method controls whether the position between two cached points is interpola <method name="has_attribute" qualifiers="const"> <return type="bool"> </return> - <argument index="0" name="arg0" type="String"> + <argument index="0" name="name" type="String"> </argument> <description> </description> @@ -40824,7 +41548,7 @@ This method controls whether the position between two cached points is interpola <method name="get_named_attribute_value" qualifiers="const"> <return type="String"> </return> - <argument index="0" name="arg0" type="String"> + <argument index="0" name="name" type="String"> </argument> <description> </description> @@ -40832,7 +41556,7 @@ This method controls whether the position between two cached points is interpola <method name="get_named_attribute_value_safe" qualifiers="const"> <return type="String"> </return> - <argument index="0" name="arg0" type="String"> + <argument index="0" name="name" type="String"> </argument> <description> </description> @@ -40856,7 +41580,7 @@ This method controls whether the position between two cached points is interpola <method name="seek"> <return type="int"> </return> - <argument index="0" name="arg0" type="int"> + <argument index="0" name="pos" type="int"> </argument> <description> </description> diff --git a/doc/core_classes.xml b/doc/core_classes.xml deleted file mode 100644 index c37b50f122..0000000000 --- a/doc/core_classes.xml +++ /dev/null @@ -1,2654 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" ?> -<doc version="1.0" name="Core Types"> -<class category="Core" name="Vector3"> - <brief_description> - Vector class, which performs basic 3D vector math operations. - </brief_description> - <description> - Vector3 is one of the core classes of the engine, and includes several built-in helper functions to perform basic vecor math operations. - </description> - <methods> - <method name="operator+"> - <argument index="0" name="b" type="Vector3"> - </argument> - <return type="Vector3"> - Sum. - </return> - <description> - Add two vectors. - </description> - </method> - <method name="operator-"> - <argument index="0" name="b" type="Vector3"> - </argument> - <return type="Vector3"> - Difference. - </return> - <description> - Substract two vectors. - </description> - </method> - <method name="operator/"> - <argument index="0" name="b" type="Vector3"> - </argument> - <return type="Vector3"> - Quotient. - </return> - <description> - Divide two vectors (component wise). - </description> - </method> - <method name="operator*"> - <argument index="0" name="b" type="Vector3"> - </argument> - <return type="Vector3"> - Product. - </return> - <description> - Multiply two vectors (components wise). - </description> - </method> - <method name="set_axis"> - <argument index="0" name="axis" type="int"> - Axis Index. - </argument> - <argument index="1" name="value" type="real"> - Value. - </argument> - <description> - Set an individual axis (0 is X, 1 is Y and 2 is Z). the enum constants Vector.AXIS_X, Vector.AXIS_Y, and Vector.AXIS_Z, are also valid. This is specially useful for for-loops. - </description> - </method> - <method name="get_axis"> - <argument index="0" name="axis" type="int"> - Axis Index. - </argument> - <return type="real"> - Value. - </return> - <description> - Set an individual axis (0 is X, 1 is Y and 2 is Z). the enum constants Vector.AXIS_X, Vector.AXIS_Y, and Vector.AXIS_Z, are also valid. This is specially useful for for-loops. - </description> - </method> - <method name="length"> - <return type="real"> - Length: sqrt(x^2+y^2+z^2) - </return> - <description> - Return the length of the vector. - </description> - </method> - <method name="length_squared"> - <return type="real"> - Squared Length: x^2+y^2+z^2. - </return> - <description> - Return the length of the vector, without the square root step. - </description> - </method> - <method name="normalize"> - <description> - Normalize the vector to unit length. This is the same as v = v / v.length() - </description> - </method> - <method name="normalized"> - <return type="Vector3"> - </return> - <description> - Return a copy of the normalized vector to unit length. This is the same as v / v.length() - </description> - </method> - <method name="inverse"> - <return type="Vector3"> - Inverse: 1/v - </return> - <description> - Returns the inverse of the vector. this is the same as Vector3( 1.0 / v.x, 1.0 / v.y, 1.0 / v.z ) - </description> - </method> - <method name="zero"> - <description> - Set x,y and z to 0. - </description> - </method> - <method name="snap"> - <argument index="0" name="snap" type="real"> - </argument> - <description> - Snap the vector in each axis the the lowest nearest multiple. ie: 4,5,7 snapped to 2 equals 4,4,6. - </description> - </method> - <method name="snapped"> - <argument index="0" name="snap" type="real"> - </argument> - <return type="Vector3"> - Snapped copy. - </return> - <description> - Return a copy of the vector, snapped to the lowest neared multiple. - </description> - </method> - <method name="linear_interpolate"> - <argument index="0" name="b" type="Vector3"> - </argument> - <argument index="1" name="i" type="real"> - </argument> - <return type="Vector3"> - </return> - <description> - Linearly interpolates the vector to a given one (b), by the given amount (i) - </description> - </method> - <method name="cubic_interpolate"> - <argument index="0" name="a" type="Vector3"> - </argument> - <argument index="1" name="c" type="Vector3"> - </argument> - <argument index="2" name="d" type="Vector3"> - </argument> - <argument index="3" name="i" type="real"> - </argument> - <return type="Vector3"> - </return> - <description> - Perform a cubic interpolation between vectors a,b,c,d (b is current), by the given amount (i). - </description> - </method> - <method name="cross"> - <argument index="0" name="b" type="Vector3"> - </argument> - <return type="Vector3"> - Cross product. - </return> - <description> - Return the cross product with b. - </description> - </method> - <method name="dot"> - <argument index="0" name="b" type="Vector3"> - </argument> - <return type="real"> - </return> - <description> - Return the dot product with b. - </description> - </method> - <method name="distance_to"> - <argument index="0" name="b" type="Vector3"> - </argument> - <return type="real"> - </return> - <description> - Return the distance to b. - </description> - </method> - <method name="distance_squared_to"> - <argument index="0" name="b" type="Vector3"> - </argument> - <return type="real"> - </return> - <description> - Return the squared distance (distance minus the last square root) to b. - </description> - </method> - </methods> - <constants> - <constant name="AXIS_X" value="0"> - </constant> - <constant name="AXIS_Y" value="1"> - </constant> - <constant name="AXIS_Z" value="2"> - </constant> - </constants> - <members> - <member name="x" type="real"> - </member> - <member name="y" type="real"> - </member> - <member name="z" type="real"> - </member> - </members> -</class> -<class category="Core" name="AABB"> - <brief_description> - Axis-Aligned-Bounding-Box. - </brief_description> - <description> - AABB stands for "Axis Aligned Bounding Box". It consits of a position and a size, which for an box that is always aligned to the x, y and z axis, which goes from "pos" to "pos+size". - </description> - <methods> - <method name="has_no_area"> - <return type="bool"> - </return> - <description> - Returns true if the AABB volume is empty (even if it has a surface). Holds true if size.x,y or z is 0. - </description> - </method> - <method name="has_no_surface"> - <return type="bool"> - </return> - <description> - Return true if size is 0,0,0. - </description> - </method> - <method name="area"> - <return type="real"> - </return> - <description> - Compute the volume of the AABB. - </description> - </method> - <method name="intersects"> - <argument index="0" name="b" type="AABB"> - </argument> - <return type="bool"> - </return> - <description> - Returns true if this AABB shares a portion of space with b. - </description> - </method> - <method name="encloses"> - <argument index="0" name="b" type="AABB"> - </argument> - <return type="bool"> - </return> - <description> - Returns true if this AABB completely encloses b. - </description> - </method> - <method name="merge_with"> - <argument index="0" name="b" type="AABB"> - </argument> - <description> - Expand this AABB to also enclose the area of b. - </description> - </method> - <method name="intersection_with"> - <argument index="0" name="b" type="AABB"> - </argument> - <return type="AABB"> - </return> - <description> - Return the shared portion of space with b (empty if they don't intersect). - </description> - </method> - <method name="intersects_segment"> - <argument index="0" name="a" type="Vector3"> - </argument> - <argument index="1" name="b" type="Vector3"> - </argument> - <argument index="2" name="@r" type="Vector3"> - result (if they intersect) - </argument> - <argument index="3" name="@n" type="Vector3"> - normal (if they intersect) - </argument> - <return type="bool"> - </return> - <description> - Returns true if this AABB intersects segment "a" towards "b". Also, return the point and normal of intersection. - </description> - </method> - <method name="intersects_plane"> - <argument index="0" name="p" type="Plane"> - </argument> - <return type="bool"> - </return> - <description> - Returns true if this AABB intersects the plane b. - </description> - </method> - <method name="has_point"> - <argument index="0" name="p" type="Vector3"> - </argument> - <return type="bool"> - </return> - <description> - Return true if this AABB contains point "p". - </description> - </method> - <method name="get_longest_axis"> - <return type="Vector3"> - Axis direction - </return> - <description> - Get the normal of the longest axis in this AABB. - </description> - </method> - <method name="get_longest_axis_index"> - <return type="int"> - </return> - <description> - Get the index of the longest axis in this AABB. - </description> - </method> - <method name="get_longest_axis_size"> - <return type="real"> - Get the length of the longest axis in this AABB. - </return> - <description> - </description> - </method> - <method name="get_edge"> - <argument index="0" name="@ra" type="Vector3"> - </argument> - <argument index="1" name="@rb" type="Vector3"> - </argument> - <description> - Get one of the edges (0 to 11) of this AABB in "ra" and "rb". - </description> - </method> - <method name="grow_by"> - <argument index="0" name="s" type="real"> - </argument> - <description> - Grow this AABB, by expanding its margin, by "s". - </description> - </method> - <method name="expand_to"> - <argument index="0" name="p" type="Vector3"> - </argument> - <description> - Expand this AABB to contain point "p". - </description> - </method> - </methods> - <members> - <member name="pos" type="Vector3"> - Position of the AABB. - </member> - <member name="size" type="Vector3"> - Suze of the AABB (should always be positive). - </member> - </members> -</class> -<class category="Core" name="Plane"> - <brief_description> - Plane in hessian form. - </brief_description> - <description> - Plane represents a normalized plane equation. Basically, "normal" is the normal of the plane (a,b,c normalized), and "d" is the distance from the origin to the plane (in the direction of "normal"). "Over" or "Above" the plane is considered the side of the plane towards where the normal is pointing. - </description> - <methods> - <method name="normalize"> - <description> - Normalize the plane (although it will be often normalized already). - </description> - </method> - <method name="normalized"> - <return type="Plane"> - </return> - <description> - Returns a copy of the plane, normalized. - </description> - </method> - <method name="is_point_over"> - <argument index="0" name="p" type="Vector3"> - </argument> - <return type="bool"> - </return> - <description> - Returns true if "p" is located above the plane. - </description> - </method> - <method name="distance"> - <argument index="0" name="p" type="Vector3"> - </argument> - <return type="real"> - </return> - <description> - Returns the orthogonal distance from "p" to the plane. If positive, "p" is above, if negative, "p" is below. - </description> - </method> - <method name="has_point"> - <argument index="0" name="p" type="Vector3"> - </argument> - <return type="bool"> - </return> - <description> - Returns true if "p" is inside the plane (by a very minimum treshold). - </description> - </method> - <method name="intersect_3"> - <argument index="0" name="a" type="Plane"> - </argument> - <argument index="1" name="b" type="Plane"> - </argument> - <argument index="2" name="@r" type="Vector3"> - </argument> - <return type="bool"> - </return> - <description> - Returns true if this plane intersects with planes "a" and "b". The resulting intersectin is placed in "r". - </description> - </method> - <method name="intersects_ray"> - <argument index="0" name="p" type="Vector3"> - </argument> - <argument index="1" name="d" type="Vector3"> - </argument> - <argument index="2" name="@r" type="Vector3"> - </argument> - <return type="bool"> - </return> - <description> - Returns true if ray consiting of position "p" and direction normal "d" intersects this plane. If true, the result is placed in "r". - </description> - </method> - <method name="intersects_segment"> - <argument index="0" name="sa" type="Vector3"> - </argument> - <argument index="1" name="sb" type="Vector3"> - </argument> - <argument index="2" name="@r" type="Vector3"> - </argument> - <return type="bool"> - </return> - <description> - Returns true if segment from position "sa" to position "sb" intersects this plane. If true, the result is placed in "r". - - </description> - </method> - <method name="project"> - <argument index="0" name="p" type="Vector3"> - </argument> - <return type="Vector3"> - </return> - <description> - Returns the orthogonal projection of point "p" into a point in the plane. - </description> - </method> - <method name="is_almost_like"> - <argument index="0" name="b" type="plane"> - </argument> - <return type="bool"> - </return> - <description> - Returns true if plane "b" is very similar to this one. - </description> - </method> - </methods> - <members> - <member name="normal" type="Vector3"> - Plane normal vector (a,c and d in the plane equation normalized). - </member> - <member name="d" type="real"> - Plane distance (d in the plane equation). - </member> - </members> -</class> -<class category="Core" name="Quat"> - <brief_description> - Quaternion. - </brief_description> - <description> - Quaternion is a 4 dimensional vector that is used to represet a rotation. It mainly exists to perform SLERP (spherical-linear interpolation) between to rotations obtained by a Matrix3 cheaply. Adding quaternions also cheaply adds the rotations, however quaternions need to be often normalized, or else they suffer from precision issues. - </description> - <methods> - <method name="length"> - <return type="real"> - </return> - <description> - Returns the length of the quaternion. - </description> - </method> - <method name="length_squared"> - <return type="real"> - </return> - <description> - Returns the length of the quaternion, minus the square root. - </description> - </method> - <method name="normalize"> - <description> - Normalize the quaternion to unit length. - </description> - </method> - <method name="normalized"> - <return type="Quat"> - </return> - <description> - Returns a copy of the quaternion, normalized to unit length. - </description> - </method> - <method name="inverse"> - <return type="Quat"> - </return> - <description> - Returns the inverse of the quaternion (applies to the inverse rotatio too). - </description> - </method> - <method name="dot"> - <argument index="0" name="b" type="Quat"> - </argument> - <return type="real"> - </return> - <description> - Returns the dot product between two quaternions. - </description> - </method> - <method name="set_euler"> - <argument index="0" name="e" type="Vector3"> - </argument> - <description> - Create a quaternion from euler rotation "e", as yaw, pitch, roll. - </description> - </method> - <method name="slerp"> - <argument index="0" name="b" type="Quat"> - </argument> - <argument index="1" name="i" type="real"> - </argument> - <return type="Quat"> - </return> - <description> - Perform a spherical-linear interpolation with another quaternion. - </description> - </method> - <method name="operator*"> - <argument index="0" name="arg1" type="Quat"> - </argument> - <return type="Quat"> - </return> - <description> - Peform multiplication between two quaternions. - </description> - </method> - </methods> - <members> - <member name="x" type="real"> - x-axis - </member> - <member name="y" type="real"> - y-axis - </member> - <member name="z" type="real"> - z-axis - </member> - <member name="w" type="real"> - w-axis - </member> - </members> -</class> -<class category="Core" name="Matrix3"> - <brief_description> - 3x3 Matrix. - </brief_description> - <description> - Matrix represent a 3x3 (3 rows by 3 columns) transformation matrix. it is used mainly to represent and accumulate transformations such as rotation or scale when used as an OCS (oriented coordinate system). - </description> - <methods> - <method name="invert"> - <description> - Invert the matrix (transformations are reversed). - </description> - </method> - <method name="transpose"> - <description> - Transpose the matrix (transformations are reversed only for orthogonal matrices). - </description> - </method> - <method name="inverse"> - <return type="Matrix3"> - </return> - <description> - Returns the inverse of the matrix. - </description> - </method> - <method name="transposed"> - <return type="Matrix3"> - </return> - <description> - Returns the transposition of the matrix. - </description> - </method> - <method name="rotate"> - <argument index="0" name="axis" type="Vector3"> - </argument> - <argument index="1" name="phi" type="real"> - </argument> - <description> - Rotates the matrix in normalized "axis" by amount "phi" in radians. (This is equivalent to glRotate from OpenGL). - </description> - </method> - <method name="scale"> - <argument index="0" name="s" type="Vector3"> - </argument> - <description> - Scale each axis of the rotated matrix by 's". - </description> - </method> - <method name="get_scale"> - <return type="Vector3"> - </return> - <description> - Get the scale of the matrix. - </description> - </method> - <method name="set_euler"> - <argument index="0" name="e" type="Vector3"> - </argument> - <description> - Create an orthogonal matrix from euler angles "e", as yaw, pitch, roll. - </description> - </method> - <method name="get_euler"> - <return type="Vector3"> - </return> - <description> - Computes and returns the euler engles for an orthogonal matrix, as yaw, pitch, roll. - </description> - </method> - <method name="tdotx"> - <argument index="0" name="v" type="Vector3"> - </argument> - <return type="Vector3"> - </return> - <description> - Computes and returns a dot product with transposed axis x. - </description> - </method> - <method name="tdoty"> - <argument index="0" name="v" type="Vector3"> - </argument> - <return type="Vector3"> - </return> - <description> - Computes and returns a dot product with transposed axis y. - </description> - </method> - <method name="tdotz"> - <argument index="0" name="arg1" type="Vector3"> - </argument> - <return type="Vector3"> - </return> - <description> - Computes and returns a dot product with transposed axis z. - </description> - </method> - <method name="xform"> - <argument index="0" name="v" type="Vector3"> - </argument> - <return type="Vector3"> - </return> - <description> - Transforms vector "v" by this matrix (as M x V) and returns the result. - </description> - </method> - <method name="xform_inv"> - <argument index="0" name="v" type="Vector3"> - </argument> - <return type="Vector3"> - </return> - <description> - Inverse-transforms vector "v" by this matrix (as V x M) and returns the result. - </description> - </method> - <method name="get_axis"> - <argument index="0" name="axis" type="int"> - </argument> - <return type="Vector3"> - </return> - <description> - Get an axis of the OCS. (0 is X, 1 is Y and 2 is Z). The enum constants Vector.AXIS_X, Vector.AXIS_Y, and Vector.AXIS_Z, are also valid. This is equivalent to get_column(). - </description> - </method> - <method name="set_axis"> - <argument index="0" name="axis" type="int"> - </argument> - <argument index="1" name="v" type="Vector3"> - </argument> - <description> - Set an axis of the OCS. (0 is X, 1 is Y and 2 is Z). The enum constants Vector.AXIS_X, Vector.AXIS_Y, and Vector.AXIS_Z, are also valid. This is equivalent to set_column() - </description> - </method> - <method name="get_row"> - <argument index="0" name="i" type="int"> - </argument> - <return type="Vector3"> - </return> - <description> - Get a matrix row. - </description> - </method> - <method name="set_row"> - <argument index="0" name="i" type="int"> - </argument> - <argument index="1" name="v" type="Vector3"> - </argument> - <description> - Set a matrix row. - </description> - </method> - <method name="get_column"> - <argument index="0" name="axis" type="int"> - </argument> - <return type="Vector3"> - </return> - <description> - Get a matrix column. This is equivalent to get_axis() - </description> - </method> - <method name="set_column"> - <argument index="0" name="axis" type="int"> - </argument> - <argument index="1" name="av" type="Vector3"> - </argument> - Set a matrix column. This is equivalent to set_axis - <description> - </description> - </method> - <method name="operator*"> - <argument index="0" name="N" type="Matrix3"> - </argument> - <return type="Matrix3"> - </return> - <description> - Perform a matrix multiplication (M x N) and return the result. - </description> - </method> - <method name="transpose_xform"> - <argument index="0" name="arg1" type="Matrix3"> - </argument> - <return type="Matrix3"> - </return> - <description> - Perform a transposed-matrix multiplication (Mt x N) and return the result. - </description> - </method> - </methods> - <members> - <member name="xx" type="real"> - </member> - <member name="xy" type="real"> - </member> - <member name="xz" type="real"> - </member> - <member name="yx" type="real"> - </member> - <member name="yy" type="real"> - </member> - <member name="yz" type="real"> - </member> - <member name="zx" type="real"> - </member> - <member name="zy" type="real"> - </member> - <member name="zz" type="real"> - </member> - </members> -</class> -<class category="Core" name="Transform"> - <brief_description> - Transformation. - </brief_description> - <description> - Transform is used to store transformations, including translations. It consists of a Matrix3 "basis" and Vector3 "origin". Transform is used to represent transformations of any object in space. It is similar to a 4x3 matrix. - </description> - <methods> - <method name="invert"> - <description> - Invert the transform. - </description> - </method> - - <method name="inverse"> - <return type="Transform"> - </return> - <description> - Returns the inverse of the transform. - </description> - </method> - <method name="rotate"> - <argument index="0" name="axis" type="Vector3"> - </argument> - <argument index="1" name="phi" type="real"> - </argument> - <description> - Rotates the transform in normalized "axis" by amount "phi" in radians. (This is equivalent to glRotate from OpenGL). - </description> - </method> - <method name="scale"> - <argument index="0" name="s" type="Vector3"> - </argument> - <description> - Scales the whole transform by "s" (including the origin) - </description> - </method> - <method name="get_basis"> - <return type="Matrix3"> - </return> - <description> - Get the basis. - </description> - </method> - <method name="translate"> - <argument index="0" name="v" type="Vector3"> - </argument> - <description> - Translate the transform by "v". - </description> - </method> - <method name="set_look_at"> - <argument index="0" name="eye" type="Vector3"> - "Eye" Position. - </argument> - <argument index="1" name="target" type="Vector3"> - "Target" Position. - </argument> - <argument index="2" name="up" type="Vector3"> - "Up" Normal Vector. - </argument> - <description> - Creates a transform positioned at "eye", looking towards "target". "up" represents the direction where "up" is. This function is useful for setting up cameras. - </description> - </method> - <method name="xform"> - <argument index="0" name="v" type="Vector3"> - </argument> - <return type="Vector3"> - </return> - <description> - Transforms vector "v" by this transform. - </description> - </method> - <method name="xform_inv"> - <argument index="0" name="arg1" type="Vector3"> - </argument> - <return type="Vector3"> - </return> - <description> - Inverse-transforms vector "v" by this transform. - </description> - </method> - <method name="xform_aabb"> - <argument index="0" name="a" type="AABB"> - </argument> - <return type="AABB"> - </return> - <description> - Transforms AABB "a" by this transform. The resulting aabb will often be larger, so succesive transforms are not recommended. - </description> - </method> - <method name="xform_aabb_inv"> - <argument index="0" name="a" type="AABB"> - </argument> - <return type="AABB"> - </return> - <description> - Inverse-transforms AABB "a" by this transform. The resulting aabb will often be larger, so succesive transforms are not recommended. - </description> - </method> - <method name="xform_plane"> - <argument index="0" name="p" type="Plane"> - </argument> - <return type="Plane"> - </return> - <description> - Transform plane "p" by this transform. - </description> - </method> - <method name="xform_plane_inv"> - <argument index="0" name="p" type="Plane"> - </argument> - <return type="Plane"> - </return> - <description> - Inverse-transforms plane "p" by this transform. - </description> - </method> - </methods> - <members> - <member name="basis" type="Matrix3"> - Transform "basis" or OCS. - </member> - <member name="origin" type="Vector3"> - Transform origin. - </member> - <member name="xx" type="real"> - </member> - <member name="xy" type="real"> - </member> - <member name="xz" type="real"> - </member> - <member name="yx" type="real"> - </member> - <member name="yy" type="real"> - </member> - <member name="yz" type="real"> - </member> - <member name="zx" type="real"> - </member> - <member name="zy" type="real"> - </member> - <member name="zz" type="real"> - </member> - <member name="tx" type="real"> - </member> - <member name="ty" type="real"> - </member> - <member name="tz" type="real"> - </member> - - </members> -</class> -<class category="Core" name="Vector2"> - <brief_description> - Vector used for 2D Math. - </brief_description> - <description> - Vector class, which performs basic 2D vector math operations. - </description> - <methods> - <method name="operator+"> - <argument index="0" name="b" type="Vector2"> - </argument> - <return type="Vector2"> - </return> - <description> - Add two vectors. - </description> - </method> - <method name="operator-"> - <argument index="0" name="b" type="Vector2"> - </argument> - <return type="Vector2"> - </return> - <description> - Substract two vectors. - </description> - </method> - <method name="operator/"> - <argument index="0" name="b" type="Vector2"> - </argument> - <return type="Vector2"> - </return> - <description> - Divide two vectors. - </description> - </method> - <method name="operator*"> - <argument index="0" name="b" type="Vector2"> - </argument> - <return type="Vector2"> - </return> - <description> - Multiply two vectors. - </description> - </method> - <method name="length"> - <return type="real"> - </return> - <description> - Returns the length of the vector. - </description> - </method> - <method name="length_squared"> - <return type="real"> - </return> - <description> - Returns the squared length of the vector. - </description> - </method> - <method name="normalize"> - <description> - Normalizes the vector to unit length. - </description> - </method> - <method name="normalized"> - <return type="Vector2"> - </return> - <description> - Returns a normalized vector to unit length. - </description> - </method> - <method name="zero"> - <description> - Sets x and y to 0. - </description> - </method> - <method name="linear_interpolate"> - <argument index="0" name="b" type="Vector2"> - </argument> - <argument index="1" name="i" type="real"> - </argument> - <return type="Vector2"> - </return> - <description> - Returns the result of the linear interpolation between this vector and "b", by amount "i". - </description> - </method> - <method name="dot"> - <argument index="0" name="b" type="Vector2"> - </argument> - <return type="real"> - </return> - <description> - Returns the dot product with vector "b". - </description> - </method> - <method name="distance_to"> - <argument index="0" name="b" type="Vector2"> - </argument> - <return type="real"> - </return> - <description> - Returns the distance to vector "b". - </description> - </method> - <method name="floor"> - <return type="Vector2"> - </return> - <description> - Remove the fractional part of x and y. - </description> - </method> - </methods> - - <members> - <member name="x" type="real"> - </member> - <member name="y" type="real"> - </member> - - </members> -</class> -<class category="Core" name="Rect2"> - <brief_description> - Positioned rectangle in 2D. - </brief_description> - <description> - Rect2 represets a positioned rectangle of position "pos" and "size". - </description> - <methods> - <method name="has_no_area"> - <return type="bool"> - </return> - <description> - Returns "true" if the rectangle has no area. - </description> - </method> - <method name="has_point"> - <argument index="0" name="v" type="Vector2"> - </argument> - <return type="bool"> - </return> - <description> - Returns true if v is contained within the rectangle. - </description> - </method> - <method name="merge"> - <argument index="0" name="b" type="Rect2"> - </argument> - <description> - Extend the rectangle to enclose "b". - </description> - </method> - <method name="clip"> - <argument index="0" name="b" type="Rect2"> - </argument> - <return type="Rect2"> - </return> - <description> - Return the interection with rectangle "b" - </description> - </method> - <method name="grow"> - <argument index="0" name="m" type="Vector2"> - </argument> - <description> - Extend the rectangle margin by "m". - </description> - </method> - </methods> - <members> - <member name="pos" type="Vector2"> - Position of the rectangle. - </member> - <member name="size" type="Vector2"> - Size of the rectangle. - </member> - <member name="x" type="real"> - </member> - <member name="y" type="real"> - </member> - <member name="size_x" type="real"> - </member> - <member name="size_y" type="real"> - </member> - </members> -</class> - -<class category="Core" name="Color"> - <brief_description> - Color in RGBA format. - </brief_description> - <description> - A color is represented as red, green and blue (r,g,b) components. Additionally, "a" represents the alpha component, often used for transparency. - </description> - <methods> - <method name="to_32"> - <return type="real"> - </return> - <description> - Convert the color to a 32 its integer (each byte represets a RGBA). - </description> - </method> - <method name="gray"> - <return type="real"> - </return> - <description> - Convert the color to gray. - </description> - </method> - <method name="get_h"> - <return type="real"> - </return> - <description> - Compute the "hue" of the color. - </description> - </method> - <method name="get_s"> - <return type="real"> - </return> - <description> - Compute the "saturation" of the color. - </description> - </method> - <method name="get_v"> - <return type="real"> - </return> - <description> - Compute the "value" of the color. - </description> - </method> - <method name="set_hsv"> - <argument index="0" name="h" type="real"> - </argument> - <argument index="1" name="s" type="real"> - </argument> - <argument index="2" name="v" type="real"> - </argument> - <description> - Set the color from the HSV format. - </description> - </method> - <method name="invert"> - <description> - Invert the color. - </description> - </method> - <method name="contrast"> - <description> - Contrast the color. - </description> - </method> - <method name="interpolate"> - <argument index="0" name="c" type="Vector3"> - </argument> - <argument index="1" name="i" type="real"> - (0 to 1) - </argument> - <description> - Linearly blend with color "c", by amount "i". - </description> - </method> - </methods> - <members> - <member name="r" type="real"> - Red. - </member> - <member name="g" type="real"> - Green. - </member> - <member name="b" type="real"> - Blue. - </member> - <member name="a" type="real"> - Alpha. - </member> - </members> -</class> -<class category="Core" name="Image"> - <brief_description> - Two Dimensional Image. - </brief_description> - <description> - Image represents a two-dimensional representation of an image, composed by a color per pixel. - </description> - <methods> - <method name="get_width"> - <return type="real"> - </return> - <description> - Returns the width of the image (in pixels). - </description> - </method> - <method name="get_height"> - <return type="real"> - </return> - <description> - Returns the height of the image (in pixels). - </description> - </method> - <method name="get_pixel"> - <argument index="0" name="x" type="int"> - </argument> - <argument index="1" name="y" type="int"> - </argument> - <return type="Color"> - </return> - <description> - Get the color of the pixel at position (x,y). - </description> - </method> - <method name="put_pixel"> - <argument index="0" name="x" type="int"> - </argument> - <argument index="1" name="y" type="int"> - </argument> - <argument index="2" name="color" type="Color"> - </argument> - <description> - Sets the color of the pixel at position (x,y). - </description> - </method> - <method name="convert"> - <argument index="0" name="format" type="int"> - </argument> - <description> - Convert the image to a new format (valid values in the FORMAT_* enumeration). - </description> - </method> - <method name="get_format"> - <return type="int"> - </return> - <description> - Get the image format (valid values in the FORMAT_* enumeration). - </description> - </method> - <method name="resize"> - <argument index="0" name="width" type="int"> - </argument> - <argument index="1" name="height" type="int"> - </argument> - <description> - Resize the image to a new pixel resolution given by width,height. - </description> - </method> - <method name="crop"> - <argument index="0" name="width" type="int"> - </argument> - <argument index="1" name="height" type="int"> - </argument> - <description> - Crop the image to a new pixel resolution given by width,height. - </description> - </method> - <method name="flip_x"> - <description> - Flip the X axis of the image. - </description> - </method> - <method name="flip_y"> - <description> - Flip the Y axis of the image. - </description> - </method> - <method name="make_mipmap"> - <argument index="0" name="source" type="Image"> - </argument> - <description> - Create a mipmap from "source" image. - </description> - </method> - <method name="make_normalmap"> - <argument index="0" name="height_scale" type="real"> - </argument> - <description> - Create a normalmap from "height_scale" image. - </description> - </method> - <method name="create"> - <argument index="0" name="width" type="int"> - </argument> - <argument index="1" name="height" type="int"> - </argument> - <argument index="2" name="format" type="int"> - </argument> - <description> - Create a new image of size width, height and format. - </description> - </method> - <method name="import"> - <argument index="0" name="width" type="int"> - </argument> - <argument index="1" name="height" type="int"> - </argument> - <argument index="2" name="format" type="int"> - </argument> - <argument index="3" name="data" type="RawArray"> - </argument> - <description> - Import an image from raw data, given a specific format. - </description> - </method> - <method name="empty"> - <return type="bool"> - </return> - <description> - Returns true if the image is empty. - </description> - </method> - <method name="load"> - <argument index="0" name="path" type="String"> - </argument> - <return type="Error"> - </return> - <description> - Load an image from a file in "path". - </description> - </method> - </methods> - <constants> - <constant name="FORMAT_GRAYSCALE" value="0"> - </constant> - <constant name="FORMAT_INTENSITY" value="1"> - </constant> - <constant name="FORMAT_GRAYSCALE_ALPHA" value="2"> - </constant> - <constant name="FORMAT_RGB" value="3"> - </constant> - <constant name="FORMAT_RGBA" value="4"> - </constant> - <constant name="FORMAT_INDEXED" value="5"> - </constant> - <constant name="FORMAT_INDEXED_ALPHA" value="6"> - </constant> - </constants> -</class> -<class category="Core" name="RID"> - <brief_description> - Resource ID. - </brief_description> - <description> - RID references a resource, typically created in a server. - </description> - <methods> - <method name="is_valid"> - <return type="bool"> - </return> - <description> - Returns true if the resource is valid. - </description> - </method> - </methods> -</class> -<class category="Core" name="InputEvent"> - <brief_description> - A struct containing information fron an input device. - </brief_description> - <description> - A struct containing information fron an input event, such as mouse, keyboard, joystick, etc. Valid event types are:<br></br> - <list> - <li> InputEvent.NONE </li> - <li> InputEvent.KEY </li> - <li> InputEvent.MOUSE_BUTTON </li> - <li> InputEvent.MOUSE_MOTION </li> - <li> InputEvent.JOYSTICK_MOTION </li> - <li> InputEvent.JOYSTICK_BUTTON </li> - </list> - - </description> - <members> - <member name="ID" type="int"> - Event ID. Every event as a unique ID. - </member> - <member name="type" type="int"> - Event type (check description). - </member> - <member name="device" type="int"> - Device that originated the event. - </member> - <member name="mouse_x" type="int"> - Mouse x position (for mouse events). - </member> - <member name="mouse_y" type="int"> - Mouse y position (for mouse events). - </member> - <member name="mouse_button_mask" type="int"> - State of the mouse buttons as a bitmask (for key and mouse events) - </member> - <member name="mouse_global_x" type="int"> - Global mouse x position (used in GUI Controls). - </member> - <member name="mouse_global_y" type="int"> - Global mouse y position (used in GUI Controls). - </member> - <member name="mouse_pressed" type="bool"> - if MOUSE_BUTTON was a press, this value is true. - </member> - <member name="mouse_doubleclick" type="bool"> - if MOUSE_BUTTON was a doubleclick, this value is true. - </member> - <member name="mouse_button_index" type="int"> - Index of the clicked button (mouse button event). - </member> - <member name="mouse_motion_x" type="int"> - Relative x motion of the mouse (mouse motion event). - </member> - <member name="mouse_motion_y" type="int"> - Relative y motion of the mouse (mouse motion event). - </member> - <member name="mod_alt" type="bool"> - If ALT modifier is pressed, this is true (mouse and key events). - </member> - <member name="mod_shift" type="bool"> - If SHIFT modifier is pressed, this is true (mouse and key events). - </member> - <member name="mod_control" type="bool"> - If CONTROL modifier is pressed, this is true (mouse and key events). - </member> - <member name="mod_meta" type="bool"> - If META modifier (win/apple/etc keys) is pressed, this is true (mouse and key events). - </member> - <member name="key_pressed" type="bool"> - if a KEY event originated from a keypress, this is true. - </member> - <member name="key_echo" type="bool"> - if a KEY event originated from an echo key, this is true. - </member> - <member name="key_unicode" type="int"> - Unicode value of a key pressed (key event). - </member> - <member name="key_scancode" type="Key"> - Scancode of a key pressed (check the KEY_* enumeration) (key event). - </member> - <member name="joy_button_index" type="int"> - Joystick button index (joy button event). - </member> - <member name="joy_button_pressed" type="bool"> - If joystick button was pressed, this is true (joy button event). - </member> - <member name="joy_button_index" type="int"> - Index of the pressed/released joystick button. - </member> - <member name="joy_axis" type="int"> - Axis of a joystick (joy axis event). - </member> - <member name="joy_axis_value" type="real"> - Axis value a joystick, from -1 to 1 (joy axis event). - </member> - </members> - <constants> - <constant name="NONE" value="0"> - Empty input event. - </constant> - <constant name="KEY" value="1"> - Key pressed/released event. - </constant> - <constant name="MOUSE_BUTTON" value="2"> - Mouse button pressed/released event. - </constant> - <constant name="JOYSTICK_MOTION" value="3"> - Joystick axis motion event. - </constant> - <constant name="JOYSTICK_BUTTON" value="4"> - Joystick button press/release event. - </constant> - </constants> - -</class> -<class category="Core" name="FileAccess"> - <brief_description> - File Access Interface. - </brief_description> - <description> - FileAccess provides access to files in the host platform (remote access to files in webserver in the web plugin, as web plugin does not access the local filesystem). - </description> - <methods> - <method name="open"> - <argument index="0" name="path" type="String"> - Path to a file - </argument> - <argument index="1" name="mode" type="int"> - Open mode: FileAccess.READ, FileAccess.WRITE or FileAccess.READ_WRITE - </argument> - <return type="Error"> - Error value (check the ERR_ macro for the meaning of the values) - </return> - <description> - Open a file in a given path. Error is returned if the file can't be opened, is nt found, etc. - </description> - </method> - <method name="close"> - <description> - Closes a currently open file. - </description> - </method> - <method name="is_open"> - <return type="bool"> - </return> - <description> - Returns true if a file is currently open. - </description> - </method> - <method name="seek"> - <argument index="0" name="pos" type="int"> - </argument> - <description> - Seek to a given position (in bytes) in the file. - </description> - </method> - <method name="seek_end"> - <argument index="0" name="pos" type="int"> - </argument> - <description> - Seek to a given position (in bytes) in the file, from the end of the file. - </description> - </method> - <method name="get_pos"> - <return type="int"> - </return> - <description> - Get the current position in the file. - </description> - </method> - <method name="get_len"> - <return type="int"> - </return> - <description> - Get the open file size (in bytes). - </description> - </method> - <method name="eof_reached"> - <return type="bool"> - </return> - <description> - Returns true if EOF was reached (read past end of file). - </description> - </method> - <method name="get_8"> - <return type="int"> - </return> - <description> - Read a byte from the file. - </description> - </method> - <method name="get_16"> - <return type="int"> - </return> - <description> - Read a 16-bits unsigned integer from the file, in little/big endian format. - </description> - </method> - <method name="get_32"> - <return type="int"> - </return> - <description> - Read a 32-bits unsigned integer from the file, in little/big endian format. - </description> - </method> - <method name="set_endian_swap"> - <argument index="0" name="swap" type="bool"> - </argument> - <description> - Change the endian mode for reading sizes larger than a byte (read big endian files). - </description> - </method> - <method name="get_endian_swap"> - <return type="bool"> - </return> - <description> - Return the status of the endian swap. - </description> - </method> - <method name="store_8"> - <argument index="0" name="byte" type="int"> - </argument> - <description> - Store a byte in the file. - </description> - </method> - <method name="store_16"> - <argument index="0" name="word" type="int"> - </argument> - <description> - Store a 16-bits integer in the file. - </description> - </method> - <method name="store_32"> - <argument index="0" name="dword" type="int"> - </argument> - <description> - Store a 32 bits integer in the file. - </description> - </method> - <method name="file_exists"> - <argument index="0" name="path" type="String"> - </argument> - <return type="bool"> - </return> - <description> - Returns true if a given file (in path) exist. - </description> - </method> - </methods> - <constants> - <constant name="READ" value="1"> - </constant> - <constant name="WRITE" value="2"> - </constant> - <constant name="READ_WRITE" value="4"> - </constant> - - </constants> -</class> -<class category="Core" name="Dir"> - <brief_description> - Directory Tree Access Interface. - </brief_description> - <description> - Dir provides access to directories in the host platform (remote access to files in webserver in the web plugin, as web plugin does not access the local filesystem). - </description> - <methods> - <method name="list_dir_begin"> - <return type="bool"> - true if an error ocurred. - </return> - <description> - Begin a directory listing. This is done iteratively due to the positility of directories with a large amount of entries. - </description> - </method> - <method name="get_next"> - <return type="String"> - </return> - <description> - Get the next item. If the return value is empty (""), then the end of the directory has been reached. - </description> - </method> - <method name="current_is_dir"> - <return type="bool"> - </return> - <description> - Returns true if the current item is a directory (not a file). - </description> - </method> - <method name="list_dir_end"> - <description> - End the directory listing. - </description> - </method> - <method name="get_drive_count"> - <return type="int"> - </return> - <description> - Get the amount of drives (windows only, returns 0 on other platforms). - </description> - </method> - <method name="get_drive"> - <argument index="0" name="di" type="int"> - </argument> - <return type="String"> - </return> - <description> - Get the string (or character) representing the drive (such as "C","D",etc). - </description> - </method> - <method name="change_dir"> - <argument index="0" name="dir" type="String"> - </argument> - <return type="bool"> - </return> - <description> - Change the current directory of the dir access. "dir" can be either absolute or relative. - </description> - </method> - <method name="get_current_dir"> - <return type="String"> - </return> - <description> - Get the full path of the current dir. - </description> - </method> - <method name="get_dir_separator"> - <return type="String"> - </return> - <description> - Get the string or character most commonly used as drive separator in the host OS. - </description> - </method> - <method name="make_dir"> - <argument index="0" name="name" type="String"> - </argument> - <return type="bool"> - true on error. - </return> - <description> - Create a new directory. "name" can be either absolute or relative. - </description> - </method> - <method name="file_exists"> - <argument index="0" name="path" type="String"> - </argument> - <return type="bool"> - </return> - <description> - Returns true if a file exist. "path" can be either absolute or relative. - </description> - </method> - <method name="get_space_left"> - <return type="int"> - </return> - <description> - Return the space left on the device, in kilobytes. - </description> - </method> - </methods> -</class> -<class category="Core" name="VideoMode"> - <brief_description> - Video Mode structure. - </brief_description> - <description> - Describes a video mode. - </description> - <members> - <member name="width" type="int"> - </member> - <member name="height" type="int"> - </member> - <member name="fullscreen" type="bool"> - "true" if the video mode is full scren. - </member> - <member name="resizable" type="bool"> - "true" if the video mode can be resized to another video mode. - </member> - </members> -</class> -<class category="Core" name="Date"> - <brief_description> - Date structure. - </brief_description> - <description> - Describes a date. - </description> - <members> - <member name="year" type="int"> - year (integer) - </member> - <member name="day" type="int"> - day of the year - </member> - <member name="weekday" type="int"> - day of the week (0 to 6) - </member> - <member name="month" type="int"> - month of the year (0 to 11) - </member> - <member name="dst" type="bool"> - "true" if daylight savings is enabled. - </member> - </members> -</class> -<class category="Core" name="Time"> - <brief_description> - Current Time. - </brief_description> - <description> - Describes the current time. - </description> - <members> - <member name="hour" type="int"> - (0 to 11) - </member> - <member name="min" type="int"> - (0 to 59) - </member> - <member name="sec" type="int"> - (0 to 59) - </member> - </members> -</class> -<class category="Core" name="OS"> - <brief_description> - Operating System common functions. - </brief_description> - <description> - OS provides access to common host OS functions. "OS" Must not be instanced. All members are static (called like OS.get_name() ). - </description> - <methods> - <method name="alert"> - <argument index="0" name="text" type="String"> - </argument> - <description> - Produce an alert. On OSs such as windows or mac, this may result in a popup dialog. - </description> - </method> - <method name="set_mouse_show"> - <argument index="0" name="show" type="bool"> - </argument> - <description> - Determine the hardware cursor visibility (if available). - </description> - </method> - <method name="set_mouse_grab"> - <argument index="0" name="grab" type="bool"> - </argument> - <description> - Capture the hardware cursor (if available). - </description> - </method> - <method name="is_mouse_grab_enabled"> - <return type="bool"> - </return> - <description> - Returns true if the application is capturing the hardware cursor. - </description> - </method> - <method name="get_name"> - <return type="String"> - </return> - <description> - Get the name of the host OS or Platform. - </description> - </method> - <method name="set_video_mode"> - <argument index="0" name="mode" type="VideoMode"> - </argument> - <description> - Change the current videomode (if available). - </description> - </method> - <method name="get_video_mode"> - <return type="VideoMode"> - </return> - <description> - Get the current videomode. - </description> - </method> - <method name="get_date"> - <return type="Date"> - </return> - <description> - Get the current date. - </description> - </method> - <method name="get_time"> - <return type="Time"> - </return> - <description> - Get the current time. - </description> - </method> - <method name="get_ticks_msec"> - <return type="int"> - </return> - <description> - Get the amount of milliseconds since the app started. - </description> - </method> - <method name="delay_usec"> - <argument index="0" name="usec" type="int"> - </argument> - <description> - Suspend the calling thread for "usec" milliseconds - </description> - </method> - </methods> -</class> -<class category="Core" name="Math"> - <brief_description> - Common math functions. - </brief_description> - <description> - Math provides implementations of commonly used math functions."Math" shouldt not be instanced since all members are static (called like Math.cos() ). - </description> - <methods> - <method name="sin"> - <argument index="0" name="rad" type="real"> - </argument> - <return type="real"> - </return> - <description> - </description> - </method> - <method name="cos"> - <argument index="0" name="rad" type="real"> - </argument> - <return type="real"> - </return> - <description> - </description> - </method> - <method name="tan"> - <argument index="0" name="rad" type="real"> - </argument> - <return type="real"> - </return> - <description> - </description> - </method> - <method name="asin"> - <argument index="0" name="s" type="real"> - </argument> - <return type="real"> - </return> - <description> - </description> - </method> - <method name="acos"> - <argument index="0" name="s" type="real"> - </argument> - <return type="real"> - </return> - <description> - </description> - </method> - <method name="atan2"> - <argument index="0" name="x" type="real"> - </argument> - <argument index="1" name="y" type="real"> - </argument> - <return type="real"> - </return> - <description> - </description> - </method> - <method name="deg2rad"> - <argument index="0" name="deg" type="real"> - </argument> - <return type="real"> - </return> - <description> - Degrees to Radians conversion. - </description> - </method> - <method name="sqrt"> - <argument index="0" name="s" type="real"> - </argument> - <return type="real"> - </return> - <description> - </description> - </method> - <method name="pow"> - <argument index="0" name="base" type="real"> - </argument> - <argument index="1" name="power" type="real"> - </argument> - <return type="real"> - </return> - <description> - </description> - </method> - <method name="exp"> - <argument index="0" name="s" type="real"> - </argument> - <return type="real"> - </return> - <description> - </description> - </method> - <method name="log"> - <argument index="0" name="s" type="real"> - </argument> - <return type="real"> - </return> - <description> - </description> - </method> - <method name="fmod"> - <argument index="0" name="x" type="real"> - </argument> - <argument index="1" name="y" type="real"> - </argument> - <return type="real"> - </return> - <description> - </description> - </method> - <method name="stepify"> - <argument index="0" name="x" type="real"> - </argument> - <argument index="1" name="step" type="real"> - </argument> - <return type="real"> - </return> - <description> - Round to nearest (lowest) value in given step. - </description> - </method> - <method name="floor"> - <argument index="0" name="s" type="real"> - </argument> - <return type="real"> - </return> - <description> - </description> - </method> - <method name="round"> - <argument index="0" name="s" type="real"> - </argument> - <return type="real"> - </return> - <description> - </description> - </method> - <method name="decimals"> - <argument index="0" name="s" type="real"> - </argument> - <return type="int"> - </return> - <description> - Returns the amount of decimals used by "s". - </description> - </method> - <method name="randf"> - <return type="real"> - </return> - <description> - Returns a random number fro 0 to 1 - </description> - </method> - <method name="random"> - <argument index="0" name="min" type="real"> - </argument> - <argument index="1" name="max" type="real"> - </argument> - <return type="real"> - </return> - <description> - Returns a random number between "min" and "max" - </description> - </method> - </methods> - <constants> - <constant name="PI" value="3.14159265358979323846"> - </constant> - </constants> - -</class> -<class category="Core" name="Shell"> - <brief_description> - Shell Execution interface. - </brief_description> - <description> - Shell allows the application to open a given URL in the host OS. It can be anything the host OS understands, from a web page to a media file. - </description> - <methods> - <method name="exec"> - <argument index="0" name="url" type="String"> - </argument> - <description> - Open any URL the host OS understands. - </description> - </method> - </methods> -</class> -<class category="Core" name="ResourceLoader"> - <brief_description> - Resource Loader. - </brief_description> - <description> - ResourceLoader loads resources from disk and returns a resource object. - </description> - <methods> - <method name="load"> - <argument index="0" name="path" type="String"> - </argument> - <return type="Resource"> - null on failure. - </return> - <description> - Open a resource in the given path. - </description> - </method> - </methods> -</class> -<class category="Core" name="SceneLoader"> - <brief_description> - Scene Loader - </brief_description> - <description> - SceneLoader loads scenes from disk and returns a scene node. - </description> - <methods> - <method name="load"> - <argument index="0" name="path" type="String"> - </argument> - <return type="Node"> - A scene node, null on error. - </return> - <description> - Load a scene from disk at given "path" and return a node object. - </description> - </method> - </methods> -</class> -<class category="Core" name="Object"> - <brief_description> - Base class for the Object Model. - </brief_description> - <description> - Object is the building block of most of the high level engine interfaces. The "Object" interface contains a reference to an actual internal Object. - Usually, Object memory should not be managed by the API, as resources will be fred automatically when not in use and nodes are deleted by their parent nodes. - </description> - <methods> - <method name="free"> - <description> - Free the Object reference. This should not be used with nodes inside a scene tree, as they are removed by their parent node. This function can also be used to unreference resources. - </description> - </method> - <method name="get_type"> - <return type="String"> - </return> - <description> - Get a string with the type name of the object. - </description> - </method> - <method name="has_instance"> - <return type="bool"> - </return> - <description> - Returns true if the Object datatype contains a reference to an actual object instance. - </description> - </method> - <method name="get_instance_ID"> - <return type="bool"> - </return> - <description> - Return the instance ID of the object. Every Object has a unique instance ID. - </description> - </method> - <method name="is_type" qualifiers="const" > - <return type="bool" > - </return> - <argument index="0" name="type" type="String" > - </argument> - <description> - Return true if the type of the object class (or any base clases) match "type. - </description> - </method> - <method name="set" > - <argument index="0" name="property" type="String" > - </argument> - <argument index="1" name="value" type="var" > - </argument> - <description> - Set a property "property", with any value "value. This function can be inherited with "_set" (but base class "_set" will still be called). - </description> - </method> - <method name="get" qualifiers="const" > - <return type="var" > - </return> - <argument index="0" name="property" type="String" > - </argument> - <description> - Return a property "property". This function can be inherited with "_get" (but base class "_get" will still be called). - </description> - </method> - <method name="notification" > - <argument index="0" name="what" type="int" > - </argument> - <argument index="1" name="reverse" type="bool" default="false" > - </argument> - <description> - Perform a notification. Notifications are quick ways to tell an Object that something happened or changed regarding it's state and surroundings. This function can be inherited with "_notification" (but base class "_notification" will still be called). - </description> - </method> - <method name="set_script" > - <argument index="0" name="script" type="RefPtr" > - </argument> - <description> - Set the script of the object. Any object can contain a script. Scripts behave as if they inherited the object they are set to - </description> - </method> - <method name="get_script" qualifiers="const" > - <return type="RefPtr" > - </return> - <description> - Return the script of the object. Any object can contain a script. Scripts behave as if they inherited the object they are set to - </description> - </method> - <method name="set_meta" > - <argument index="0" name="name" type="String" > - </argument> - <description> - Set a meta property. Meta properties are just containers for setting and retrieving any custom data to an object. Metaproperties are also saved with the object. - </description> - </method> - <method name="get_meta" qualifiers="const" > - <argument index="0" name="name" type="String" > - </argument> - <description> - Return a meta property. Meta properties are just containers for setting and retrieving any custom data to an object. Metaproperties are also saved with the object. - </description> - </method> - <method name="has_meta" qualifiers="const" > - <return type="bool" > - </return> - <argument index="0" name="name" type="String" > - </argument> - <description> - Return wether an object has a meta property. Meta properties are just containers for setting and retrieving any custom data to an object. Metaproperties are also saved with the object. - </description> - </method> - <method name="get_meta_list" qualifiers="const" > - <return type="StringArray" > - </return> - <description> - Return the list of meta properties in the object. Meta properties are just containers for setting and retrieving any custom data to an object. Metaproperties are also saved with the object. - </description> - </method> - <method name="call" > - <argument index="0" name="method" type="String" > - </argument> - <description> - Call any method in the object (syntax: call("method", .. arguments..). - </description> - </method> - </methods> - <constants> - <constant name="NOTIFICATION_POSTINITIALIZE" value="0"> - This notification is called right after the object is done initializing - </constant> - <constant name="NOTIFICATION_PREDELETE" value="1"> - This notification is called right before the object will e deleted. - </constant> - </constants> -</class> -<class category="Core" name="Key"> - <brief_description> - All Symbolic Key Names - </brief_description> - <description> - Key is an enumaration containing the constants for all the symbolic key names. They are used directly (not with Key. prefix). This value is used in the "scancode" field of the "KEY" InputEvent. - </description> - <constants> - <constant name="SPKEY">Special Key Mask</constant> - <constant name="KEY_ESCAPE"></constant> - <constant name="KEY_TAB"></constant> - <constant name="KEY_BACKTAB"></constant> - <constant name="KEY_BACKSPACE"></constant> - <constant name="KEY_RETURN"></constant> - <constant name="KEY_ENTER"></constant> - <constant name="KEY_INSERT"></constant> - <constant name="KEY_DELETE"></constant> - <constant name="KEY_PAUSE"></constant> - <constant name="KEY_PRINT"></constant> - <constant name="KEY_SYSREQ"></constant> - <constant name="KEY_CLEAR"></constant> - <constant name="KEY_HOME"></constant> - <constant name="KEY_END"></constant> - <constant name="KEY_LEFT"></constant> - <constant name="KEY_UP"></constant> - <constant name="KEY_RIGHT"></constant> - <constant name="KEY_DOWN"></constant> - <constant name="KEY_PAGEUP"></constant> - <constant name="KEY_PAGEDOWN"></constant> - <constant name="KEY_SHIFT"></constant> - <constant name="KEY_CONTROL"></constant> - <constant name="KEY_META"></constant> - <constant name="KEY_ALT"></constant> - <constant name="KEY_CAPSLOCK"></constant> - <constant name="KEY_NUMLOCK"></constant> - <constant name="KEY_SCROLLLOCK"></constant> - <constant name="KEY_F1"></constant> - <constant name="KEY_F2"></constant> - <constant name="KEY_F3"></constant> - <constant name="KEY_F4"></constant> - <constant name="KEY_F5"></constant> - <constant name="KEY_F6"></constant> - <constant name="KEY_F7"></constant> - <constant name="KEY_F8"></constant> - <constant name="KEY_F9"></constant> - <constant name="KEY_F10"></constant> - <constant name="KEY_F11"></constant> - <constant name="KEY_F12"></constant> - <constant name="KEY_F13"></constant> - <constant name="KEY_F14"></constant> - <constant name="KEY_F15"></constant> - <constant name="KEY_F16"></constant> - <constant name="KEY_KP_ENTER"></constant> - <constant name="KEY_KP_MULTIPLY"></constant> - <constant name="KEY_KP_DIVIDE"></constant> - <constant name="KEY_KP_SUBSTRACT"></constant> - <constant name="KEY_KP_PERIOD"></constant> - <constant name="KEY_KP_ADD"></constant> - <constant name="KEY_KP_0"></constant> - <constant name="KEY_KP_1"></constant> - <constant name="KEY_KP_2"></constant> - <constant name="KEY_KP_3"></constant> - <constant name="KEY_KP_4"></constant> - <constant name="KEY_KP_5"></constant> - <constant name="KEY_KP_6"></constant> - <constant name="KEY_KP_7"></constant> - <constant name="KEY_KP_8"></constant> - <constant name="KEY_KP_9"></constant> - <constant name="KEY_SUPER_L"></constant> - <constant name="KEY_SUPER_R"></constant> - <constant name="KEY_MENU"></constant> - <constant name="KEY_HYPER_L"></constant> - <constant name="KEY_HYPER_R"></constant> - <constant name="KEY_HELP"></constant> - <constant name="KEY_DIRECTION_L"></constant> - <constant name="KEY_DIRECTION_R"></constant> - <constant name="KEY_BACK"></constant> - <constant name="KEY_FORWARD"></constant> - <constant name="KEY_STOP"></constant> - <constant name="KEY_REFRESH"></constant> - <constant name="KEY_VOLUMEDOWN"></constant> - <constant name="KEY_VOLUMEMUTE"></constant> - <constant name="KEY_VOLUMEUP"></constant> - <constant name="KEY_BASSBOOST"></constant> - <constant name="KEY_BASSUP"></constant> - <constant name="KEY_BASSDOWN"></constant> - <constant name="KEY_TREBLEUP"></constant> - <constant name="KEY_TREBLEDOWN"></constant> - <constant name="KEY_MEDIAPLAY"></constant> - <constant name="KEY_MEDIASTOP"></constant> - <constant name="KEY_MEDIAPREVIOUS"></constant> - <constant name="KEY_MEDIANEXT"></constant> - <constant name="KEY_MEDIARECORD"></constant> - <constant name="KEY_HOMEPAGE"></constant> - <constant name="KEY_FAVORITES"></constant> - <constant name="KEY_SEARCH"></constant> - <constant name="KEY_STANDBY"></constant> - <constant name="KEY_OPENURL"></constant> - <constant name="KEY_LAUNCHMAIL"></constant> - <constant name="KEY_LAUNCHMEDIA"></constant> - <constant name="KEY_LAUNCH0"></constant> - <constant name="KEY_LAUNCH1"></constant> - <constant name="KEY_LAUNCH2"></constant> - <constant name="KEY_LAUNCH3"></constant> - <constant name="KEY_LAUNCH4"></constant> - <constant name="KEY_LAUNCH5"></constant> - <constant name="KEY_LAUNCH6"></constant> - <constant name="KEY_LAUNCH7"></constant> - <constant name="KEY_LAUNCH8"></constant> - <constant name="KEY_LAUNCH9"></constant> - <constant name="KEY_LAUNCHA"></constant> - <constant name="KEY_LAUNCHB"></constant> - <constant name="KEY_LAUNCHC"></constant> - <constant name="KEY_LAUNCHD"></constant> - <constant name="KEY_LAUNCHE"></constant> - <constant name="KEY_LAUNCHF"></constant> - - <constant name="KEY_UNKNOWN"></constant> - <constant name="KEY_SPACE"></constant> - <constant name="KEY_EXCLAM"></constant> - <constant name="KEY_QUOTEDBL"></constant> - <constant name="KEY_NUMBERSIGN"></constant> - <constant name="KEY_DOLLAR"></constant> - <constant name="KEY_PERCENT"></constant> - <constant name="KEY_AMPERSAND"></constant> - <constant name="KEY_APOSTROPHE"></constant> - <constant name="KEY_PARENLEFT"></constant> - <constant name="KEY_PARENRIGHT"></constant> - <constant name="KEY_ASTERISK"></constant> - <constant name="KEY_PLUS"></constant> - <constant name="KEY_COMMA"></constant> - <constant name="KEY_MINUS"></constant> - <constant name="KEY_PERIOD"></constant> - <constant name="KEY_SLASH"></constant> - <constant name="KEY_0"></constant> - <constant name="KEY_1"></constant> - <constant name="KEY_2"></constant> - <constant name="KEY_3"></constant> - <constant name="KEY_4"></constant> - <constant name="KEY_5"></constant> - <constant name="KEY_6"></constant> - <constant name="KEY_7"></constant> - <constant name="KEY_8"></constant> - <constant name="KEY_9"></constant> - <constant name="KEY_COLON"></constant> - <constant name="KEY_SEMICOLON"></constant> - <constant name="KEY_LESS"></constant> - <constant name="KEY_EQUAL"></constant> - <constant name="KEY_GREATER"></constant> - <constant name="KEY_QUESTION"></constant> - <constant name="KEY_AT"></constant> - <constant name="KEY_A"></constant> - <constant name="KEY_B"></constant> - <constant name="KEY_C"></constant> - <constant name="KEY_D"></constant> - <constant name="KEY_E"></constant> - <constant name="KEY_F"></constant> - <constant name="KEY_G"></constant> - <constant name="KEY_H"></constant> - <constant name="KEY_I"></constant> - <constant name="KEY_J"></constant> - <constant name="KEY_K"></constant> - <constant name="KEY_L"></constant> - <constant name="KEY_M"></constant> - <constant name="KEY_N"></constant> - <constant name="KEY_O"></constant> - <constant name="KEY_P"></constant> - <constant name="KEY_Q"></constant> - <constant name="KEY_R"></constant> - <constant name="KEY_S"></constant> - <constant name="KEY_T"></constant> - <constant name="KEY_U"></constant> - <constant name="KEY_V"></constant> - <constant name="KEY_W"></constant> - <constant name="KEY_X"></constant> - <constant name="KEY_Y"></constant> - <constant name="KEY_Z"></constant> - <constant name="KEY_BRACKETLEFT"></constant> - <constant name="KEY_BACKSLASH"></constant> - <constant name="KEY_BRACKETRIGHT"></constant> - <constant name="KEY_ASCIICIRCUM"></constant> - <constant name="KEY_UNDERSCORE"></constant> - <constant name="KEY_QUOTELEFT"></constant> - <constant name="KEY_BRACELEFT"></constant> - <constant name="KEY_BAR"></constant> - <constant name="KEY_BRACERIGHT"></constant> - <constant name="KEY_ASCIITILDE"></constant> - <constant name="KEY_NOBREAKSPACE"></constant> - <constant name="KEY_EXCLAMDOWN"></constant> - <constant name="KEY_CENT"></constant> - <constant name="KEY_STERLING"></constant> - <constant name="KEY_CURRENCY"></constant> - <constant name="KEY_YEN"></constant> - <constant name="KEY_BROKENBAR"></constant> - <constant name="KEY_SECTION"></constant> - <constant name="KEY_DIAERESIS"></constant> - <constant name="KEY_COPYRIGHT"></constant> - <constant name="KEY_ORDFEMININE"></constant> - <constant name="KEY_GUILLEMOTLEFT"></constant> - <constant name="KEY_NOTSIGN"></constant> - <constant name="KEY_HYPHEN"></constant> - <constant name="KEY_REGISTERED"></constant> - <constant name="KEY_MACRON"></constant> - <constant name="KEY_DEGREE"></constant> - <constant name="KEY_PLUSMINUS"></constant> - <constant name="KEY_TWOSUPERIOR"></constant> - <constant name="KEY_THREESUPERIOR"></constant> - <constant name="KEY_ACUTE"></constant> - <constant name="KEY_MU"></constant> - <constant name="KEY_PARAGRAPH"></constant> - <constant name="KEY_PERIODCENTERED"></constant> - <constant name="KEY_CEDILLA"></constant> - <constant name="KEY_ONESUPERIOR"></constant> - <constant name="KEY_MASCULINE"></constant> - <constant name="KEY_GUILLEMOTRIGHT"></constant> - <constant name="KEY_ONEQUARTER"></constant> - <constant name="KEY_ONEHALF"></constant> - <constant name="KEY_THREEQUARTERS"></constant> - <constant name="KEY_QUESTIONDOWN"></constant> - <constant name="KEY_AGRAVE"></constant> - <constant name="KEY_AACUTE"></constant> - <constant name="KEY_ACIRCUMFLEX"></constant> - <constant name="KEY_ATILDE"></constant> - <constant name="KEY_ADIAERESIS"></constant> - <constant name="KEY_ARING"></constant> - <constant name="KEY_AE"></constant> - <constant name="KEY_CCEDILLA"></constant> - <constant name="KEY_EGRAVE"></constant> - <constant name="KEY_EACUTE"></constant> - <constant name="KEY_ECIRCUMFLEX"></constant> - <constant name="KEY_EDIAERESIS"></constant> - <constant name="KEY_IGRAVE"></constant> - <constant name="KEY_IACUTE"></constant> - <constant name="KEY_ICIRCUMFLEX"></constant> - <constant name="KEY_IDIAERESIS"></constant> - <constant name="KEY_ETH"></constant> - <constant name="KEY_NTILDE"></constant> - <constant name="KEY_OGRAVE"></constant> - <constant name="KEY_OACUTE"></constant> - <constant name="KEY_OCIRCUMFLEX"></constant> - <constant name="KEY_OTILDE"></constant> - <constant name="KEY_ODIAERESIS"></constant> - <constant name="KEY_MULTIPLY"></constant> - <constant name="KEY_OOBLIQUE"></constant> - <constant name="KEY_UGRAVE"></constant> - <constant name="KEY_UACUTE"></constant> - <constant name="KEY_UCIRCUMFLEX"></constant> - <constant name="KEY_UDIAERESIS"></constant> - <constant name="KEY_YACUTE"></constant> - <constant name="KEY_THORN"></constant> - <constant name="KEY_SSHARP"></constant> - - <constant name="KEY_DIVISION"></constant> - <constant name="KEY_YDIAERESIS"></constant> - - <constant name="KEY_CODE_MASK"></constant> - <constant name="KEY_MODIFIER_MASK"></constant> - - <constant name="KEY_MASK_SHIFT"></constant> - <constant name="KEY_MASK_ALT"></constant> - <constant name="KEY_MASK_META"></constant> - <constant name="KEY_MASK_CTRL"></constant> - <constant name="KEY_MASK_KPAD"></constant> - <constant name="KEY_MASK_GROUP_SWITCH"></constant> - - </constants> -</class> -<class category="Core" name="PropertyHint"> - <brief_description> - Property Hints. - </brief_description> - <description> - PropertyHint hints editors on how to edit a property. In many cases, hint_string (in the PropertyInfo) will contain extra data. These constants are used globally ("PropertyHint" class doesn't exist"). - </description> - <constants> - <constant name="PROPERTY_HINT_NONE"></constant> - <constant name="PROPERTY_HINT_RANGE">Hint_string defined as "min,max,step - "</constant> - <constant name="PROPERTY_HINT_ENUM">Values such as 0,1,2 are represented in hint_string as "A,B,C"</constant> - <constant name="PROPERTY_HINT_LENGTH">hint_string is the length of an array type.</constant> - <constant name="PROPERTY_HINT_FLAGS">Flags names are in hint_string from MSB to LSB as "flag8,fla7,flag6,,,,flag1"</constant> - <constant name="PROPERTY_HINT_PATH">Property is a path.</constant> - <constant name="PROPERTY_HINT_FILE">Property is a path to a file.</constant> - <constant name="PROPERTY_HINT_DIR">Property is a path to a dir.</constant> - <constant name="PROPERTY_HINT_RESOURCE_TYPE">hint_string contains the valid resource types the property accept (separated by ",").</constant> - </constants> -</class> -<class category="Core" name="PropertyUsage"> - <brief_description> - Usage for an object property. - </brief_description> - <description> - PropertyUsage defines a list of (inclusive) usages that can be ORed together to specify how the property will be treated in different scenarios. These constants are used globally ("PropertyUsage" class doesn't exist"). - </description> - <constants> - <constant name="PROPERTY_USAGE_STORAGE"> Property is Saved/Loaded from disk.</constant> - <constant name="PROPERTY_USAGE_EDITOR">Property is visible in editor (for editing).</constant> - <constant name="PROPERTY_USAGE_NETWORK">Property can be syncronized on network.</constant> - <constant name="PROPERTY_USAGE_DEFAULT">Default usage.</constant> - </constants> -</class> -<class category="Core" name="Type"> - <brief_description> - Valid Data Types. - </brief_description> - <description> - Type consists of a list of valid types. It is usually used for property type hinting. These constants are used globally ("Type" class doesn't exist"). - </description> - <constants> - <constant name="TYPE_NIL"></constant> - <constant name="TYPE_BOOL"></constant> - <constant name="TYPE_INT"></constant> - <constant name="TYPE_REAL"></constant> - <constant name="TYPE_STRING"></constant> - <constant name="TYPE_VECTOR2"></constant> - <constant name="TYPE_RECT2"></constant> - <constant name="TYPE_VECTOR3"></constant> - <constant name="TYPE_PLANE"></constant> - <constant name="TYPE_QUAT"></constant> - <constant name="TYPE_AABB"></constant> - <constant name="TYPE_MATRIX3"></constant> - <constant name="TYPE_TRANSFORM"></constant> - <constant name="TYPE_COLOR"></constant> - <constant name="TYPE_IMAGE"></constant> - <constant name="TYPE_NODE_PATH"></constant> - <constant name="TYPE_RESOURCE"></constant> - <constant name="TYPE_RID"></constant> - <constant name="TYPE_OBJECT"></constant> - <constant name="TYPE_INPUT_EVENT"></constant> - <constant name="TYPE_DICTIONARY"></constant> - <constant name="TYPE_ARRAY"></constant> - <constant name="TYPE_RAW_ARRAY"></constant> - <constant name="TYPE_INT_ARRAY"></constant> - <constant name="TYPE_REAL_ARRAY"></constant> - <constant name="TYPE_STRING_ARRAY"></constant> - <constant name="TYPE_VECTOR3_ARRAY"></constant> - <constant name="TYPE_COLOR_ARRAY"></constant> - </constants> -</class> - - -<class category="Core" name="Error"> - <brief_description> - List of generic errors. - </brief_description> - <description> - Error is a list of generic errors - </description> - <constants> - <constant name="OK"></constant> - <constant name="FAILED"> Generic fail error</constant> - <constant name="ERR_UNAVAILABLE"> What is requested is unsupported/unavailable</constant> - <constant name="ERR_UNCONFIGURED"> The object being used hasnt been properly set up yet</constant> - <constant name="ERR_UNAUTHORIZED"> Missing credentials for requested resource</constant> - <constant name="ERR_PARAMETER_RANGE_ERROR"> Parameter given out of range</constant> - <constant name="ERR_OUT_OF_MEMORY"> Out of memory</constant> - <constant name="ERR_FILE_NOT_FOUND"></constant> - <constant name="ERR_FILE_BAD_DRIVE"></constant> - <constant name="ERR_FILE_BAD_PATH"></constant> - <constant name="ERR_FILE_NO_PERMISSION"></constant> - <constant name="ERR_FILE_ALREADY_IN_USE"></constant> - <constant name="ERR_FILE_CANT_OPEN"></constant> - <constant name="ERR_FILE_CANT_WRITE"></constant> - <constant name="ERR_FILE_CANT_READ"></constant> - <constant name="ERR_FILE_UNRECOGNIZED"></constant> - <constant name="ERR_FILE_CORRUPT"></constant> - <constant name="ERR_FILE_EOF"></constant> - <constant name="ERR_CANT_OPEN"> Can't open a resource/socket/file</constant> - <constant name="ERR_CANT_CREATE"></constant> - <constant name="ERROR_QUERY_FAILED"></constant> - <constant name="ERR_ALREADY_IN_USE"></constant> - <constant name="ERR_LOCKED"> resource is locked</constant> - <constant name="ERR_TIMEOUT"></constant> - <constant name="ERR_CANT_AQUIRE_RESOURCE"></constant> - <constant name="ERR_INVALID_DATA"> Data passed is invalid</constant> - <constant name="ERR_INVALID_PARAMETER"> Parameter passed is invalid</constant> - <constant name="ERR_ALREADY_EXISTS"> When adding"> item already exists</constant> - <constant name="ERR_DOES_NOT_EXIST"> When retrieving/erasing"> it item does not exist</constant> - <constant name="ERR_DATABASE_CANT_READ"> database is full</constant> - <constant name="ERR_DATABASE_CANT_WRITE"> database is full</constant> - <constant name="ERR_COMPILATION_FAILED"></constant> - <constant name="ERR_METHOD_NOT_FOUND"></constant> - <constant name="ERR_LINK_FAILED"></constant> - <constant name="ERR_SCRIPT_FAILED"></constant> - <constant name="ERR_CYCLIC_LINK"></constant> - <constant name="ERR_BUSY"></constant> - <constant name="ERR_HELP"> user requested help!!</constant> - <constant name="ERR_BUG"> a bug in the software certainly happeneddue to a double check failing or unexpected behavior.</constant> - <constant name="ERR_WTF "> an impossible to trigger check due to paranoid programmer was triggered</constant> - </constants> -</class> -</doc> - - diff --git a/doc/deferred_format.txt b/doc/deferred_format.txt deleted file mode 100644 index 76a158a3ce..0000000000 --- a/doc/deferred_format.txt +++ /dev/null @@ -1,33 +0,0 @@ -deferred: - -ar ag ab gl - accumulation RGB + glow - -nx ny mx my? - normal, motion -dr dg db sm - diffuse, shademodel -sr sg sb sp - specular OR shadeparams - -ar ag ab gl -nx ny sp sp -dr dg db se -444 6 -se can be 6 bits, 2 for shade model - -shade models: - -0 - none -1 - wrap -2 - toon -3 - fresne - - - -sp: 2 bits what - 6 bits param - -16 - - - - - - - diff --git a/doc/demos.txt b/doc/demos.txt deleted file mode 100644 index cf56a5cbc6..0000000000 --- a/doc/demos.txt +++ /dev/null @@ -1,40 +0,0 @@ --Oceano --Portales --Grilla --Personaje --Auto (?) --Fisica --Fisica Idle --Low level APIS (Server) --Sonido Posicional --Custom Shaders --HDR --Trees Waving --luces --fixed material --shader material --synctoaudio speech and speex --particulas con gif animados para mostrar que es cada parametro --soporte de syntax hilight de gdscript para editores mas comunes --instanciar enemigos usando duplicate --simulated motion con animacion --animation player controla otro animation player (tipo camina de lugar a otro y saluda) --corutinas y loops con yield para animation, audio, etc --CCD (bullets) - --custom gizmos, editor plugins en script - -Clases que necesitan tutorial. - -Animation/AnimationPlayer -Area2D (space override, notifications) -custom container demo -custon drawing in a canvas item -ignore mouse on top of button -input in a game, with _unhandled_input -demo containers -Control, anchors e input event handling -lots of 2D physics examples -dictionary and array doc of passing by reference? - - diff --git a/doc/engine_classes.xml b/doc/engine_classes.xml deleted file mode 100644 index 43602e26e9..0000000000 --- a/doc/engine_classes.xml +++ /dev/null @@ -1,17940 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" ?> -<doc version="0.99.2555-pre-beta" name="Engine Types"> -<class name="AcceptDialog" inherits="WindowDialog" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="get_ok"> - <return type="Object"> - </return> - <description> - </description> - </method> - <method name="get_label"> - <return type="Object"> - </return> - <description> - </description> - </method> - <method name="set_hide_on_ok"> - <argument index="0" name="enabled" type="bool"> - </argument> - <description> - </description> - </method> - <method name="get_hide_on_ok" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="add_button"> - <return type="Button"> - </return> - <argument index="0" name="text" type="String" default=""""> - </argument> - <description> - </description> - </method> - <method name="add_cancel"> - <return type="Button"> - </return> - <argument index="0" name="name" type="String"> - </argument> - <description> - </description> - </method> - <method name="register_text_enter"> - <argument index="0" name="line_edit" type="Object"> - </argument> - <description> - </description> - </method> - <method name="set_text"> - <argument index="0" name="text" type="String"> - </argument> - <description> - </description> - </method> - <method name="get_text" qualifiers="const"> - <return type="String"> - </return> - <description> - </description> - </method> - </methods> - <signals> - <signal name="confirmed"> - <description> - </description> - </signal> - <signal name="custom_action"> - <argument index="0" name="action" type="String"> - </argument> - <description> - </description> - </signal> - </signals> - <constants> - </constants> -</class> -<class name="Animation" inherits="Resource" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="add_track"> - <return type="int"> - </return> - <argument index="0" name="type" type="int"> - </argument> - <argument index="1" name="at_pos" type="int" default="-1"> - </argument> - <description> - </description> - </method> - <method name="remove_track"> - <argument index="0" name="idx" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_track_count" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="track_get_type" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="idx" type="int"> - </argument> - <description> - </description> - </method> - <method name="track_get_path" qualifiers="const"> - <return type="NodePath"> - </return> - <argument index="0" name="idx" type="int"> - </argument> - <description> - </description> - </method> - <method name="track_set_path"> - <argument index="0" name="idx" type="int"> - </argument> - <argument index="1" name="path" type="NodePath"> - </argument> - <description> - </description> - </method> - <method name="track_move_up"> - <argument index="0" name="idx" type="int"> - </argument> - <description> - </description> - </method> - <method name="track_move_down"> - <argument index="0" name="idx" type="int"> - </argument> - <description> - </description> - </method> - <method name="transform_track_insert_key"> - <return type="int"> - </return> - <argument index="0" name="idx" type="int"> - </argument> - <argument index="1" name="time" type="real"> - </argument> - <argument index="2" name="loc" type="Vector3"> - </argument> - <argument index="3" name="rot" type="Quat"> - </argument> - <argument index="4" name="scale" type="Vector3"> - </argument> - <description> - </description> - </method> - <method name="track_insert_key"> - <argument index="0" name="idx" type="int"> - </argument> - <argument index="1" name="time" type="real"> - </argument> - <argument index="2" name="key" type="var"> - </argument> - <argument index="3" name="transition" type="real" default="1"> - </argument> - <description> - </description> - </method> - <method name="track_remove_key"> - <argument index="0" name="idx" type="int"> - </argument> - <argument index="1" name="key_idx" type="int"> - </argument> - <description> - </description> - </method> - <method name="track_remove_key_at_pos"> - <argument index="0" name="idx" type="int"> - </argument> - <argument index="1" name="pos" type="real"> - </argument> - <description> - </description> - </method> - <method name="track_set_key_value"> - <argument index="0" name="idx" type="int"> - </argument> - <argument index="1" name="key" type="int"> - </argument> - <argument index="2" name="value" type="var"> - </argument> - <description> - </description> - </method> - <method name="track_set_key_transition"> - <argument index="0" name="idx" type="int"> - </argument> - <argument index="1" name="key_idx" type="int"> - </argument> - <argument index="2" name="transition" type="real"> - </argument> - <description> - </description> - </method> - <method name="track_get_key_transition" qualifiers="const"> - <return type="real"> - </return> - <argument index="0" name="idx" type="int"> - </argument> - <argument index="1" name="key_idx" type="int"> - </argument> - <description> - </description> - </method> - <method name="track_get_key_count" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="idx" type="int"> - </argument> - <description> - </description> - </method> - <method name="track_get_key_value" qualifiers="const"> - <argument index="0" name="idx" type="int"> - </argument> - <argument index="1" name="key_idx" type="int"> - </argument> - <description> - </description> - </method> - <method name="track_get_key_time" qualifiers="const"> - <return type="real"> - </return> - <argument index="0" name="idx" type="int"> - </argument> - <argument index="1" name="key_idx" type="int"> - </argument> - <description> - </description> - </method> - <method name="track_find_key" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="idx" type="int"> - </argument> - <argument index="1" name="time" type="real"> - </argument> - <argument index="2" name="exact" type="bool" default="false"> - </argument> - <description> - </description> - </method> - <method name="track_set_interpolation_type"> - <argument index="0" name="idx" type="int"> - </argument> - <argument index="1" name="interpolation" type="int"> - </argument> - <description> - </description> - </method> - <method name="track_get_interpolation_type" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="idx" type="int"> - </argument> - <description> - </description> - </method> - <method name="transform_track_interpolate" qualifiers="const"> - <return type="Array"> - </return> - <argument index="0" name="idx" type="int"> - </argument> - <argument index="1" name="time_sec" type="real"> - </argument> - <description> - </description> - </method> - <method name="value_track_set_continuous"> - <argument index="0" name="idx" type="int"> - </argument> - <argument index="1" name="continuous" type="bool"> - </argument> - <description> - </description> - </method> - <method name="value_track_is_continuous" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="idx" type="int"> - </argument> - <description> - </description> - </method> - <method name="value_track_get_key_indices" qualifiers="const"> - <return type="IntArray"> - </return> - <argument index="0" name="idx" type="int"> - </argument> - <argument index="1" name="time_sec" type="real"> - </argument> - <argument index="2" name="delta" type="real"> - </argument> - <description> - </description> - </method> - <method name="method_track_get_key_indices" qualifiers="const"> - <return type="IntArray"> - </return> - <argument index="0" name="idx" type="int"> - </argument> - <argument index="1" name="time_sec" type="real"> - </argument> - <argument index="2" name="delta" type="real"> - </argument> - <description> - </description> - </method> - <method name="method_track_get_name" qualifiers="const"> - <return type="String"> - </return> - <argument index="0" name="idx" type="int"> - </argument> - <argument index="1" name="key_idx" type="int"> - </argument> - <description> - </description> - </method> - <method name="method_track_get_params" qualifiers="const"> - <return type="Array"> - </return> - <argument index="0" name="idx" type="int"> - </argument> - <argument index="1" name="key_idx" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_length"> - <argument index="0" name="time_sec" type="real"> - </argument> - <description> - </description> - </method> - <method name="get_length" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - <method name="set_loop"> - <argument index="0" name="enabled" type="bool"> - </argument> - <description> - </description> - </method> - <method name="has_loop" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="clear"> - <description> - </description> - </method> - </methods> - <constants> - <constant name="TYPE_TRANSFORM" value="0"> - </constant> - <constant name="TYPE_VALUE" value="1"> - </constant> - <constant name="TYPE_METHOD" value="2"> - </constant> - <constant name="INTERPOLATION_NEAREST" value="0"> - </constant> - <constant name="INTERPOLATION_LINEAR" value="1"> - </constant> - <constant name="INTERPOLATION_CUBIC" value="2"> - </constant> - </constants> -</class> -<class name="AnimationPlayer" inherits="Node" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="add_animation"> - <return type="int"> - </return> - <argument index="0" name="name" type="String"> - </argument> - <argument index="1" name="animation" type="Animation"> - </argument> - <description> - </description> - </method> - <method name="remove_animation"> - <argument index="0" name="name" type="String"> - </argument> - <description> - </description> - </method> - <method name="rename_animation"> - <argument index="0" name="name" type="String"> - </argument> - <argument index="1" name="newname" type="String"> - </argument> - <description> - </description> - </method> - <method name="has_animation" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="name" type="String"> - </argument> - <description> - </description> - </method> - <method name="get_animation" qualifiers="const"> - <return type="Animation"> - </return> - <argument index="0" name="name" type="String"> - </argument> - <description> - </description> - </method> - <method name="get_animation_list" qualifiers="const"> - <return type="StringArray"> - </return> - <description> - </description> - </method> - <method name="set_blend_time"> - <argument index="0" name="anim_from" type="String"> - </argument> - <argument index="1" name="anim_to" type="String"> - </argument> - <argument index="2" name="sec" type="real"> - </argument> - <description> - </description> - </method> - <method name="get_blend_time" qualifiers="const"> - <return type="real"> - </return> - <argument index="0" name="anim_from" type="String"> - </argument> - <argument index="1" name="anim_to" type="String"> - </argument> - <description> - </description> - </method> - <method name="play"> - <argument index="0" name="name" type="String" default=""""> - </argument> - <description> - </description> - </method> - <method name="stop"> - <description> - </description> - </method> - <method name="stop_all"> - <description> - </description> - </method> - <method name="is_playing" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_current_animation"> - <argument index="0" name="anim" type="String"> - </argument> - <description> - </description> - </method> - <method name="get_current_animation" qualifiers="const"> - <return type="String"> - </return> - <description> - </description> - </method> - <method name="queue"> - <argument index="0" name="name" type="String"> - </argument> - <description> - </description> - </method> - <method name="set_pause"> - <argument index="0" name="paused" type="bool"> - </argument> - <description> - </description> - </method> - <method name="is_paused" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_speed"> - <argument index="0" name="speed" type="real"> - </argument> - <description> - </description> - </method> - <method name="get_speed" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - <method name="set_autoplay"> - <argument index="0" name="name" type="String"> - </argument> - <description> - </description> - </method> - <method name="get_autoplay" qualifiers="const"> - <return type="String"> - </return> - <description> - </description> - </method> - <method name="seek"> - <argument index="0" name="pos_sec" type="real"> - </argument> - <argument index="1" name="update" type="bool" default="false"> - </argument> - <description> - </description> - </method> - <method name="get_pos" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - <method name="find_animation" qualifiers="const"> - <return type="String"> - </return> - <argument index="0" name="animation" type="Animation"> - </argument> - <description> - </description> - </method> - <method name="clear_caches"> - <description> - </description> - </method> - <method name="set_animation_process_mode"> - <argument index="0" name="mode" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_animation_process_mode" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - </methods> - <signals> - <signal name="finished"> - <description> - </description> - </signal> - </signals> - <constants> - <constant name="ANIMATION_PROCESS_FIXED" value="0"> - </constant> - <constant name="ANIMATION_PROCESS_IDLE" value="1"> - </constant> - </constants> -</class> -<class name="AnimationTreePlayer" inherits="Node" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="add_node"> - <argument index="0" name="type" type="int"> - </argument> - <argument index="1" name="id" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_node_id" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="name" type="String"> - </argument> - <description> - </description> - </method> - <method name="node_set_name"> - <argument index="0" name="id" type="int"> - </argument> - <argument index="1" name="name" type="String"> - </argument> - <description> - </description> - </method> - <method name="node_get_name" qualifiers="const"> - <return type="String"> - </return> - <argument index="0" name="id" type="int"> - </argument> - <description> - </description> - </method> - <method name="node_get_type" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="id" type="int"> - </argument> - <description> - </description> - </method> - <method name="node_get_input_count" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="id" type="int"> - </argument> - <description> - </description> - </method> - <method name="animation_node_set_animation"> - <argument index="0" name="id" type="int"> - </argument> - <argument index="1" name="animation" type="Animation"> - </argument> - <description> - </description> - </method> - <method name="animation_node_get_animation" qualifiers="const"> - <return type="Animation"> - </return> - <argument index="0" name="id" type="int"> - </argument> - <description> - </description> - </method> - <method name="oneshot_node_set_fadein_time"> - <argument index="0" name="id" type="int"> - </argument> - <argument index="1" name="time_sec" type="real"> - </argument> - <description> - </description> - </method> - <method name="oneshot_node_get_fadein_time" qualifiers="const"> - <return type="real"> - </return> - <argument index="0" name="id" type="int"> - </argument> - <description> - </description> - </method> - <method name="oneshot_node_set_fadeout_time"> - <argument index="0" name="id" type="int"> - </argument> - <argument index="1" name="time_sec" type="real"> - </argument> - <description> - </description> - </method> - <method name="oneshot_node_get_fadeout_time" qualifiers="const"> - <return type="real"> - </return> - <argument index="0" name="id" type="int"> - </argument> - <description> - </description> - </method> - <method name="oneshot_node_set_autorestart"> - <argument index="0" name="id" type="int"> - </argument> - <argument index="1" name="enable" type="bool"> - </argument> - <description> - </description> - </method> - <method name="oneshot_node_set_autorestart_delay"> - <argument index="0" name="id" type="int"> - </argument> - <argument index="1" name="delay_sec" type="real"> - </argument> - <description> - </description> - </method> - <method name="oneshot_node_set_autorestart_random_delay"> - <argument index="0" name="id" type="int"> - </argument> - <argument index="1" name="rand_sec" type="real"> - </argument> - <description> - </description> - </method> - <method name="oneshot_node_has_autorestart" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="id" type="int"> - </argument> - <description> - </description> - </method> - <method name="oneshot_node_get_autorestart_delay" qualifiers="const"> - <return type="real"> - </return> - <argument index="0" name="id" type="int"> - </argument> - <description> - </description> - </method> - <method name="oneshot_node_get_autorestart_random_delay" qualifiers="const"> - <return type="real"> - </return> - <argument index="0" name="id" type="int"> - </argument> - <description> - </description> - </method> - <method name="oneshot_node_start"> - <argument index="0" name="id" type="int"> - </argument> - <description> - </description> - </method> - <method name="oneshot_node_stop"> - <argument index="0" name="id" type="int"> - </argument> - <description> - </description> - </method> - <method name="oneshot_node_is_active" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="id" type="int"> - </argument> - <description> - </description> - </method> - <method name="mix_node_set_amount"> - <argument index="0" name="id" type="int"> - </argument> - <argument index="1" name="ratio" type="real"> - </argument> - <description> - </description> - </method> - <method name="mix_node_get_amount" qualifiers="const"> - <return type="real"> - </return> - <argument index="0" name="id" type="int"> - </argument> - <description> - </description> - </method> - <method name="blend2_node_set_amount"> - <argument index="0" name="id" type="int"> - </argument> - <argument index="1" name="blend" type="real"> - </argument> - <description> - </description> - </method> - <method name="blend2_node_get_amount" qualifiers="const"> - <return type="real"> - </return> - <argument index="0" name="id" type="int"> - </argument> - <description> - </description> - </method> - <method name="blend3_node_set_amount"> - <argument index="0" name="id" type="int"> - </argument> - <argument index="1" name="blend" type="real"> - </argument> - <description> - </description> - </method> - <method name="blend3_node_get_amount" qualifiers="const"> - <return type="real"> - </return> - <argument index="0" name="id" type="int"> - </argument> - <description> - </description> - </method> - <method name="blend4_node_set_amount"> - <argument index="0" name="id" type="int"> - </argument> - <argument index="1" name="blend" type="Vector2"> - </argument> - <description> - </description> - </method> - <method name="blend4_node_get_amount" qualifiers="const"> - <return type="Vector2"> - </return> - <argument index="0" name="id" type="int"> - </argument> - <description> - </description> - </method> - <method name="timescale_node_set_scale"> - <argument index="0" name="id" type="int"> - </argument> - <argument index="1" name="scale" type="real"> - </argument> - <description> - </description> - </method> - <method name="timescale_node_get_scale" qualifiers="const"> - <return type="real"> - </return> - <argument index="0" name="id" type="int"> - </argument> - <description> - </description> - </method> - <method name="timeseek_node_seek"> - <argument index="0" name="id" type="int"> - </argument> - <argument index="1" name="pos_sec" type="real"> - </argument> - <description> - </description> - </method> - <method name="transition_node_set_input_count"> - <argument index="0" name="id" type="int"> - </argument> - <argument index="1" name="count" type="int"> - </argument> - <description> - </description> - </method> - <method name="transition_node_get_input_count" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="id" type="int"> - </argument> - <description> - </description> - </method> - <method name="transition_node_delete_input"> - <argument index="0" name="id" type="int"> - </argument> - <argument index="1" name="input_idx" type="int"> - </argument> - <description> - </description> - </method> - <method name="transition_node_set_input_auto_advance"> - <argument index="0" name="id" type="int"> - </argument> - <argument index="1" name="input_idx" type="int"> - </argument> - <argument index="2" name="enable" type="bool"> - </argument> - <description> - </description> - </method> - <method name="transition_node_has_input_auto_advance" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="id" type="int"> - </argument> - <argument index="1" name="input_idx" type="int"> - </argument> - <description> - </description> - </method> - <method name="transition_node_set_xfade_time"> - <argument index="0" name="id" type="int"> - </argument> - <argument index="1" name="time_sec" type="real"> - </argument> - <description> - </description> - </method> - <method name="transition_node_get_xfade_time" qualifiers="const"> - <return type="real"> - </return> - <argument index="0" name="id" type="int"> - </argument> - <description> - </description> - </method> - <method name="transition_node_set_current"> - <argument index="0" name="id" type="int"> - </argument> - <argument index="1" name="input_idx" type="int"> - </argument> - <description> - </description> - </method> - <method name="transition_node_get_current" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="id" type="int"> - </argument> - <description> - </description> - </method> - <method name="node_set_pos"> - <argument index="0" name="id" type="int"> - </argument> - <argument index="1" name="screen_pos" type="Vector2"> - </argument> - <description> - </description> - </method> - <method name="node_get_pos" qualifiers="const"> - <return type="Vector2"> - </return> - <argument index="0" name="id" type="int"> - </argument> - <description> - </description> - </method> - <method name="remove_node"> - <argument index="0" name="id" type="int"> - </argument> - <description> - </description> - </method> - <method name="connect"> - <return type="int"> - </return> - <argument index="0" name="id" type="int"> - </argument> - <argument index="1" name="dst_id" type="int"> - </argument> - <argument index="2" name="dst_input_idx" type="int"> - </argument> - <description> - </description> - </method> - <method name="is_connected" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="id" type="int"> - </argument> - <argument index="1" name="dst_id" type="int"> - </argument> - <argument index="2" name="dst_input_idx" type="int"> - </argument> - <description> - </description> - </method> - <method name="disconnect"> - <argument index="0" name="id" type="int"> - </argument> - <argument index="1" name="dst_input_idx" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_active"> - <argument index="0" name="enabled" type="bool"> - </argument> - <description> - </description> - </method> - <method name="is_active" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_base_path"> - <argument index="0" name="path" type="NodePath"> - </argument> - <description> - </description> - </method> - <method name="get_base_path" qualifiers="const"> - <return type="NodePath"> - </return> - <description> - </description> - </method> - <method name="get_node_list"> - <return type="IntArray"> - </return> - <description> - </description> - </method> - <method name="reset"> - <description> - </description> - </method> - <method name="recompute_caches"> - <description> - </description> - </method> - </methods> - <constants> - <constant name="NODE_OUTPUT" value="0"> - </constant> - <constant name="NODE_ANIMATION" value="1"> - </constant> - <constant name="NODE_ONESHOT" value="2"> - </constant> - <constant name="NODE_MIX" value="3"> - </constant> - <constant name="NODE_BLEND2" value="4"> - </constant> - <constant name="NODE_BLEND3" value="5"> - </constant> - <constant name="NODE_BLEND4" value="6"> - </constant> - <constant name="NODE_TIMESCALE" value="7"> - </constant> - <constant name="NODE_TIMESEEK" value="8"> - </constant> - <constant name="NODE_TRANSITION" value="9"> - </constant> - </constants> -</class> -<class name="Area2D" inherits="CollisionObject2D" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="set_override_space_params"> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - </description> - </method> - <method name="is_overriding_space_params" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_gravity_is_point"> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - </description> - </method> - <method name="is_gravity_a_point" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_gravity_vector"> - <argument index="0" name="vector" type="Vector2"> - </argument> - <description> - </description> - </method> - <method name="get_gravity_vector" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - </description> - </method> - <method name="set_gravity"> - <argument index="0" name="gravity" type="real"> - </argument> - <description> - </description> - </method> - <method name="get_gravity" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - <method name="set_density"> - <argument index="0" name="density" type="real"> - </argument> - <description> - </description> - </method> - <method name="get_density" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - <method name="set_priority"> - <argument index="0" name="priority" type="real"> - </argument> - <description> - </description> - </method> - <method name="get_priority" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - <method name="set_enable_monitoring"> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - </description> - </method> - <method name="is_monitoring_enabled" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - </methods> - <signals> - <signal name="body_enter"> - <argument index="0" name="body_id" type="int"> - </argument> - <argument index="1" name="body" type="Object"> - </argument> - <description> - </description> - </signal> - <signal name="body_enter_shape"> - <argument index="0" name="body_id" type="int"> - </argument> - <argument index="1" name="body" type="Object"> - </argument> - <argument index="2" name="body_shape" type="int"> - </argument> - <argument index="3" name="area_shape" type="int"> - </argument> - <description> - </description> - </signal> - <signal name="body_exit"> - <argument index="0" name="body_id" type="int"> - </argument> - <argument index="1" name="body" type="Object"> - </argument> - <description> - </description> - </signal> - <signal name="body_exit_shape"> - <argument index="0" name="body_id" type="int"> - </argument> - <argument index="1" name="body" type="Object"> - </argument> - <argument index="2" name="body_shape" type="int"> - </argument> - <argument index="3" name="area_shape" type="int"> - </argument> - <description> - </description> - </signal> - </signals> - <constants> - </constants> -</class> -<class name="AudioServer" inherits="Object" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="sample_create"> - <return type="RID"> - </return> - <argument index="0" name="format" type="int"> - </argument> - <argument index="1" name="stereo" type="bool"> - </argument> - <argument index="2" name="length" type="int"> - </argument> - <description> - </description> - </method> - <method name="sample_set_description"> - <argument index="0" name="sample" type="RID"> - </argument> - <argument index="1" name="description" type="String"> - </argument> - <description> - </description> - </method> - <method name="sample_get_description" qualifiers="const"> - <return type="String"> - </return> - <argument index="0" name="sample" type="RID"> - </argument> - <argument index="1" name="arg1" type="String"> - </argument> - <description> - </description> - </method> - <method name="sample_get_format" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="sample" type="RID"> - </argument> - <description> - </description> - </method> - <method name="sample_is_stereo" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="sample" type="RID"> - </argument> - <description> - </description> - </method> - <method name="sample_get_length" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="sample" type="RID"> - </argument> - <description> - </description> - </method> - <method name="sample_set_signed_data"> - <argument index="0" name="sample" type="RID"> - </argument> - <argument index="1" name="data" type="RealArray"> - </argument> - <description> - </description> - </method> - <method name="sample_set_data"> - <argument index="0" name="sample" type="RID"> - </argument> - <argument index="1" name="arg1" type="RawArray"> - </argument> - <description> - </description> - </method> - <method name="sample_get_data" qualifiers="const"> - <return type="RawArray"> - </return> - <argument index="0" name="sample" type="RID"> - </argument> - <description> - </description> - </method> - <method name="sample_set_mix_rate"> - <argument index="0" name="sample" type="RID"> - </argument> - <argument index="1" name="mix_rate" type="int"> - </argument> - <description> - </description> - </method> - <method name="sample_get_mix_rate" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="sample" type="RID"> - </argument> - <description> - </description> - </method> - <method name="sample_set_loop_format"> - <argument index="0" name="sample" type="RID"> - </argument> - <argument index="1" name="loop_format" type="int"> - </argument> - <description> - </description> - </method> - <method name="sample_get_loop_format" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="sample" type="RID"> - </argument> - <description> - </description> - </method> - <method name="sample_set_loop_begin"> - <argument index="0" name="sample" type="RID"> - </argument> - <argument index="1" name="pos" type="int"> - </argument> - <description> - </description> - </method> - <method name="sample_get_loop_begin" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="sample" type="RID"> - </argument> - <description> - </description> - </method> - <method name="sample_set_loop_end"> - <argument index="0" name="sample" type="RID"> - </argument> - <argument index="1" name="pos" type="int"> - </argument> - <description> - </description> - </method> - <method name="sample_get_loop_end" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="sample" type="RID"> - </argument> - <description> - </description> - </method> - <method name="voice_create"> - <return type="RID"> - </return> - <description> - </description> - </method> - <method name="voice_play"> - <argument index="0" name="voice" type="RID"> - </argument> - <argument index="1" name="sample" type="RID"> - </argument> - <description> - </description> - </method> - <method name="voice_set_volume"> - <argument index="0" name="voice" type="RID"> - </argument> - <argument index="1" name="volume" type="real"> - </argument> - <description> - </description> - </method> - <method name="voice_set_pan"> - <argument index="0" name="voice" type="RID"> - </argument> - <argument index="1" name="pan" type="real"> - </argument> - <argument index="2" name="depth" type="real" default="0"> - </argument> - <argument index="3" name="height" type="real" default="0"> - </argument> - <description> - </description> - </method> - <method name="voice_set_filter"> - <argument index="0" name="voice" type="RID"> - </argument> - <argument index="1" name="type" type="int"> - </argument> - <argument index="2" name="cutoff" type="real"> - </argument> - <argument index="3" name="resonance" type="real"> - </argument> - <argument index="4" name="gain" type="real" default="0"> - </argument> - <description> - </description> - </method> - <method name="voice_set_chorus"> - <argument index="0" name="voice" type="RID"> - </argument> - <argument index="1" name="chorus" type="real"> - </argument> - <description> - </description> - </method> - <method name="voice_set_reverb"> - <argument index="0" name="voice" type="RID"> - </argument> - <argument index="1" name="room" type="int"> - </argument> - <argument index="2" name="reverb" type="real"> - </argument> - <description> - </description> - </method> - <method name="voice_set_mix_rate"> - <argument index="0" name="voice" type="RID"> - </argument> - <argument index="1" name="rate" type="int"> - </argument> - <description> - </description> - </method> - <method name="voice_set_positional"> - <argument index="0" name="voice" type="RID"> - </argument> - <argument index="1" name="enabled" type="bool"> - </argument> - <description> - </description> - </method> - <method name="voice_get_volume" qualifiers="const"> - <return type="real"> - </return> - <argument index="0" name="voice" type="RID"> - </argument> - <description> - </description> - </method> - <method name="voice_get_pan" qualifiers="const"> - <return type="real"> - </return> - <argument index="0" name="voice" type="RID"> - </argument> - <description> - </description> - </method> - <method name="voice_get_pan_height" qualifiers="const"> - <return type="real"> - </return> - <argument index="0" name="voice" type="RID"> - </argument> - <description> - </description> - </method> - <method name="voice_get_pan_depth" qualifiers="const"> - <return type="real"> - </return> - <argument index="0" name="voice" type="RID"> - </argument> - <description> - </description> - </method> - <method name="voice_get_filter_type" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="voice" type="RID"> - </argument> - <description> - </description> - </method> - <method name="voice_get_filter_cutoff" qualifiers="const"> - <return type="real"> - </return> - <argument index="0" name="voice" type="RID"> - </argument> - <description> - </description> - </method> - <method name="voice_get_filter_resonance" qualifiers="const"> - <return type="real"> - </return> - <argument index="0" name="voice" type="RID"> - </argument> - <description> - </description> - </method> - <method name="voice_get_chorus" qualifiers="const"> - <return type="real"> - </return> - <argument index="0" name="voice" type="RID"> - </argument> - <description> - </description> - </method> - <method name="voice_get_reverb_type" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="voice" type="RID"> - </argument> - <description> - </description> - </method> - <method name="voice_get_reverb" qualifiers="const"> - <return type="real"> - </return> - <argument index="0" name="voice" type="RID"> - </argument> - <description> - </description> - </method> - <method name="voice_get_mix_rate" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="voice" type="RID"> - </argument> - <description> - </description> - </method> - <method name="voice_is_positional" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="voice" type="RID"> - </argument> - <description> - </description> - </method> - <method name="voice_stop"> - <argument index="0" name="voice" type="RID"> - </argument> - <description> - </description> - </method> - <method name="free_rid"> - <argument index="0" name="rid" type="RID"> - </argument> - <description> - </description> - </method> - <method name="set_stream_global_volume_scale"> - <argument index="0" name="scale" type="real"> - </argument> - <description> - </description> - </method> - <method name="get_stream_global_volume_scale" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - <method name="set_mixer_global_volume_scale"> - <argument index="0" name="scale" type="real"> - </argument> - <description> - </description> - </method> - <method name="get_mixer_global_volume_scale" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - </methods> - <constants> - <constant name="SAMPLE_FORMAT_PCM8" value="0"> - </constant> - <constant name="SAMPLE_FORMAT_PCM16" value="1"> - </constant> - <constant name="SAMPLE_FORMAT_IMA_ADPCM" value="2"> - </constant> - <constant name="SAMPLE_LOOP_NONE" value="0"> - </constant> - <constant name="SAMPLE_LOOP_FORWARD" value="1"> - </constant> - <constant name="SAMPLE_LOOP_PING_PONG" value="2"> - </constant> - <constant name="FILTER_NONE" value="0"> - </constant> - <constant name="FILTER_LOWPASS" value="1"> - </constant> - <constant name="FILTER_BANDPASS" value="2"> - </constant> - <constant name="FILTER_HIPASS" value="3"> - </constant> - <constant name="FILTER_NOTCH" value="4"> - </constant> - <constant name="FILTER_BANDLIMIT" value="6"> - </constant> - <constant name="REVERB_SMALL" value="0"> - </constant> - <constant name="REVERB_MEDIUM" value="1"> - </constant> - <constant name="REVERB_LARGE" value="2"> - </constant> - <constant name="REVERB_HALL" value="3"> - </constant> - </constants> -</class> -<class name="AudioServerSW" inherits="AudioServer" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - </methods> - <constants> - </constants> -</class> -<class name="AudioStream" inherits="Resource" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="play"> - <description> - </description> - </method> - <method name="stop"> - <description> - </description> - </method> - <method name="is_playing" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_loop"> - <argument index="0" name="enabled" type="bool"> - </argument> - <description> - </description> - </method> - <method name="has_loop" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="get_stream_name" qualifiers="const"> - <return type="String"> - </return> - <description> - </description> - </method> - <method name="get_loop_count" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="seek_pos"> - <argument index="0" name="pos" type="real"> - </argument> - <description> - </description> - </method> - <method name="get_pos" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - <method name="get_length" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - <method name="get_update_mode" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="update"> - <description> - </description> - </method> - </methods> - <constants> - <constant name="UPDATE_NONE" value="0"> - </constant> - <constant name="UPDATE_IDLE" value="1"> - </constant> - <constant name="UPDATE_THREAD" value="2"> - </constant> - </constants> -</class> -<class name="AudioStreamGibberish" inherits="AudioStream" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="set_phonemes"> - <argument index="0" name="phonemes" type="Object"> - </argument> - <description> - </description> - </method> - <method name="get_phonemes" qualifiers="const"> - <return type="Object"> - </return> - <description> - </description> - </method> - <method name="set_pitch_scale"> - <argument index="0" name="pitch_scale" type="real"> - </argument> - <description> - </description> - </method> - <method name="get_pitch_scale" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - <method name="set_pitch_random_scale"> - <argument index="0" name="pitch_random_scale" type="real"> - </argument> - <description> - </description> - </method> - <method name="get_pitch_random_scale" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - <method name="set_xfade_time"> - <argument index="0" name="sec" type="real"> - </argument> - <description> - </description> - </method> - <method name="get_xfade_time" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - </methods> - <constants> - </constants> -</class> -<class name="AudioStreamMPC" inherits="AudioStreamResampled" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="set_file"> - <argument index="0" name="name" type="String"> - </argument> - <description> - </description> - </method> - <method name="get_file" qualifiers="const"> - <return type="String"> - </return> - <description> - </description> - </method> - </methods> - <constants> - </constants> -</class> -<class name="AudioStreamOGGVorbis" inherits="AudioStreamResampled" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - </methods> - <constants> - </constants> -</class> -<class name="AudioStreamResampled" inherits="AudioStream" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - </methods> - <constants> - </constants> -</class> -<class name="AudioStreamSpeex" inherits="AudioStreamResampled" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="set_file"> - <argument index="0" name="file" type="String"> - </argument> - <description> - </description> - </method> - <method name="get_file" qualifiers="const"> - <return type="String"> - </return> - <description> - </description> - </method> - </methods> - <constants> - </constants> -</class> -<class name="BCSFX" inherits="ScenarioFX" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - </methods> - <constants> - </constants> -</class> -<class name="BGColorFX" inherits="ScenarioFX" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - </methods> - <constants> - </constants> -</class> -<class name="BGImageFX" inherits="ScenarioFX" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - </methods> - <constants> - </constants> -</class> -<class name="BaseButton" inherits="Control" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="set_pressed"> - <argument index="0" name="pressed" type="bool"> - </argument> - <description> - </description> - </method> - <method name="is_pressed" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_toggle_mode"> - <argument index="0" name="enabled" type="bool"> - </argument> - <description> - </description> - </method> - <method name="is_toggle_mode" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_disabled"> - <argument index="0" name="disabled" type="bool"> - </argument> - <description> - </description> - </method> - <method name="is_disabled" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_click_on_press"> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - </description> - </method> - <method name="get_click_on_press" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - </methods> - <signals> - <signal name="toggled"> - <argument index="0" name="pressed" type="bool"> - </argument> - <description> - </description> - </signal> - <signal name="pressed"> - <description> - </description> - </signal> - </signals> - <constants> - </constants> -</class> -<class name="BodyShape" inherits="Spatial" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - </methods> - <constants> - </constants> -</class> -<class name="BoxContainer" inherits="Container" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - </methods> - <constants> - </constants> -</class> -<class name="BoxShape" inherits="Shape" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="set_extents"> - <argument index="0" name="extents" type="Vector3"> - </argument> - <description> - </description> - </method> - <method name="get_extents" qualifiers="const"> - <return type="Vector3"> - </return> - <description> - </description> - </method> - </methods> - <constants> - </constants> -</class> -<class name="Button" inherits="BaseButton" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="set_text"> - <argument index="0" name="text" type="String"> - </argument> - <description> - </description> - </method> - <method name="get_text" qualifiers="const"> - <return type="String"> - </return> - <description> - </description> - </method> - <method name="set_icon"> - <argument index="0" name="texture" type="Texture"> - </argument> - <description> - </description> - </method> - <method name="get_icon" qualifiers="const"> - <return type="Texture"> - </return> - <description> - </description> - </method> - <method name="set_flat"> - <argument index="0" name="enabled" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_clip_text"> - <argument index="0" name="enabled" type="bool"> - </argument> - <description> - </description> - </method> - <method name="get_clip_text" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="is_flat" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - </methods> - <constants> - </constants> -</class> -<class name="ButtonArray" inherits="Control" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="add_button"> - <argument index="0" name="text" type="String"> - </argument> - <description> - </description> - </method> - <method name="add_icon_button"> - <argument index="0" name="icon" type="Object"> - </argument> - <argument index="1" name="text" type="String" default=""""> - </argument> - <description> - </description> - </method> - <method name="set_button_text"> - <argument index="0" name="button" type="int"> - </argument> - <argument index="1" name="text" type="String"> - </argument> - <description> - </description> - </method> - <method name="set_button_icon"> - <argument index="0" name="button" type="int"> - </argument> - <argument index="1" name="icon" type="Object"> - </argument> - <description> - </description> - </method> - <method name="get_button_text" qualifiers="const"> - <return type="String"> - </return> - <argument index="0" name="button" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_button_icon" qualifiers="const"> - <return type="Object"> - </return> - <argument index="0" name="button" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_button_count" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="get_selected" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="get_hovered" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="set_selected"> - <argument index="0" name="button" type="int"> - </argument> - <description> - </description> - </method> - <method name="erase_button"> - <argument index="0" name="button" type="int"> - </argument> - <description> - </description> - </method> - <method name="clear"> - <description> - </description> - </method> - </methods> - <signals> - <signal name="button_selected"> - <argument index="0" name="button" type="int"> - </argument> - <description> - </description> - </signal> - </signals> - <constants> - <constant name="ALIGN_BEGIN" value="0"> - </constant> - <constant name="ALIGN_CENTER" value="1"> - </constant> - <constant name="ALIGN_END" value="2"> - </constant> - <constant name="ALIGN_FILL" value="3"> - </constant> - <constant name="ALIGN_EXPAND_FILL" value="4"> - </constant> - </constants> -</class> -<class name="ButtonGroup" inherits="Control" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="get_pressed_button" qualifiers="const"> - <return type="BaseButton"> - </return> - <description> - </description> - </method> - <method name="get_pressed_button_index" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="get_focused_button" qualifiers="const"> - <return type="BaseButton"> - </return> - <description> - </description> - </method> - <method name="get_button_list" qualifiers="const"> - <return type="Array"> - </return> - <description> - </description> - </method> - <method name="set_pressed_button"> - <argument index="0" name="button" type="BaseButton"> - </argument> - <description> - </description> - </method> - </methods> - <constants> - </constants> -</class> -<class name="Camera" inherits="Spatial" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="project_ray_normal" qualifiers="const"> - <return type="Vector3"> - </return> - <argument index="0" name="screen_point" type="Vector2"> - </argument> - <description> - </description> - </method> - <method name="project_local_ray_normal" qualifiers="const"> - <return type="Vector3"> - </return> - <argument index="0" name="screen_point" type="Vector2"> - </argument> - <description> - </description> - </method> - <method name="project_ray_origin" qualifiers="const"> - <return type="Vector3"> - </return> - <argument index="0" name="screen_point" type="Vector2"> - </argument> - <description> - </description> - </method> - <method name="unproject_position" qualifiers="const"> - <return type="Vector2"> - </return> - <argument index="0" name="world_point" type="Vector3"> - </argument> - <description> - </description> - </method> - <method name="project_position" qualifiers="const"> - <return type="Vector3"> - </return> - <argument index="0" name="screen_point" type="Vector2"> - </argument> - <description> - </description> - </method> - <method name="set_perspective"> - <argument index="0" name="fov" type="real"> - </argument> - <argument index="1" name="z_near" type="real"> - </argument> - <argument index="2" name="z_far" type="real"> - </argument> - <description> - </description> - </method> - <method name="set_orthogonal"> - <argument index="0" name="size" type="real"> - </argument> - <argument index="1" name="z_near" type="real"> - </argument> - <argument index="2" name="z_far" type="real"> - </argument> - <description> - </description> - </method> - <method name="make_current"> - <description> - </description> - </method> - <method name="clear_current"> - <description> - </description> - </method> - <method name="is_current" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="get_camera_transform" qualifiers="const"> - <return type="Transform"> - </return> - <description> - </description> - </method> - <method name="get_fov" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - <method name="get_size" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - <method name="get_zfar" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - <method name="get_znear" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - <method name="get_projection" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - </methods> - <constants> - <constant name="PROJECTION_PERSPECTIVE" value="0"> - </constant> - <constant name="PROJECTION_ORTHOGONAL" value="1"> - </constant> - </constants> -</class> -<class name="Camera2D" inherits="ScreenProximity2D" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="set_offset"> - <argument index="0" name="offset" type="Vector2"> - </argument> - <description> - </description> - </method> - <method name="get_offset" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - </description> - </method> - <method name="set_centered"> - <argument index="0" name="centered" type="bool"> - </argument> - <description> - </description> - </method> - <method name="is_centered" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="make_current"> - <description> - </description> - </method> - <method name="is_current" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_limit"> - <argument index="0" name="margin" type="int"> - </argument> - <argument index="1" name="limit" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_limit" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="margin" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_drag_margin"> - <argument index="0" name="margin" type="int"> - </argument> - <argument index="1" name="drag_margin" type="real"> - </argument> - <description> - </description> - </method> - <method name="get_drag_margin" qualifiers="const"> - <return type="real"> - </return> - <argument index="0" name="margin" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_camera_pos" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - </description> - </method> - <method name="force_update_scroll"> - <description> - </description> - </method> - </methods> - <constants> - </constants> -</class> -<class name="CanvasItem" inherits="Node" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="edit_set_state"> - <argument index="0" name="state" type="var"> - </argument> - <description> - </description> - </method> - <method name="edit_get" qualifiers="const"> - <description> - </description> - </method> - <method name="edit_set_rect"> - <argument index="0" name="rect" type="Rect2"> - </argument> - <description> - </description> - </method> - <method name="edit_rotate"> - <argument index="0" name="degrees" type="real"> - </argument> - <description> - </description> - </method> - <method name="get_item_rect" qualifiers="const"> - <return type="Rect2"> - </return> - <description> - </description> - </method> - <method name="get_canvas_item" qualifiers="const"> - <return type="RID"> - </return> - <description> - </description> - </method> - <method name="is_visible" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="is_hidden" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="show"> - <description> - </description> - </method> - <method name="hide"> - <description> - </description> - </method> - <method name="update"> - <description> - </description> - </method> - <method name="set_as_toplevel"> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - </description> - </method> - <method name="is_set_as_toplevel" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_blend_mode"> - <argument index="0" name="blend_mode" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_blend_mode" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="set_opacity"> - <argument index="0" name="opacity" type="real"> - </argument> - <description> - </description> - </method> - <method name="get_opacity" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - <method name="set_self_opacity"> - <argument index="0" name="self_opacity" type="real"> - </argument> - <description> - </description> - </method> - <method name="get_self_opacity" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - <method name="draw_line"> - <argument index="0" name="from" type="Vector2"> - </argument> - <argument index="1" name="to" type="Vector2"> - </argument> - <argument index="2" name="color" type="Color"> - </argument> - <argument index="3" name="width" type="real" default="1"> - </argument> - <description> - </description> - </method> - <method name="draw_rect"> - <argument index="0" name="rect" type="Rect2"> - </argument> - <argument index="1" name="color" type="Color"> - </argument> - <description> - </description> - </method> - <method name="draw_circle"> - <argument index="0" name="pos" type="Vector2"> - </argument> - <argument index="1" name="radius" type="real"> - </argument> - <argument index="2" name="color" type="Color"> - </argument> - <description> - </description> - </method> - <method name="draw_texture"> - <argument index="0" name="texture" type="Texture"> - </argument> - <argument index="1" name="pos" type="Vector2"> - </argument> - <description> - </description> - </method> - <method name="draw_texture_rect"> - <argument index="0" name="texture" type="Texture"> - </argument> - <argument index="1" name="rect" type="Rect2"> - </argument> - <argument index="2" name="tile" type="bool" default="false"> - </argument> - <argument index="3" name="modulate" type="Color" default="Color(1,1,1,1)"> - </argument> - <argument index="4" name="transpose" type="bool" default="false"> - </argument> - <description> - </description> - </method> - <method name="draw_texture_rect_region"> - <argument index="0" name="texture" type="Texture"> - </argument> - <argument index="1" name="rect" type="Rect2"> - </argument> - <argument index="2" name="src_rect" type="Rect2"> - </argument> - <argument index="3" name="modulate" type="Color" default="Color(1,1,1,1)"> - </argument> - <argument index="4" name="transpose" type="bool" default="false"> - </argument> - <description> - </description> - </method> - <method name="draw_style_box"> - <argument index="0" name="style_box" type="StyleBox"> - </argument> - <argument index="1" name="rect" type="Rect2"> - </argument> - <description> - </description> - </method> - <method name="draw_primitive"> - <argument index="0" name="points" type="Vector2Array"> - </argument> - <argument index="1" name="colors" type="ColorArray"> - </argument> - <argument index="2" name="uvs" type="Vector2Array" default="Array()"> - </argument> - <argument index="3" name="texture" type="Texture" default="Object()"> - </argument> - <argument index="4" name="width" type="real" default="1"> - </argument> - <description> - </description> - </method> - <method name="draw_polygon"> - <argument index="0" name="points" type="Vector2Array"> - </argument> - <argument index="1" name="colors" type="ColorArray"> - </argument> - <argument index="2" name="uvs" type="Vector2Array"> - </argument> - <argument index="3" name="texture" type="Texture" default="Array()"> - </argument> - <argument index="4" name="arg4" type="real" default="Object()"> - </argument> - <description> - </description> - </method> - <method name="draw_colored_polygon"> - <argument index="0" name="points" type="Vector2Array"> - </argument> - <argument index="1" name="color" type="ColorArray"> - </argument> - <argument index="2" name="uvs" type="Vector2Array"> - </argument> - <argument index="3" name="texture" type="Texture" default="Array()"> - </argument> - <argument index="4" name="arg4" type="real" default="Object()"> - </argument> - <description> - </description> - </method> - <method name="draw_string"> - <argument index="0" name="font" type="Font"> - </argument> - <argument index="1" name="pos" type="Vector2"> - </argument> - <argument index="2" name="text" type="String"> - </argument> - <argument index="3" name="modulate" type="Color" default="Color(1,1,1,1)"> - </argument> - <argument index="4" name="clip_w" type="int" default="-1"> - </argument> - <description> - </description> - </method> - <method name="draw_char"> - <return type="real"> - </return> - <argument index="0" name="font" type="Font"> - </argument> - <argument index="1" name="pos" type="Vector2"> - </argument> - <argument index="2" name="char" type="String"> - </argument> - <argument index="3" name="next" type="String"> - </argument> - <argument index="4" name="modulate" type="Color" default="Color(1,1,1,1)"> - </argument> - <description> - </description> - </method> - <method name="draw_set_transform"> - <argument index="0" name="pos" type="Vector2"> - </argument> - <argument index="1" name="rot" type="real"> - </argument> - <argument index="2" name="scale" type="Vector2"> - </argument> - <description> - </description> - </method> - <method name="set_transform_notify"> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - </description> - </method> - <method name="is_transform_notify_enabled" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - </methods> - <signals> - <signal name="item_rect_changed"> - <description> - </description> - </signal> - <signal name="draw"> - <description> - </description> - </signal> - <signal name="visibility_changed"> - <description> - </description> - </signal> - <signal name="hide"> - <description> - </description> - </signal> - </signals> - <constants> - <constant name="BLEND_MODE_MIX" value="0"> - </constant> - <constant name="BLEND_MODE_ADD" value="1"> - </constant> - <constant name="BLEND_MODE_SUB" value="2"> - </constant> - <constant name="BLEND_MODE_MUL" value="3"> - </constant> - <constant name="NOTIFICATION_DRAW" value="30"> - </constant> - <constant name="NOTIFICATION_VISIBILITY_CHANGED" value="31"> - </constant> - <constant name="NOTIFICATION_ENTER_CANVAS" value="32"> - </constant> - <constant name="NOTIFICATION_EXIT_CANVAS" value="33"> - </constant> - <constant name="NOTIFICATION_TRANSFORM_CHANGED" value="34"> - </constant> - </constants> -</class> -<class name="CanvasLayer" inherits="Node" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="set_layer"> - <argument index="0" name="layer" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_layer" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="set_transform"> - <argument index="0" name="transform" type="Matrix32"> - </argument> - <description> - </description> - </method> - <method name="get_transform" qualifiers="const"> - <return type="Matrix32"> - </return> - <description> - </description> - </method> - <method name="set_offset"> - <argument index="0" name="offset" type="Vector2"> - </argument> - <description> - </description> - </method> - <method name="get_offset" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - </description> - </method> - <method name="set_rotation"> - <argument index="0" name="rotation" type="real"> - </argument> - <description> - </description> - </method> - <method name="get_rotation" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - <method name="set_scale"> - <argument index="0" name="scale" type="Vector2"> - </argument> - <description> - </description> - </method> - <method name="get_scale" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - </description> - </method> - <method name="get_canvas" qualifiers="const"> - <return type="Canvas"> - </return> - <description> - </description> - </method> - <method name="get_viewport" qualifiers="const"> - <return type="RID"> - </return> - <description> - </description> - </method> - </methods> - <constants> - </constants> -</class> -<class name="CapsuleShape" inherits="Shape" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="set_radius"> - <argument index="0" name="radius" type="real"> - </argument> - <description> - </description> - </method> - <method name="get_radius" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - <method name="set_height"> - <argument index="0" name="height" type="real"> - </argument> - <description> - </description> - </method> - <method name="get_height" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - </methods> - <constants> - </constants> -</class> -<class name="CapsuleShape2D" inherits="Shape2D" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="set_radius"> - <argument index="0" name="radius" type="real"> - </argument> - <description> - </description> - </method> - <method name="get_radius" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - <method name="set_height"> - <argument index="0" name="height" type="real"> - </argument> - <description> - </description> - </method> - <method name="get_height" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - </methods> - <constants> - </constants> -</class> -<class name="CenterContainer" inherits="Container" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - </methods> - <constants> - </constants> -</class> -<class name="CheckButton" inherits="BaseButton" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="set_text"> - <argument index="0" name="text" type="String"> - </argument> - <description> - </description> - </method> - <method name="get_text" qualifiers="const"> - <return type="String"> - </return> - <description> - </description> - </method> - </methods> - <constants> - </constants> -</class> -<class name="CircleShape2D" inherits="Shape2D" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="set_radius"> - <argument index="0" name="radius" type="real"> - </argument> - <description> - </description> - </method> - <method name="get_radius" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - </methods> - <constants> - </constants> -</class> -<class name="CollisionObject2D" inherits="Node2D" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="add_shape"> - <argument index="0" name="shape" type="Shape2D"> - </argument> - <argument index="1" name="transform" type="Matrix32" default="1,0, 0,1, 0,0"> - </argument> - <description> - </description> - </method> - <method name="get_shape_count" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="set_shape"> - <argument index="0" name="shape_idx" type="int"> - </argument> - <argument index="1" name="shape" type="Shape"> - </argument> - <description> - </description> - </method> - <method name="set_shape_transform"> - <argument index="0" name="shape_idx" type="int"> - </argument> - <argument index="1" name="transform" type="Matrix32"> - </argument> - <description> - </description> - </method> - <method name="get_shape" qualifiers="const"> - <return type="Shape2D"> - </return> - <argument index="0" name="shape_idx" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_shape_transform" qualifiers="const"> - <return type="Matrix32"> - </return> - <argument index="0" name="shape_idx" type="int"> - </argument> - <description> - </description> - </method> - <method name="remove_shape"> - <argument index="0" name="shape_idx" type="int"> - </argument> - <description> - </description> - </method> - <method name="clear_shapes"> - <description> - </description> - </method> - </methods> - <constants> - </constants> -</class> -<class name="CollisionPolygon2D" inherits="Node2D" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - </methods> - <constants> - </constants> -</class> -<class name="CollisionShape2D" inherits="Node2D" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - </methods> - <constants> - </constants> -</class> -<class name="ColorPicker" inherits="Control" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="set_color"> - <argument index="0" name="color" type="Color"> - </argument> - <description> - </description> - </method> - <method name="get_color" qualifiers="const"> - <return type="Color"> - </return> - <description> - </description> - </method> - <method name="set_show_alpha"> - <argument index="0" name="show" type="bool"> - </argument> - <description> - </description> - </method> - <method name="is_showing_alpha" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - </methods> - <signals> - <signal name="color_changed"> - <argument index="0" name="color" type="Color"> - </argument> - <description> - </description> - </signal> - </signals> - <constants> - </constants> -</class> -<class name="ConcavePolygonShape" inherits="Shape" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="set_faces"> - <argument index="0" name="faces" type="Vector3Array"> - </argument> - <description> - </description> - </method> - <method name="get_faces" qualifiers="const"> - <return type="Vector3Array"> - </return> - <description> - </description> - </method> - </methods> - <constants> - </constants> -</class> -<class name="ConcavePolygonShape2D" inherits="Shape2D" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="set_segments"> - <argument index="0" name="segments" type="Vector2Array"> - </argument> - <description> - </description> - </method> - <method name="get_segments" qualifiers="const"> - <return type="Vector2Array"> - </return> - <description> - </description> - </method> - </methods> - <constants> - </constants> -</class> -<class name="ConfirmationDialog" inherits="AcceptDialog" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="get_cancel"> - <return type="Button"> - </return> - <description> - </description> - </method> - </methods> - <constants> - </constants> -</class> -<class name="Container" inherits="Control" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="queue_sort"> - <description> - </description> - </method> - <method name="fit_child_in_rect"> - <argument index="0" name="child" type="Control"> - </argument> - <argument index="1" name="rect" type="Rect2"> - </argument> - <description> - </description> - </method> - </methods> - <signals> - <signal name="sort_children"> - <description> - </description> - </signal> - </signals> - <constants> - <constant name="NOTIFICATION_SORT_CHILDREN" value="50"> - </constant> - </constants> -</class> -<class name="Control" inherits="CanvasItem" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="accept_event"> - <description> - </description> - </method> - <method name="get_minimum_size" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - </description> - </method> - <method name="is_window" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="get_window" qualifiers="const"> - <return type="Object"> - </return> - <description> - </description> - </method> - <method name="set_anchor"> - <argument index="0" name="margin" type="int"> - </argument> - <argument index="1" name="anchor_mode" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_anchor" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="margin" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_margin"> - <argument index="0" name="margin" type="int"> - </argument> - <argument index="1" name="offset" type="real"> - </argument> - <description> - </description> - </method> - <method name="set_anchor_and_margin"> - <argument index="0" name="margin" type="int"> - </argument> - <argument index="1" name="anchor_mode" type="int"> - </argument> - <argument index="2" name="offset" type="real"> - </argument> - <description> - </description> - </method> - <method name="set_begin"> - <argument index="0" name="pos" type="Vector2"> - </argument> - <description> - </description> - </method> - <method name="set_end"> - <argument index="0" name="pos" type="Vector2"> - </argument> - <description> - </description> - </method> - <method name="set_pos"> - <argument index="0" name="pos" type="Vector2"> - </argument> - <description> - </description> - </method> - <method name="set_size"> - <argument index="0" name="size" type="Vector2"> - </argument> - <description> - </description> - </method> - <method name="set_global_pos"> - <argument index="0" name="pos" type="Vector2"> - </argument> - <description> - </description> - </method> - <method name="get_margin" qualifiers="const"> - <return type="real"> - </return> - <argument index="0" name="margin" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_begin" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - </description> - </method> - <method name="get_end" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - </description> - </method> - <method name="get_pos" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - </description> - </method> - <method name="get_size" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - </description> - </method> - <method name="get_parent_area_size" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - </description> - </method> - <method name="get_global_pos" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - </description> - </method> - <method name="get_rect" qualifiers="const"> - <return type="Rect2"> - </return> - <description> - </description> - </method> - <method name="get_global_rect" qualifiers="const"> - <return type="Rect2"> - </return> - <description> - </description> - </method> - <method name="set_area_as_parent_rect"> - <argument index="0" name="margin" type="int" default="0"> - </argument> - <description> - </description> - </method> - <method name="show_modal"> - <argument index="0" name="exclusive" type="bool" default="false"> - </argument> - <description> - </description> - </method> - <method name="set_focus_mode"> - <argument index="0" name="mode" type="int"> - </argument> - <description> - </description> - </method> - <method name="has_focus" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="grab_focus"> - <description> - </description> - </method> - <method name="release_focus"> - <description> - </description> - </method> - <method name="get_focus_owner" qualifiers="const"> - <return type="Control"> - </return> - <description> - </description> - </method> - <method name="set_h_size_flags"> - <argument index="0" name="flags" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_h_size_flags" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="set_stretch_ratio"> - <argument index="0" name="ratio" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_stretch_ratio" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="set_v_size_flags"> - <argument index="0" name="flags" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_v_size_flags" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="set_theme"> - <argument index="0" name="theme" type="Theme"> - </argument> - <description> - </description> - </method> - <method name="get_theme" qualifiers="const"> - <return type="Theme"> - </return> - <description> - </description> - </method> - <method name="add_icon_override"> - <argument index="0" name="name" type="String"> - </argument> - <argument index="1" name="texture" type="Texture"> - </argument> - <description> - </description> - </method> - <method name="add_style_override"> - <argument index="0" name="name" type="String"> - </argument> - <argument index="1" name="stylebox" type="StyleBox"> - </argument> - <description> - </description> - </method> - <method name="add_font_override"> - <argument index="0" name="name" type="String"> - </argument> - <argument index="1" name="font" type="Font"> - </argument> - <description> - </description> - </method> - <method name="add_color_override"> - <argument index="0" name="name" type="String"> - </argument> - <argument index="1" name="color" type="Color"> - </argument> - <description> - </description> - </method> - <method name="add_constant_override"> - <argument index="0" name="name" type="String"> - </argument> - <argument index="1" name="constant" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_icon" qualifiers="const"> - <return type="Texture"> - </return> - <argument index="0" name="name" type="String"> - </argument> - <argument index="1" name="type" type="String" default=""""> - </argument> - <description> - </description> - </method> - <method name="get_stylebox" qualifiers="const"> - <return type="StyleBox"> - </return> - <argument index="0" name="name" type="String"> - </argument> - <argument index="1" name="type" type="String" default=""""> - </argument> - <description> - </description> - </method> - <method name="get_font" qualifiers="const"> - <return type="Font"> - </return> - <argument index="0" name="name" type="String"> - </argument> - <argument index="1" name="type" type="String" default=""""> - </argument> - <description> - </description> - </method> - <method name="get_color" qualifiers="const"> - <return type="Color"> - </return> - <argument index="0" name="name" type="String"> - </argument> - <argument index="1" name="type" type="String" default=""""> - </argument> - <description> - </description> - </method> - <method name="get_constant" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="name" type="String"> - </argument> - <argument index="1" name="type" type="String" default=""""> - </argument> - <description> - </description> - </method> - <method name="get_parent_control" qualifiers="const"> - <return type="Control"> - </return> - <description> - </description> - </method> - <method name="set_tooltip"> - <argument index="0" name="tooltip" type="String"> - </argument> - <description> - </description> - </method> - <method name="get_tooltip" qualifiers="const"> - <return type="String"> - </return> - <argument index="0" name="atpos" type="Vector2" default="Vector2(0,0)"> - </argument> - <description> - </description> - </method> - <method name="set_default_cursor_shape"> - <argument index="0" name="shape" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_default_cursor_shape" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="get_cursor_shape" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="pos" type="Vector2" default="Vector2(0,0)"> - </argument> - <description> - </description> - </method> - <method name="set_focus_neighbour"> - <argument index="0" name="margin" type="int"> - </argument> - <argument index="1" name="neighbour" type="NodePath"> - </argument> - <description> - </description> - </method> - <method name="get_focus_neighbour" qualifiers="const"> - <return type="NodePath"> - </return> - <argument index="0" name="margin" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_ignore_mouse"> - <argument index="0" name="ignore" type="bool"> - </argument> - <description> - </description> - </method> - <method name="is_ignoring_mouse" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - </methods> - <signals> - <signal name="focus_enter"> - <description> - </description> - </signal> - <signal name="mouse_enter"> - <description> - </description> - </signal> - <signal name="resized"> - <description> - </description> - </signal> - <signal name="minimum_size_changed"> - <description> - </description> - </signal> - <signal name="size_flags_changed"> - <description> - </description> - </signal> - <signal name="focus_exit"> - <description> - </description> - </signal> - <signal name="input_event"> - <description> - </description> - </signal> - <signal name="mouse_exit"> - <description> - </description> - </signal> - </signals> - <constants> - <constant name="ANCHOR_BEGIN" value="0"> - </constant> - <constant name="ANCHOR_END" value="1"> - </constant> - <constant name="ANCHOR_RATIO" value="2"> - </constant> - <constant name="FOCUS_NONE" value="0"> - </constant> - <constant name="FOCUS_CLICK" value="1"> - </constant> - <constant name="FOCUS_ALL" value="2"> - </constant> - <constant name="NOTIFICATION_RESIZED" value="34"> - </constant> - <constant name="NOTIFICATION_MOUSE_ENTER" value="35"> - </constant> - <constant name="NOTIFICATION_MOUSE_EXIT" value="36"> - </constant> - <constant name="NOTIFICATION_FOCUS_ENTER" value="37"> - </constant> - <constant name="NOTIFICATION_FOCUS_EXIT" value="38"> - </constant> - <constant name="NOTIFICATION_THEME_CHANGED" value="39"> - </constant> - <constant name="NOTIFICATION_MODAL_CLOSE" value="40"> - </constant> - <constant name="CURSOR_ARROW" value="0"> - </constant> - <constant name="CURSOR_IBEAM" value="1"> - </constant> - <constant name="CURSOR_POINTING_HAND" value="2"> - </constant> - <constant name="CURSOR_CROSS" value="3"> - </constant> - <constant name="CURSOR_WAIT" value="4"> - </constant> - <constant name="CURSOR_BUSY" value="5"> - </constant> - <constant name="CURSOR_DRAG" value="6"> - </constant> - <constant name="CURSOR_CAN_DROP" value="7"> - </constant> - <constant name="CURSOR_FORBIDDEN" value="8"> - </constant> - <constant name="CURSOR_VSIZE" value="9"> - </constant> - <constant name="CURSOR_HSIZE" value="10"> - </constant> - <constant name="CURSOR_BDIAGSIZE" value="11"> - </constant> - <constant name="CURSOR_FDIAGSIZE" value="12"> - </constant> - <constant name="CURSOR_MOVE" value="13"> - </constant> - <constant name="CURSOR_VSPLIT" value="14"> - </constant> - <constant name="CURSOR_HSPLIT" value="15"> - </constant> - <constant name="CURSOR_HELP" value="16"> - </constant> - </constants> -</class> -<class name="ConvexPolygonShape" inherits="Shape" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="set_planes"> - <argument index="0" name="planes" type="Array"> - </argument> - <description> - </description> - </method> - <method name="get_planes" qualifiers="const"> - <return type="Array"> - </return> - <description> - </description> - </method> - </methods> - <constants> - </constants> -</class> -<class name="ConvexPolygonShape2D" inherits="Shape2D" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="set_points"> - <argument index="0" name="points" type="Vector2Array"> - </argument> - <description> - </description> - </method> - <method name="get_points" qualifiers="const"> - <return type="Vector2Array"> - </return> - <description> - </description> - </method> - </methods> - <constants> - </constants> -</class> -<class name="DOFBlurFX" inherits="ScenarioFX" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - </methods> - <constants> - </constants> -</class> -<class name="DampedSpringJoint2D" inherits="Joint2D" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="set_length"> - <argument index="0" name="length" type="real"> - </argument> - <description> - </description> - </method> - <method name="get_length" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - <method name="set_rest_length"> - <argument index="0" name="rest_length" type="real"> - </argument> - <description> - </description> - </method> - <method name="get_rest_length" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - <method name="set_stiffness"> - <argument index="0" name="stiffness" type="real"> - </argument> - <description> - </description> - </method> - <method name="get_stiffness" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - <method name="set_damping"> - <argument index="0" name="damping" type="real"> - </argument> - <description> - </description> - </method> - <method name="get_damping" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - </methods> - <constants> - </constants> -</class> -<class name="DirectionalLight" inherits="Light" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - </methods> - <constants> - </constants> -</class> -<class name="DynamicBody" inherits="PhysicsBody" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="set_mass"> - <argument index="0" name="mass" type="real"> - </argument> - <description> - </description> - </method> - <method name="set_friction"> - <argument index="0" name="friction" type="real"> - </argument> - <description> - </description> - </method> - <method name="set_bounce"> - <argument index="0" name="bounce" type="real"> - </argument> - <description> - </description> - </method> - <method name="get_mass" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - <method name="get_friction" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - <method name="get_bounce" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - <method name="set_linear_velocity"> - <argument index="0" name="linear_velocity" type="Vector3"> - </argument> - <description> - </description> - </method> - <method name="get_linear_velocity" qualifiers="const"> - <return type="Vector3"> - </return> - <description> - </description> - </method> - <method name="set_angular_velocity"> - <argument index="0" name="angular_velocity" type="Vector3"> - </argument> - <description> - </description> - </method> - <method name="get_angular_velocity" qualifiers="const"> - <return type="Vector3"> - </return> - <description> - </description> - </method> - <method name="set_sleeping"> - <argument index="0" name="sleeping" type="bool"> - </argument> - <description> - </description> - </method> - <method name="is_sleeping" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_applied_force"> - <argument index="0" name="applied_force" type="Vector3"> - </argument> - <description> - </description> - </method> - <method name="get_applied_force" qualifiers="const"> - <return type="Vector3"> - </return> - <description> - </description> - </method> - <method name="set_applied_torque"> - <argument index="0" name="applied_torque" type="Vector3"> - </argument> - <description> - </description> - </method> - <method name="get_applied_torque" qualifiers="const"> - <return type="Vector3"> - </return> - <description> - </description> - </method> - <method name="apply_local_impulse"> - <argument index="0" name="pos" type="Vector3"> - </argument> - <argument index="1" name="impulse" type="Vector3"> - </argument> - <description> - </description> - </method> - <method name="set_axis_velocity"> - <argument index="0" name="axis_velocity" type="Vector3"> - </argument> - <description> - </description> - </method> - <method name="set_direct_state_control"> - <argument index="0" name="enabled" type="bool"> - </argument> - <description> - </description> - </method> - <method name="is_direct_state_control_enabled" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_omit_force_integration"> - <argument index="0" name="enabled" type="bool"> - </argument> - <description> - </description> - </method> - <method name="is_omitting_force_integration" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - </methods> - <constants> - </constants> -</class> -<class name="DynamicCharacterBody" inherits="DynamicBody" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - </methods> - <constants> - </constants> -</class> -<class name="DynamicCustomBody" inherits="DynamicBody" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="set_mode"> - <argument index="0" name="mode" type="int"> - </argument> - <description> - </description> - </method> - </methods> - <constants> - </constants> -</class> -<class name="DynamicRigidBody" inherits="DynamicBody" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - </methods> - <constants> - </constants> -</class> -<class name="EmptyControl" inherits="Control" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="set_minsize"> - <argument index="0" name="minsize" type="Vector2"> - </argument> - <description> - </description> - </method> - <method name="get_minsize" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - </description> - </method> - </methods> - <constants> - </constants> -</class> -<class name="_File" inherits="Reference" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="open"> - <return type="int"> - </return> - <argument index="0" name="path" type="String"> - </argument> - <argument index="1" name="flags" type="int"> - </argument> - <description> - </description> - </method> - <method name="close"> - <description> - </description> - </method> - <method name="is_open" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="seek"> - <argument index="0" name="pos" type="int"> - </argument> - <description> - </description> - </method> - <method name="seek_end"> - <argument index="0" name="pos" type="int" default="0"> - </argument> - <description> - </description> - </method> - <method name="get_pos" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="get_len" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="eof_reached" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="get_8" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="get_16" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="get_32" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="get_64" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="get_float" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - <method name="get_double" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - <method name="get_real" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - <method name="get_buffer" qualifiers="const"> - <return type="RawArray"> - </return> - <argument index="0" name="len" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_line" qualifiers="const"> - <return type="String"> - </return> - <description> - </description> - </method> - <method name="get_endian_swap"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_endian_swap"> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - </description> - </method> - <method name="get_error" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="get_var" qualifiers="const"> - <description> - </description> - </method> - <method name="store_8"> - <argument index="0" name="value" type="int"> - </argument> - <description> - </description> - </method> - <method name="store_16"> - <argument index="0" name="value" type="int"> - </argument> - <description> - </description> - </method> - <method name="store_32"> - <argument index="0" name="value" type="int"> - </argument> - <description> - </description> - </method> - <method name="store_64"> - <argument index="0" name="value" type="int"> - </argument> - <description> - </description> - </method> - <method name="store_float"> - <argument index="0" name="value" type="real"> - </argument> - <description> - </description> - </method> - <method name="store_double"> - <argument index="0" name="value" type="real"> - </argument> - <description> - </description> - </method> - <method name="store_real"> - <argument index="0" name="value" type="real"> - </argument> - <description> - </description> - </method> - <method name="store_buffer"> - <argument index="0" name="buffer" type="RawArray"> - </argument> - <description> - </description> - </method> - <method name="store_line"> - <argument index="0" name="line" type="String"> - </argument> - <description> - </description> - </method> - <method name="store_string"> - <argument index="0" name="string" type="String"> - </argument> - <description> - </description> - </method> - <method name="store_var"> - <argument index="0" name="value" type="var"> - </argument> - <description> - </description> - </method> - <method name="file_exists" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="path" type="String"> - </argument> - <description> - </description> - </method> - </methods> - <constants> - <constant name="READ" value="1"> - </constant> - <constant name="WRITE" value="2"> - </constant> - <constant name="READ_WRITE" value="3"> - </constant> - </constants> -</class> -<class name="FileDialog" inherits="ConfirmationDialog" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="clear_filters"> - <description> - </description> - </method> - <method name="add_filter"> - <argument index="0" name="filter" type="String"> - </argument> - <description> - </description> - </method> - <method name="get_current_dir" qualifiers="const"> - <return type="String"> - </return> - <description> - </description> - </method> - <method name="get_current_file" qualifiers="const"> - <return type="String"> - </return> - <description> - </description> - </method> - <method name="get_current_path" qualifiers="const"> - <return type="String"> - </return> - <description> - </description> - </method> - <method name="set_current_dir"> - <argument index="0" name="dir" type="String"> - </argument> - <description> - </description> - </method> - <method name="set_current_file"> - <argument index="0" name="file" type="String"> - </argument> - <description> - </description> - </method> - <method name="set_current_path"> - <argument index="0" name="path" type="String"> - </argument> - <description> - </description> - </method> - <method name="set_mode"> - <argument index="0" name="mode" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_mode" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="get_vbox"> - <return type="VBoxContainer"> - </return> - <description> - </description> - </method> - </methods> - <signals> - <signal name="dir_selected"> - <argument index="0" name="dir" type="String"> - </argument> - <description> - </description> - </signal> - <signal name="file_selected"> - <argument index="0" name="path" type="String"> - </argument> - <description> - </description> - </signal> - </signals> - <constants> - <constant name="MODE_OPEN_FILE" value="0"> - </constant> - <constant name="MODE_OPEN_DIR" value="1"> - </constant> - <constant name="MODE_SAVE_FILE" value="2"> - </constant> - </constants> -</class> -<class name="FixedMaterial" inherits="Material" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="set_shader"> - <argument index="0" name="shader" type="Shader"> - </argument> - <description> - </description> - </method> - <method name="get_shader" qualifiers="const"> - <return type="Shader"> - </return> - <description> - </description> - </method> - <method name="set_parameter"> - <argument index="0" name="param" type="int"> - </argument> - <argument index="1" name="value" type="var"> - </argument> - <description> - </description> - </method> - <method name="get_parameter" qualifiers="const"> - <argument index="0" name="param" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_texture"> - <argument index="0" name="param" type="int"> - </argument> - <argument index="1" name="texture" type="Texture"> - </argument> - <description> - </description> - </method> - <method name="get_texture" qualifiers="const"> - <return type="Texture"> - </return> - <argument index="0" name="param" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_texgen_mode"> - <argument index="0" name="mode" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_texgen_mode" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="set_texcoord_mode"> - <argument index="0" name="param" type="int"> - </argument> - <argument index="1" name="mode" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_texcoord_mode" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="param" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_uv_transform"> - <argument index="0" name="transform" type="Transform"> - </argument> - <description> - </description> - </method> - <method name="get_uv_transform" qualifiers="const"> - <return type="Transform"> - </return> - <description> - </description> - </method> - <method name="set_detail_blend_mode"> - <argument index="0" name="mode" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_detail_blend_mode" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - </methods> - <constants> - <constant name="PARAM_DIFFUSE" value="0"> - </constant> - <constant name="PARAM_DETAIL" value="1"> - </constant> - <constant name="PARAM_SPECULAR" value="2"> - </constant> - <constant name="PARAM_EMISSION" value="3"> - </constant> - <constant name="PARAM_SPECULAR_EXP" value="4"> - </constant> - <constant name="PARAM_GLOW" value="5"> - </constant> - <constant name="PARAM_NORMAL" value="6"> - </constant> - <constant name="PARAM_SHADE_PARAM" value="7"> - </constant> - <constant name="PARAM_MAX" value="8"> - </constant> - <constant name="TEXGEN_SPHERE" value="1"> - </constant> - <constant name="TEXGEN_SCREEN" value="2"> - </constant> - <constant name="TEXGEN_SCREENZ" value="3"> - </constant> - <constant name="TEXGEN_LOCAL_XY" value="0"> - </constant> - <constant name="TEXCOORD_TEXGEN" value="3"> - </constant> - <constant name="TEXCOORD_UV" value="0"> - </constant> - <constant name="TEXCOORD_UV_TRANSFORM" value="1"> - </constant> - <constant name="TEXCOORD_UV2" value="2"> - </constant> - </constants> -</class> -<class name="FogFX" inherits="ScenarioFX" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - </methods> - <constants> - </constants> -</class> -<class name="FollowCamera" inherits="Camera" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="set_orbit"> - <argument index="0" name="orbit" type="Vector2"> - </argument> - <description> - </description> - </method> - <method name="get_orbit" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - </description> - </method> - <method name="set_orbit_x"> - <argument index="0" name="x" type="real"> - </argument> - <description> - </description> - </method> - <method name="set_orbit_y"> - <argument index="0" name="y" type="real"> - </argument> - <description> - </description> - </method> - <method name="set_min_orbit_x"> - <argument index="0" name="x" type="real"> - </argument> - <description> - </description> - </method> - <method name="get_min_orbit_x" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - <method name="set_max_orbit_x"> - <argument index="0" name="x" type="real"> - </argument> - <description> - </description> - </method> - <method name="get_max_orbit_x" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - <method name="set_height"> - <argument index="0" name="height" type="real"> - </argument> - <description> - </description> - </method> - <method name="get_height" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - <method name="set_inclination"> - <argument index="0" name="inclination" type="real"> - </argument> - <description> - </description> - </method> - <method name="get_inclination" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - <method name="rotate_orbit"> - <argument index="0" name="arg0" type="Vector2"> - </argument> - <description> - </description> - </method> - <method name="set_distance"> - <argument index="0" name="distance" type="real"> - </argument> - <description> - </description> - </method> - <method name="get_distance" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - <method name="set_max_distance"> - <argument index="0" name="max_distance" type="real"> - </argument> - <description> - </description> - </method> - <method name="get_max_distance" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - <method name="set_min_distance"> - <argument index="0" name="min_distance" type="real"> - </argument> - <description> - </description> - </method> - <method name="get_min_distance" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - <method name="set_clip"> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - </description> - </method> - <method name="has_clip" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_autoturn"> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - </description> - </method> - <method name="has_autoturn" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_autoturn_tolerance"> - <argument index="0" name="degrees" type="real"> - </argument> - <description> - </description> - </method> - <method name="get_autoturn_tolerance" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - <method name="set_autoturn_speed"> - <argument index="0" name="speed" type="real"> - </argument> - <description> - </description> - </method> - <method name="get_autoturn_speed" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - <method name="set_smoothing"> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - </description> - </method> - <method name="has_smoothing" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_rotation_smoothing"> - <argument index="0" name="amount" type="real"> - </argument> - <description> - </description> - </method> - <method name="get_rotation_smoothing" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - <method name="set_translation_smoothing"> - <argument index="0" name="amount" type="real"> - </argument> - <description> - </description> - </method> - <method name="get_translation_smoothing" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - <method name="set_use_lookat_target"> - <argument index="0" name="use" type="bool"> - </argument> - <argument index="1" name="lookat" type="Vector3" default="Vector3(0, 0, 0)"> - </argument> - <description> - </description> - </method> - </methods> - <constants> - </constants> -</class> -<class name="Font" inherits="Resource" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="set_height"> - <argument index="0" name="px" type="real"> - </argument> - <description> - </description> - </method> - <method name="get_height" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - <method name="set_ascent"> - <argument index="0" name="px" type="real"> - </argument> - <description> - </description> - </method> - <method name="get_ascent" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - <method name="get_descent" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - <method name="add_kerning_pair"> - <argument index="0" name="char_a" type="int"> - </argument> - <argument index="1" name="char_b" type="int"> - </argument> - <argument index="2" name="kerning" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_kerning_pair" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="arg0" type="int"> - </argument> - <argument index="1" name="arg1" type="int"> - </argument> - <description> - </description> - </method> - <method name="add_texture"> - <argument index="0" name="texture" type="Texture"> - </argument> - <description> - </description> - </method> - <method name="add_char"> - <argument index="0" name="character" type="int"> - </argument> - <argument index="1" name="texture" type="int"> - </argument> - <argument index="2" name="rect" type="Rect2"> - </argument> - <argument index="3" name="align" type="Vector2" default="Vector2(0,0)"> - </argument> - <argument index="4" name="advance" type="real" default="-1"> - </argument> - <description> - </description> - </method> - <method name="get_char_size" qualifiers="const"> - <return type="Vector2"> - </return> - <argument index="0" name="char" type="int"> - </argument> - <argument index="1" name="next" type="int" default="0"> - </argument> - <description> - </description> - </method> - <method name="get_string_size" qualifiers="const"> - <return type="Vector2"> - </return> - <argument index="0" name="string" type="String"> - </argument> - <description> - </description> - </method> - <method name="clear"> - <description> - </description> - </method> - <method name="draw" qualifiers="const"> - <argument index="0" name="canvas_item" type="RID"> - </argument> - <argument index="1" name="pos" type="Vector2"> - </argument> - <argument index="2" name="string" type="String"> - </argument> - <argument index="3" name="modulate" type="Color" default="Color(1,1,1,1)"> - </argument> - <argument index="4" name="clip_w" type="int" default="-1"> - </argument> - <description> - </description> - </method> - <method name="draw_char" qualifiers="const"> - <return type="real"> - </return> - <argument index="0" name="canvas_item" type="RID"> - </argument> - <argument index="1" name="pos" type="Vector2"> - </argument> - <argument index="2" name="char" type="int"> - </argument> - <argument index="3" name="next" type="int" default="-1"> - </argument> - <argument index="4" name="modulate" type="Color" default="Color(1,1,1,1)"> - </argument> - <description> - </description> - </method> - </methods> - <constants> - </constants> -</class> -<class name="GDNativeClass" inherits="Reference" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="new"> - <description> - </description> - </method> - </methods> - <constants> - </constants> -</class> -<class name="GDScript" inherits="Script" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="new"> - <description> - </description> - </method> - </methods> - <constants> - </constants> -</class> -<class name="GammaFX" inherits="ScenarioFX" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - </methods> - <constants> - </constants> -</class> -<class name="_Geometry" inherits="Object" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="build_box_planes"> - <return type="Array"> - </return> - <argument index="0" name="extents" type="Vector3"> - </argument> - <description> - </description> - </method> - <method name="build_cylinder_planes"> - <return type="Array"> - </return> - <argument index="0" name="radius" type="real"> - </argument> - <argument index="1" name="height" type="real"> - </argument> - <argument index="2" name="sides" type="int"> - </argument> - <argument index="3" name="axis" type="int" default="2"> - </argument> - <description> - </description> - </method> - <method name="build_capsule_planes"> - <return type="Array"> - </return> - <argument index="0" name="radius" type="real"> - </argument> - <argument index="1" name="height" type="real"> - </argument> - <argument index="2" name="sides" type="int"> - </argument> - <argument index="3" name="lats" type="int"> - </argument> - <argument index="4" name="axis" type="int" default="2"> - </argument> - <description> - </description> - </method> - <method name="segment_intersects_circle"> - <return type="real"> - </return> - <argument index="0" name="segment_from" type="Vector2"> - </argument> - <argument index="1" name="segment_to" type="Vector2"> - </argument> - <argument index="2" name="circle_pos" type="Vector2"> - </argument> - <argument index="3" name="circle_radius" type="real"> - </argument> - <description> - </description> - </method> - </methods> - <constants> - </constants> -</class> -<class name="GeometryInstance" inherits="VisualInstance" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="set_visible"> - <argument index="0" name="visible" type="bool"> - </argument> - <description> - </description> - </method> - <method name="is_visible" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_material_override"> - <argument index="0" name="material" type="Object"> - </argument> - <description> - </description> - </method> - <method name="get_material_override" qualifiers="const"> - <return type="Object"> - </return> - <description> - </description> - </method> - </methods> - <constants> - </constants> -</class> -<class name="Globals" inherits="Object" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="has" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="name" type="String"> - </argument> - <description> - </description> - </method> - <method name="set_order"> - <argument index="0" name="name" type="String"> - </argument> - <argument index="1" name="pos" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_order" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="name" type="String"> - </argument> - <description> - </description> - </method> - <method name="set_persisting"> - <argument index="0" name="name" type="String"> - </argument> - <argument index="1" name="enable" type="bool"> - </argument> - <description> - </description> - </method> - <method name="is_persisting" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="name" type="String"> - </argument> - <description> - </description> - </method> - <method name="clear"> - <argument index="0" name="name" type="String"> - </argument> - <description> - </description> - </method> - <method name="localize_path" qualifiers="const"> - <return type="String"> - </return> - <argument index="0" name="path" type="String"> - </argument> - <description> - </description> - </method> - <method name="globalize_path" qualifiers="const"> - <return type="String"> - </return> - <argument index="0" name="path" type="String"> - </argument> - <description> - </description> - </method> - </methods> - <constants> - </constants> -</class> -<class name="GlowFX" inherits="ScenarioFX" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - </methods> - <constants> - </constants> -</class> -<class name="GridMap" inherits="Spatial" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="set_theme"> - <argument index="0" name="theme" type="MeshLibrary"> - </argument> - <description> - </description> - </method> - <method name="get_theme" qualifiers="const"> - <return type="MeshLibrary"> - </return> - <description> - </description> - </method> - <method name="set_cell_size"> - <argument index="0" name="size" type="real"> - </argument> - <description> - </description> - </method> - <method name="get_cell_size" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - <method name="set_octant_size"> - <argument index="0" name="size" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_octant_size" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="set_width"> - <argument index="0" name="width" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_width" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="set_height"> - <argument index="0" name="height" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_height" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="set_depth"> - <argument index="0" name="depth" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_depth" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="set_cell_item"> - <argument index="0" name="x" type="int"> - </argument> - <argument index="1" name="y" type="int"> - </argument> - <argument index="2" name="z" type="int"> - </argument> - <argument index="3" name="item" type="int"> - </argument> - <argument index="4" name="orientation" type="int" default="0"> - </argument> - <description> - </description> - </method> - <method name="get_cell_item" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="x" type="int"> - </argument> - <argument index="1" name="y" type="int"> - </argument> - <argument index="2" name="z" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_cell_item_orientation" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="x" type="int"> - </argument> - <argument index="1" name="y" type="int"> - </argument> - <argument index="2" name="z" type="int"> - </argument> - <description> - </description> - </method> - <method name="resource_changed"> - <argument index="0" name="arg0" type="Object"> - </argument> - <description> - </description> - </method> - <method name="set_center_x"> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - </description> - </method> - <method name="get_center_x" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_center_y"> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - </description> - </method> - <method name="get_center_y" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_center_z"> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - </description> - </method> - <method name="get_center_z" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_clip"> - <argument index="0" name="enabled" type="bool"> - </argument> - <argument index="1" name="clipabove" type="bool" default="true"> - </argument> - <argument index="2" name="floor" type="int" default="0"> - </argument> - <argument index="3" name="axis" type="int" default="0"> - </argument> - <description> - </description> - </method> - <method name="crate_area"> - <return type="int"> - </return> - <argument index="0" name="id" type="int"> - </argument> - <argument index="1" name="area" type="AABB"> - </argument> - <description> - </description> - </method> - <method name="area_get_bounds" qualifiers="const"> - <return type="AABB"> - </return> - <argument index="0" name="area" type="int"> - </argument> - <description> - </description> - </method> - <method name="area_set_exterior_portal"> - <argument index="0" name="area" type="int"> - </argument> - <argument index="1" name="enable" type="bool"> - </argument> - <description> - </description> - </method> - <method name="area_set_name"> - <argument index="0" name="area" type="int"> - </argument> - <argument index="1" name="name" type="String"> - </argument> - <description> - </description> - </method> - <method name="area_get_name" qualifiers="const"> - <return type="String"> - </return> - <argument index="0" name="area" type="int"> - </argument> - <description> - </description> - </method> - <method name="area_is_exterior_portal" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="area" type="int"> - </argument> - <description> - </description> - </method> - <method name="area_set_portal_disable_distance"> - <argument index="0" name="area" type="int"> - </argument> - <argument index="1" name="distance" type="real"> - </argument> - <description> - </description> - </method> - <method name="area_get_portal_disable_distance" qualifiers="const"> - <return type="real"> - </return> - <argument index="0" name="area" type="int"> - </argument> - <description> - </description> - </method> - <method name="area_set_portal_disable_color"> - <argument index="0" name="area" type="int"> - </argument> - <argument index="1" name="color" type="Color"> - </argument> - <description> - </description> - </method> - <method name="area_get_portal_disable_color" qualifiers="const"> - <return type="Color"> - </return> - <argument index="0" name="area" type="int"> - </argument> - <description> - </description> - </method> - <method name="erase_area"> - <argument index="0" name="area" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_unused_area_id" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - </methods> - <constants> - <constant name="INVALID_CELL_ITEM" value="-1"> - </constant> - </constants> -</class> -<class name="GrooveJoint2D" inherits="Joint2D" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="set_length"> - <argument index="0" name="length" type="real"> - </argument> - <description> - </description> - </method> - <method name="get_length" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - <method name="set_initial_offset"> - <argument index="0" name="offset" type="real"> - </argument> - <description> - </description> - </method> - <method name="get_initial_offset" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - </methods> - <constants> - </constants> -</class> -<class name="HBoxContainer" inherits="BoxContainer" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - </methods> - <constants> - </constants> -</class> -<class name="HButtonArray" inherits="ButtonArray" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - </methods> - <constants> - </constants> -</class> -<class name="HDRFX" inherits="ScenarioFX" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - </methods> - <constants> - </constants> -</class> -<class name="HScrollBar" inherits="ScrollBar" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - </methods> - <constants> - </constants> -</class> -<class name="HSeparator" inherits="Separator" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - </methods> - <constants> - </constants> -</class> -<class name="HSlider" inherits="Slider" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - </methods> - <constants> - </constants> -</class> -<class name="IP" inherits="Object" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="resolve_hostname"> - <return type="String"> - </return> - <argument index="0" name="host" type="String"> - </argument> - <description> - </description> - </method> - <method name="resolve_hostname_queue_item"> - <return type="int"> - </return> - <argument index="0" name="host" type="String"> - </argument> - <description> - </description> - </method> - <method name="get_resolve_item_status" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="id" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_resolve_item_address" qualifiers="const"> - <return type="String"> - </return> - <argument index="0" name="id" type="int"> - </argument> - <description> - </description> - </method> - <method name="erase_resolve_item"> - <argument index="0" name="id" type="int"> - </argument> - <description> - </description> - </method> - </methods> - <constants> - <constant name="RESOLVER_STATUS_NONE" value="0"> - </constant> - <constant name="RESOLVER_STATUS_WAITING" value="1"> - </constant> - <constant name="RESOLVER_STATUS_DONE" value="2"> - </constant> - <constant name="RESOLVER_STATUS_ERROR" value="3"> - </constant> - <constant name="RESOLVER_MAX_QUERIES" value="32"> - </constant> - <constant name="RESOLVER_INVALID_ID" value="-1"> - </constant> - </constants> -</class> -<class name="IP_Unix" inherits="IP" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - </methods> - <constants> - </constants> -</class> -<class name="InputMap" inherits="Object" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - </methods> - <constants> - </constants> -</class> -<class name="InterpolatedCamera" inherits="Camera" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="set_target_path"> - <argument index="0" name="target_path" type="NodePath"> - </argument> - <description> - </description> - </method> - <method name="get_target_path" qualifiers="const"> - <return type="NodePath"> - </return> - <description> - </description> - </method> - <method name="set_target"> - <argument index="0" name="target" type="Object"> - </argument> - <description> - </description> - </method> - <method name="set_speed"> - <argument index="0" name="speed" type="real"> - </argument> - <description> - </description> - </method> - <method name="get_speed" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - <method name="set_interpolation_enabled"> - <argument index="0" name="target_path" type="bool"> - </argument> - <description> - </description> - </method> - <method name="is_interpolation_enabled" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - </methods> - <constants> - </constants> -</class> -<class name="Joint2D" inherits="Node2D" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="set_node_a"> - <argument index="0" name="node" type="NodePath"> - </argument> - <description> - </description> - </method> - <method name="get_node_a" qualifiers="const"> - <return type="NodePath"> - </return> - <description> - </description> - </method> - <method name="set_node_b"> - <argument index="0" name="node" type="NodePath"> - </argument> - <description> - </description> - </method> - <method name="get_node_b" qualifiers="const"> - <return type="NodePath"> - </return> - <description> - </description> - </method> - </methods> - <constants> - </constants> -</class> -<class name="Label" inherits="Range" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="set_align"> - <argument index="0" name="align" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_align" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="set_valign"> - <argument index="0" name="valign" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_valign" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="set_text"> - <argument index="0" name="text" type="String"> - </argument> - <description> - </description> - </method> - <method name="get_text" qualifiers="const"> - <return type="String"> - </return> - <description> - </description> - </method> - <method name="set_autowrap"> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - </description> - </method> - <method name="has_autowrap" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="get_line_height" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="get_line_count" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - </methods> - <constants> - <constant name="ALIGN_LEFT" value="0"> - </constant> - <constant name="ALIGN_CENTER" value="1"> - </constant> - <constant name="ALIGN_RIGHT" value="2"> - </constant> - <constant name="ALIGN_FILL" value="3"> - </constant> - <constant name="VALIGN_TOP" value="0"> - </constant> - <constant name="VALIGN_CENTER" value="1"> - </constant> - <constant name="VALIGN_BOTTOM" value="2"> - </constant> - <constant name="VALIGN_FILL" value="3"> - </constant> - </constants> -</class> -<class name="Light" inherits="VisualInstance" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="set_parameter"> - <argument index="0" name="variable" type="int"> - </argument> - <argument index="1" name="value" type="real"> - </argument> - <description> - </description> - </method> - <method name="get_parameter" qualifiers="const"> - <return type="real"> - </return> - <argument index="0" name="arg0" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_color"> - <argument index="0" name="color" type="int"> - </argument> - <argument index="1" name="value" type="Color"> - </argument> - <description> - </description> - </method> - <method name="get_color" qualifiers="const"> - <return type="Color"> - </return> - <argument index="0" name="arg0" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_project_shadows"> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - </description> - </method> - <method name="has_project_shadows" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_projector"> - <argument index="0" name="projector" type="Texture"> - </argument> - <description> - </description> - </method> - <method name="get_projector" qualifiers="const"> - <return type="Texture"> - </return> - <description> - </description> - </method> - <method name="set_operator"> - <argument index="0" name="operator" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_operator" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - </methods> - <constants> - <constant name="PARAM_RADIUS" value="2"> - </constant> - <constant name="PARAM_ENERGY" value="3"> - </constant> - <constant name="PARAM_ATTENUATION" value="4"> - </constant> - <constant name="PARAM_SPOT_ANGLE" value="1"> - </constant> - <constant name="PARAM_SPOT_ATTENUATION" value="4"> - </constant> - <constant name="PARAM_SHADOW_DARKENING" value="5"> - </constant> - <constant name="COLOR_AMBIENT" value="0"> - </constant> - <constant name="COLOR_DIFFUSE" value="1"> - </constant> - <constant name="COLOR_SPECULAR" value="2"> - </constant> - </constants> -</class> -<class name="LineEdit" inherits="Control" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="clear"> - <description> - </description> - </method> - <method name="select_all"> - <description> - </description> - </method> - <method name="set_text"> - <argument index="0" name="text" type="String"> - </argument> - <description> - </description> - </method> - <method name="get_text" qualifiers="const"> - <return type="String"> - </return> - <description> - </description> - </method> - <method name="set_cursor_pos"> - <argument index="0" name="pos" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_cursor_pos" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="set_max_length"> - <argument index="0" name="chars" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_max_length" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="append_at_cursor"> - <argument index="0" name="text" type="String"> - </argument> - <description> - </description> - </method> - <method name="set_editable"> - <argument index="0" name="enabled" type="bool"> - </argument> - <description> - </description> - </method> - <method name="is_editable" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_secret"> - <argument index="0" name="enabled" type="bool"> - </argument> - <description> - </description> - </method> - <method name="is_secret" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="select" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - </methods> - <signals> - <signal name="text_entered"> - <argument index="0" name="text" type="String"> - </argument> - <description> - </description> - </signal> - <signal name="text_changed"> - <argument index="0" name="text" type="String"> - </argument> - <description> - </description> - </signal> - </signals> - <constants> - </constants> -</class> -<class name="LineShape2D" inherits="Shape2D" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="set_normal"> - <argument index="0" name="normal" type="Vector2"> - </argument> - <description> - </description> - </method> - <method name="get_normal" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - </description> - </method> - <method name="set_d"> - <argument index="0" name="d" type="real"> - </argument> - <description> - </description> - </method> - <method name="get_d" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - </methods> - <constants> - </constants> -</class> -<class name="MainLoop" inherits="Object" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="input_event"> - <argument index="0" name="arg0" type="InputEvent"> - </argument> - <description> - </description> - </method> - </methods> - <constants> - <constant name="NOTIFICATION_WM_FOCUS_IN" value="5"> - </constant> - <constant name="NOTIFICATION_WM_FOCUS_OUT" value="6"> - </constant> - <constant name="NOTIFICATION_WM_QUIT_REQUEST" value="7"> - </constant> - </constants> -</class> -<class name="MarginContainer" inherits="Container" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - </methods> - <constants> - </constants> -</class> -<class name="Material" inherits="Resource" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="set_flag"> - <argument index="0" name="flag" type="int"> - </argument> - <argument index="1" name="enable" type="bool"> - </argument> - <description> - </description> - </method> - <method name="get_flag" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="flag" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_hint"> - <argument index="0" name="hint" type="int"> - </argument> - <argument index="1" name="enable" type="bool"> - </argument> - <description> - </description> - </method> - <method name="get_hint" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="hint" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_blend_mode"> - <argument index="0" name="mode" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_blend_mode" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="set_shade_model"> - <argument index="0" name="model" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_shade_model" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="set_line_width"> - <argument index="0" name="width" type="real"> - </argument> - <description> - </description> - </method> - <method name="get_line_width" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - <method name="set_shader_param"> - <argument index="0" name="param" type="String"> - </argument> - <argument index="1" name="arg1" type="var"> - </argument> - <description> - </description> - </method> - <method name="get_shader_param" qualifiers="const"> - <argument index="0" name="arg0" type="String"> - </argument> - <description> - </description> - </method> - </methods> - <constants> - <constant name="FLAG_VISIBLE" value="0"> - </constant> - <constant name="FLAG_DOUBLE_SIDED" value="1"> - </constant> - <constant name="FLAG_INVERT_FACES" value="2"> - </constant> - <constant name="FLAG_UNSHADED" value="3"> - </constant> - <constant name="FLAG_ONTOP" value="4"> - </constant> - <constant name="FLAG_WIREFRAME" value="5"> - </constant> - <constant name="FLAG_BILLBOARD_TOGGLE" value="6"> - </constant> - <constant name="FLAG_MAX" value="7"> - </constant> - <constant name="HINT_DECAL" value="0"> - </constant> - <constant name="HINT_OPAQUE_PRE_PASS" value="1"> - </constant> - <constant name="HINT_NO_SHADOW" value="2"> - </constant> - <constant name="HINT_NO_DEPTH_DRAW" value="3"> - </constant> - <constant name="HINT_MAX" value="4"> - </constant> - <constant name="SHADE_MODEL_LAMBERT" value="0"> - </constant> - <constant name="SHADE_MODEL_LAMBERT_WRAP" value="1"> - </constant> - <constant name="SHADE_MODEL_FRESNEL" value="2"> - </constant> - <constant name="SHADE_MODEL_TOON" value="3"> - </constant> - <constant name="SHADE_MODEL_CUSTOM_0" value="4"> - </constant> - <constant name="SHADE_MODEL_CUSTOM_1" value="5"> - </constant> - <constant name="SHADE_MODEL_CUSTOM_2" value="6"> - </constant> - <constant name="SHADE_MODEL_CUSTOM_3" value="7"> - </constant> - <constant name="BLEND_MODE_MIX" value="0"> - </constant> - <constant name="BLEND_MODE_ADD" value="1"> - </constant> - <constant name="BLEND_MODE_SUB" value="2"> - </constant> - </constants> -</class> -<class name="MenuButton" inherits="Button" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="get_popup"> - <return type="Object"> - </return> - <description> - </description> - </method> - </methods> - <signals> - <signal name="about_to_show"> - <description> - </description> - </signal> - </signals> - <constants> - </constants> -</class> -<class name="Mesh" inherits="Resource" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="add_morph_target"> - <argument index="0" name="name" type="String"> - </argument> - <description> - </description> - </method> - <method name="get_morph_target_count" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="get_morph_target_name" qualifiers="const"> - <return type="String"> - </return> - <argument index="0" name="index" type="int"> - </argument> - <description> - </description> - </method> - <method name="clear_morph_targets"> - <description> - </description> - </method> - <method name="set_morph_target_mode"> - <argument index="0" name="mode" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_morph_target_mode" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="add_surface"> - <argument index="0" name="primitive" type="int"> - </argument> - <argument index="1" name="format" type="int"> - </argument> - <argument index="2" name="array_len" type="int"> - </argument> - <argument index="3" name="index_array_len" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_surface_count" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="surface_remove"> - <argument index="0" name="surf_idx" type="int"> - </argument> - <description> - </description> - </method> - <method name="surface_set_array"> - <return type="int"> - </return> - <argument index="0" name="surf_idx" type="int"> - </argument> - <argument index="1" name="array" type="int"> - </argument> - <argument index="2" name="data" type="var"> - </argument> - <description> - </description> - </method> - <method name="surface_get_array" qualifiers="const"> - <argument index="0" name="surf_idx" type="int"> - </argument> - <argument index="1" name="array" type="int"> - </argument> - <description> - </description> - </method> - <method name="surface_get_array_len" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="surf_idx" type="int"> - </argument> - <description> - </description> - </method> - <method name="surface_get_array_index_len" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="surf_idx" type="int"> - </argument> - <description> - </description> - </method> - <method name="surface_get_format" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="surf_idx" type="int"> - </argument> - <description> - </description> - </method> - <method name="surface_get_primitive_type" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="surf_idx" type="int"> - </argument> - <description> - </description> - </method> - <method name="surface_set_material"> - <argument index="0" name="surf_idx:Material" type="int"> - </argument> - <argument index="1" name="arg1" type="Object"> - </argument> - <description> - </description> - </method> - <method name="surface_get_material" qualifiers="const"> - <return type="Material"> - </return> - <argument index="0" name="surf_idx" type="int"> - </argument> - <description> - </description> - </method> - </methods> - <constants> - <constant name="NO_INDEX_ARRAY" value="-1"> - </constant> - <constant name="ARRAY_WEIGHTS_SIZE" value="4"> - </constant> - <constant name="ARRAY_VERTEX" value="0"> - </constant> - <constant name="ARRAY_NORMAL" value="1"> - </constant> - <constant name="ARRAY_TANGENT" value="2"> - </constant> - <constant name="ARRAY_COLOR" value="3"> - </constant> - <constant name="ARRAY_TEX_UV" value="4"> - </constant> - <constant name="ARRAY_TEX_UV2" value="5"> - </constant> - <constant name="ARRAY_BONES" value="6"> - </constant> - <constant name="ARRAY_WEIGHTS" value="7"> - </constant> - <constant name="ARRAY_INDEX" value="8"> - </constant> - <constant name="ARRAY_FORMAT_VERTEX" value="1"> - </constant> - <constant name="ARRAY_FORMAT_NORMAL" value="2"> - </constant> - <constant name="ARRAY_FORMAT_TANGENT" value="4"> - </constant> - <constant name="ARRAY_FORMAT_COLOR" value="8"> - </constant> - <constant name="ARRAY_FORMAT_TEX_UV" value="16"> - </constant> - <constant name="ARRAY_FORMAT_TEX_UV2" value="32"> - </constant> - <constant name="ARRAY_FORMAT_BONES" value="64"> - </constant> - <constant name="ARRAY_FORMAT_WEIGHTS" value="128"> - </constant> - <constant name="ARRAY_FORMAT_INDEX" value="256"> - </constant> - <constant name="PRIMITIVE_POINTS" value="0"> - </constant> - <constant name="PRIMITIVE_LINES" value="1"> - </constant> - <constant name="PRIMITIVE_LINE_STRIP" value="2"> - </constant> - <constant name="PRIMITIVE_LINE_LOOP" value="3"> - </constant> - <constant name="PRIMITIVE_TRIANGLES" value="4"> - </constant> - <constant name="PRIMITIVE_TRIANGLE_STRIP" value="5"> - </constant> - <constant name="PRIMITIVE_TRIANGLE_FAN" value="6"> - </constant> - </constants> -</class> -<class name="MeshInstance" inherits="GeometryInstance" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="set_mesh"> - <argument index="0" name="mesh" type="Mesh"> - </argument> - <description> - </description> - </method> - <method name="get_mesh" qualifiers="const"> - <return type="Mesh"> - </return> - <description> - </description> - </method> - <method name="get_aabb" qualifiers="const"> - <return type="AABB"> - </return> - <description> - </description> - </method> - <method name="create_trimesh_collision"> - <description> - </description> - </method> - </methods> - <constants> - </constants> -</class> -<class name="MeshLibrary" inherits="Resource" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="create_item"> - <argument index="0" name="id" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_item_name"> - <argument index="0" name="id" type="int"> - </argument> - <argument index="1" name="name" type="String"> - </argument> - <description> - </description> - </method> - <method name="set_item_mesh"> - <argument index="0" name="id" type="int"> - </argument> - <argument index="1" name="mesh" type="Mesh"> - </argument> - <description> - </description> - </method> - <method name="set_item_shape"> - <argument index="0" name="id" type="int"> - </argument> - <argument index="1" name="shape" type="Shape"> - </argument> - <description> - </description> - </method> - <method name="get_item_name" qualifiers="const"> - <return type="String"> - </return> - <argument index="0" name="id" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_item_mesh" qualifiers="const"> - <return type="Mesh"> - </return> - <argument index="0" name="id" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_item_shape" qualifiers="const"> - <return type="Shape"> - </return> - <argument index="0" name="id" type="int"> - </argument> - <description> - </description> - </method> - <method name="remove_item"> - <argument index="0" name="id" type="int"> - </argument> - <description> - </description> - </method> - <method name="clear"> - <description> - </description> - </method> - <method name="get_item_list" qualifiers="const"> - <return type="IntArray"> - </return> - <description> - </description> - </method> - <method name="get_last_unused_item_id" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - </methods> - <constants> - </constants> -</class> -<class name="MultiMesh" inherits="Resource" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="set_mesh"> - <argument index="0" name="mesh" type="Mesh"> - </argument> - <description> - </description> - </method> - <method name="get_mesh" qualifiers="const"> - <return type="Mesh"> - </return> - <description> - </description> - </method> - <method name="set_instance_count"> - <argument index="0" name="arg0" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_instance_count" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="set_instance_transform"> - <argument index="0" name="arg0" type="int"> - </argument> - <argument index="1" name="arg1" type="Transform"> - </argument> - <description> - </description> - </method> - <method name="get_instance_transform" qualifiers="const"> - <return type="Transform"> - </return> - <argument index="0" name="arg0" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_instance_color"> - <argument index="0" name="arg0" type="int"> - </argument> - <argument index="1" name="arg1" type="Color"> - </argument> - <description> - </description> - </method> - <method name="get_instance_color" qualifiers="const"> - <return type="Color"> - </return> - <argument index="0" name="arg0" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_aabb"> - <argument index="0" name="arg0" type="AABB"> - </argument> - <description> - </description> - </method> - <method name="get_aabb" qualifiers="const"> - <return type="AABB"> - </return> - <description> - </description> - </method> - <method name="generate_aabb"> - <description> - </description> - </method> - </methods> - <constants> - </constants> -</class> -<class name="MultiMeshInstance" inherits="GeometryInstance" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="set_multimesh"> - <argument index="0" name="multimesh" type="Object"> - </argument> - <description> - </description> - </method> - <method name="get_multimesh" qualifiers="const"> - <return type="Object"> - </return> - <description> - </description> - </method> - </methods> - <constants> - </constants> -</class> -<class name="Node" inherits="Object" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="set_name"> - <argument index="0" name="name" type="String"> - </argument> - <description> - </description> - </method> - <method name="get_name" qualifiers="const"> - <return type="String"> - </return> - <description> - </description> - </method> - <method name="add_child"> - <argument index="0" name="node" type="Node"> - </argument> - <description> - </description> - </method> - <method name="remove_child"> - <argument index="0" name="node" type="Node"> - </argument> - <description> - </description> - </method> - <method name="remove_and_delete_child"> - <argument index="0" name="node" type="Node"> - </argument> - <description> - </description> - </method> - <method name="get_child_count" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="get_child" qualifiers="const"> - <return type="Node"> - </return> - <argument index="0" name="idx" type="int"> - </argument> - <description> - </description> - </method> - <method name="has_node" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="path" type="NodePath"> - </argument> - <description> - </description> - </method> - <method name="get_node" qualifiers="const"> - <return type="Node"> - </return> - <argument index="0" name="path" type="NodePath"> - </argument> - <description> - </description> - </method> - <method name="get_parent" qualifiers="const"> - <return type="Parent"> - </return> - <description> - </description> - </method> - <method name="has_node_and_resource" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="path" type="NodePath"> - </argument> - <description> - </description> - </method> - <method name="get_node_and_resource"> - <return type="Array"> - </return> - <argument index="0" name="path" type="NodePath"> - </argument> - <description> - </description> - </method> - <method name="is_inside_scene" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="is_a_parent_of" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="node" type="Node"> - </argument> - <description> - </description> - </method> - <method name="is_greater_than" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="node" type="Node"> - </argument> - <description> - </description> - </method> - <method name="get_path" qualifiers="const"> - <return type="NodePath"> - </return> - <description> - </description> - </method> - <method name="get_path_to" qualifiers="const"> - <return type="NodePath"> - </return> - <argument index="0" name="node" type="Node"> - </argument> - <description> - </description> - </method> - <method name="add_to_group"> - <argument index="0" name="group" type="String"> - </argument> - <argument index="1" name="arg1" type="bool" default="false"> - </argument> - <description> - </description> - </method> - <method name="remove_from_group"> - <argument index="0" name="group" type="String"> - </argument> - <description> - </description> - </method> - <method name="is_in_group" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="group" type="String"> - </argument> - <description> - </description> - </method> - <method name="move_child"> - <argument index="0" name="child_node" type="Node"> - </argument> - <argument index="1" name="to_pos" type="int"> - </argument> - <description> - </description> - </method> - <method name="raise"> - <description> - </description> - </method> - <method name="set_owner"> - <argument index="0" name="owner" type="Node"> - </argument> - <description> - </description> - </method> - <method name="get_owner" qualifiers="const"> - <return type="Node"> - </return> - <description> - </description> - </method> - <method name="remove_and_skip"> - <description> - </description> - </method> - <method name="get_index" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="print_tree"> - <description> - </description> - </method> - <method name="set_filename"> - <argument index="0" name="filename" type="String"> - </argument> - <description> - </description> - </method> - <method name="get_filename" qualifiers="const"> - <return type="String"> - </return> - <description> - </description> - </method> - <method name="propagate_notification"> - <argument index="0" name="what" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_process"> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - </description> - </method> - <method name="get_process_time" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - <method name="is_processing" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_idle_process"> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - </description> - </method> - <method name="get_idle_process_time" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - <method name="is_idle_processing" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_process_input"> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - </description> - </method> - <method name="is_processing_input" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_process_unhandled_input"> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - </description> - </method> - <method name="is_processing_unhandled_input" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_process_mode"> - <argument index="0" name="mode" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_process_mode" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="can_process" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="print_stray_nodes"> - <description> - </description> - </method> - <method name="set_world"> - <argument index="0" name="world" type="World"> - </argument> - <description> - </description> - </method> - <method name="get_world" qualifiers="const"> - <return type="World"> - </return> - <description> - </description> - </method> - <method name="get_current_world" qualifiers="const"> - <return type="World"> - </return> - <description> - </description> - </method> - <method name="get_scene" qualifiers="const"> - <return type="SceneMainLoop"> - </return> - <description> - </description> - </method> - <method name="duplicate" qualifiers="const"> - <return type="Node"> - </return> - <description> - </description> - </method> - <method name="replace_by"> - <argument index="0" name="node" type="Node"> - </argument> - <argument index="1" name="keep_data" type="bool" default="false"> - </argument> - <description> - </description> - </method> - </methods> - <signals> - <signal name="enter_scene"> - <description> - </description> - </signal> - <signal name="renamed"> - <description> - </description> - </signal> - <signal name="exit_scene"> - <description> - </description> - </signal> - </signals> - <constants> - <constant name="NOTIFICATION_ENTER_SCENE" value="10"> - </constant> - <constant name="NOTIFICATION_EXIT_SCENE" value="11"> - </constant> - <constant name="NOTIFICATION_MOVED_IN_PARENT" value="12"> - </constant> - <constant name="NOTIFICATION_CHILDREN_CONFIGURED" value="13"> - </constant> - <constant name="NOTIFICATION_PROCESS" value="16"> - </constant> - <constant name="NOTIFICATION_IDLE_PROCESS" value="17"> - </constant> - <constant name="NOTIFICATION_PARENTED" value="18"> - </constant> - <constant name="NOTIFICATION_UNPARENTED" value="19"> - </constant> - <constant name="NOTIFICATION_ENTER_WORLD" value="20"> - </constant> - <constant name="NOTIFICATION_EXIT_WORLD" value="21"> - </constant> - <constant name="NOTIFICATION_PAUSED" value="14"> - </constant> - <constant name="NOTIFICATION_UNPAUSED" value="15"> - </constant> - <constant name="PROCESS_NORMAL" value="0"> - </constant> - <constant name="PROCESS_PAUSE" value="1"> - </constant> - <constant name="PROCESS_ALWAYS" value="2"> - </constant> - </constants> -</class> -<class name="Node2D" inherits="CanvasItem" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="set_pos"> - <argument index="0" name="pos" type="Vector2"> - </argument> - <description> - </description> - </method> - <method name="set_rot"> - <argument index="0" name="rot" type="real"> - </argument> - <description> - </description> - </method> - <method name="set_scale"> - <argument index="0" name="scale" type="Vector2"> - </argument> - <description> - </description> - </method> - <method name="get_pos" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - </description> - </method> - <method name="get_rot" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - <method name="get_scale" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - </description> - </method> - <method name="get_global_pos" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - </description> - </method> - </methods> - <constants> - </constants> -</class> -<class name="_OS" inherits="Object" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="set_mouse_show"> - <argument index="0" name="show" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_mouse_grab"> - <argument index="0" name="grab" type="bool"> - </argument> - <description> - </description> - </method> - <method name="is_mouse_grab_enabled" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="get_mouse_pos" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - </description> - </method> - <method name="set_clipboard"> - <argument index="0" name="clipboard" type="String"> - </argument> - <description> - </description> - </method> - <method name="get_clipboard" qualifiers="const"> - <return type="String"> - </return> - <description> - </description> - </method> - <method name="set_video_mode"> - <argument index="0" name="size" type="Vector2"> - </argument> - <argument index="1" name="fullscreen" type="bool"> - </argument> - <argument index="2" name="resizable" type="bool"> - </argument> - <argument index="3" name="screen" type="int" default="0"> - </argument> - <description> - </description> - </method> - <method name="get_video_mode_size" qualifiers="const"> - <return type="Vector2"> - </return> - <argument index="0" name="screen" type="int" default="0"> - </argument> - <description> - </description> - </method> - <method name="is_video_mode_fullscreen" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="screen" type="int" default="0"> - </argument> - <description> - </description> - </method> - <method name="is_video_mode_resizable" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="screen" type="int" default="0"> - </argument> - <description> - </description> - </method> - <method name="get_fullscreen_mode_list" qualifiers="const"> - <return type="Array"> - </return> - <argument index="0" name="screen" type="int" default="0"> - </argument> - <description> - </description> - </method> - <method name="set_iterations_per_second"> - <argument index="0" name="iterations_per_second" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_iterations_per_second" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="set_low_processor_usage_mode"> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - </description> - </method> - <method name="is_in_low_processor_usage_mode" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="get_executable_path" qualifiers="const"> - <return type="String"> - </return> - <description> - </description> - </method> - <method name="execute"> - <return type="int"> - </return> - <argument index="0" name="path" type="String"> - </argument> - <argument index="1" name="arguments" type="StringArray"> - </argument> - <argument index="2" name="blocking" type="bool"> - </argument> - <description> - </description> - </method> - <method name="kill"> - <return type="int"> - </return> - <argument index="0" name="pid" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_environment" qualifiers="const"> - <return type="String"> - </return> - <argument index="0" name="environment" type="String"> - </argument> - <description> - </description> - </method> - <method name="has_environment" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="environment" type="String"> - </argument> - <description> - </description> - </method> - <method name="get_name" qualifiers="const"> - <return type="String"> - </return> - <description> - </description> - </method> - <method name="get_cmdline_args"> - <return type="StringArray"> - </return> - <description> - </description> - </method> - <method name="get_main_loop" qualifiers="const"> - <return type="Object"> - </return> - <description> - </description> - </method> - <method name="get_date" qualifiers="const"> - <return type="Dictionary"> - </return> - <description> - </description> - </method> - <method name="get_time" qualifiers="const"> - <return type="Dictionary"> - </return> - <description> - </description> - </method> - <method name="delay_usec" qualifiers="const"> - <argument index="0" name="usec" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_ticks_msec" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="get_locale" qualifiers="const"> - <return type="String"> - </return> - <description> - </description> - </method> - <method name="can_draw" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="get_frames_drawn"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="is_stdout_verbose" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="get_mouse_button_state" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="dump_memory_to_file"> - <argument index="0" name="file" type="String"> - </argument> - <description> - </description> - </method> - <method name="dump_resources_to_file"> - <argument index="0" name="file" type="String"> - </argument> - <description> - </description> - </method> - <method name="print_resources_in_use"> - <argument index="0" name="short" type="bool" default="false"> - </argument> - <description> - </description> - </method> - <method name="print_all_resources"> - <argument index="0" name="tofile" type="String" default=""""> - </argument> - <description> - </description> - </method> - <method name="get_static_memory_usage" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="get_static_memory_peak_usage" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="get_dynamic_memory_usage" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - </methods> - <constants> - <constant name="DAY_SUNDAY" value="0"> - </constant> - <constant name="DAY_MONDAY" value="1"> - </constant> - <constant name="DAY_TUESDAY" value="2"> - </constant> - <constant name="DAY_WEDNESDAY" value="3"> - </constant> - <constant name="DAY_THURSDAY" value="4"> - </constant> - <constant name="DAY_FRIDAY" value="5"> - </constant> - <constant name="DAY_SATURDAY" value="6"> - </constant> - <constant name="MONTH_JANUARY" value="0"> - </constant> - <constant name="MONTH_FEBRUARY" value="1"> - </constant> - <constant name="MONTH_MARCH" value="2"> - </constant> - <constant name="MONTH_APRIL" value="3"> - </constant> - <constant name="MONTH_MAY" value="4"> - </constant> - <constant name="MONTH_JUNE" value="5"> - </constant> - <constant name="MONTH_JULY" value="6"> - </constant> - <constant name="MONTH_AUGUST" value="7"> - </constant> - <constant name="MONTH_SEPTEMBER" value="8"> - </constant> - <constant name="MONTH_OCTOBER" value="9"> - </constant> - <constant name="MONTH_NOVEMBER" value="10"> - </constant> - <constant name="MONTH_DECEMBER" value="11"> - </constant> - </constants> -</class> -<class name="Object" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="get_type" qualifiers="const"> - <return type="String"> - </return> - <description> - </description> - </method> - <method name="is_type" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="type" type="String"> - </argument> - <description> - </description> - </method> - <method name="set"> - <argument index="0" name="property" type="String"> - </argument> - <argument index="1" name="value" type="var"> - </argument> - <description> - </description> - </method> - <method name="get" qualifiers="const"> - <argument index="0" name="property" type="String"> - </argument> - <description> - </description> - </method> - <method name="get_property_list" qualifiers="const"> - <return type="Array"> - </return> - <description> - </description> - </method> - <method name="notification"> - <argument index="0" name="what" type="int"> - </argument> - <argument index="1" name="arg1" type="bool" default="false"> - </argument> - <description> - </description> - </method> - <method name="get_instance_ID" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="set_script"> - <argument index="0" name="script" type="Script"> - </argument> - <description> - </description> - </method> - <method name="get_script" qualifiers="const"> - <return type="Script"> - </return> - <description> - </description> - </method> - <method name="set_meta"> - <argument index="0" name="name" type="String"> - </argument> - <argument index="1" name="value" type="var"> - </argument> - <description> - </description> - </method> - <method name="get_meta" qualifiers="const"> - <argument index="0" name="name" type="String"> - </argument> - <description> - </description> - </method> - <method name="has_meta" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="name" type="String"> - </argument> - <description> - </description> - </method> - <method name="get_meta_list" qualifiers="const"> - <return type="StringArray"> - </return> - <description> - </description> - </method> - <method name="call"> - <argument index="0" name="method" type="String"> - </argument> - <argument index="1" name="arg1" type="var" default="NULL"> - </argument> - <argument index="2" name="arg2" type="var" default="NULL"> - </argument> - <argument index="3" name="arg3" type="var" default="NULL"> - </argument> - <argument index="4" name="arg4" type="var" default="NULL"> - </argument> - <description> - </description> - </method> - <method name="call_deferred"> - <argument index="0" name="method" type="String"> - </argument> - <argument index="1" name="arg1" type="var" default="NULL"> - </argument> - <argument index="2" name="arg2" type="var" default="NULL"> - </argument> - <argument index="3" name="arg3" type="var" default="NULL"> - </argument> - <argument index="4" name="arg4" type="var" default="NULL"> - </argument> - <description> - </description> - </method> - <method name="add_user_signal"> - <argument index="0" name="signal" type="String"> - </argument> - <argument index="1" name="arguments" type="Array" default="Array()"> - </argument> - <description> - </description> - </method> - <method name="emit_signal"> - <argument index="0" name="signal" type="String"> - </argument> - <argument index="1" name="arguments" type="Array" default="Array()"> - </argument> - <description> - </description> - </method> - <method name="get_signal_list" qualifiers="const"> - <return type="Array"> - </return> - <description> - </description> - </method> - <method name="connect"> - <argument index="0" name="signal" type="String"> - </argument> - <argument index="1" name="target" type="Object"> - </argument> - <argument index="2" name="method" type="String"> - </argument> - <argument index="3" name="binds" type="Array" default="Array()"> - </argument> - <argument index="4" name="flags" type="int" default="0"> - </argument> - <description> - </description> - </method> - <method name="disconnect"> - <argument index="0" name="signal" type="String"> - </argument> - <argument index="1" name="target" type="Object"> - </argument> - <argument index="2" name="method" type="String"> - </argument> - <description> - </description> - </method> - <method name="is_connected" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="signal" type="String"> - </argument> - <argument index="1" name="target" type="Object"> - </argument> - <argument index="2" name="method" type="String"> - </argument> - <description> - </description> - </method> - <method name="set_block_signals"> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - </description> - </method> - <method name="is_blocking_signals" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_message_translation"> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - </description> - </method> - <method name="can_translate_messages"> - <argument index="0" name="arg0" type="bool"> - </argument> - <description> - </description> - </method> - <method name="XL_MESSAGE" qualifiers="const"> - <return type="String"> - </return> - <argument index="0" name="message" type="String"> - </argument> - <description> - </description> - </method> - <method name="tr" qualifiers="const"> - <return type="String"> - </return> - <argument index="0" name="message" type="String"> - </argument> - <description> - </description> - </method> - </methods> - <constants> - <constant name="NOTIFICATION_POSTINITIALIZE" value="0"> - </constant> - <constant name="NOTIFICATION_PREDELETE" value="1"> - </constant> - <constant name="CONNECT_DEFERRED" value="1"> - </constant> - <constant name="CONNECT_PERSIST" value="2"> - </constant> - <constant name="CONNECT_ONESHOT" value="4"> - </constant> - </constants> -</class> -<class name="OmniLight" inherits="Light" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - </methods> - <constants> - </constants> -</class> -<class name="OptimizedSaver" inherits="Reference" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="set_target_platform"> - <argument index="0" name="name" type="String"> - </argument> - <description> - </description> - </method> - <method name="get_target_platform" qualifiers="const"> - <return type="String"> - </return> - <description> - </description> - </method> - <method name="set_target_name"> - <argument index="0" name="name" type="String"> - </argument> - <description> - </description> - </method> - <method name="add_property"> - <argument index="0" name="name" type="String"> - </argument> - <argument index="1" name="value" type="var"> - </argument> - <description> - </description> - </method> - <method name="optimize_object"> - <return type="bool"> - </return> - <argument index="0" name="obj" type="Object"> - </argument> - <description> - </description> - </method> - </methods> - <constants> - </constants> -</class> -<class name="OptionButton" inherits="Button" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="add_item"> - <argument index="0" name="label" type="String"> - </argument> - <argument index="1" name="id" type="int" default="-1"> - </argument> - <description> - </description> - </method> - <method name="add_icon_item"> - <argument index="0" name="texture" type="Texture"> - </argument> - <argument index="1" name="label" type="String"> - </argument> - <argument index="2" name="id" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_item_text"> - <argument index="0" name="idx" type="int"> - </argument> - <argument index="1" name="text" type="String"> - </argument> - <description> - </description> - </method> - <method name="set_item_icon"> - <argument index="0" name="idx" type="int"> - </argument> - <argument index="1" name="texture" type="Texture"> - </argument> - <description> - </description> - </method> - <method name="set_item_disabled"> - <argument index="0" name="idx" type="int"> - </argument> - <argument index="1" name="disabled" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_item_ID"> - <argument index="0" name="idx" type="int"> - </argument> - <argument index="1" name="id" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_item_metadata"> - <argument index="0" name="idx" type="int"> - </argument> - <argument index="1" name="metadata" type="var"> - </argument> - <description> - </description> - </method> - <method name="get_item_text" qualifiers="const"> - <return type="String"> - </return> - <argument index="0" name="idx" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_item_icon" qualifiers="const"> - <return type="Texture"> - </return> - <argument index="0" name="idx" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_item_ID" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="idx" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_item_metadata" qualifiers="const"> - <argument index="0" name="idx" type="int"> - </argument> - <description> - </description> - </method> - <method name="is_item_disabled" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="idx" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_item_count" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="add_separator"> - <description> - </description> - </method> - <method name="clear"> - <description> - </description> - </method> - <method name="select"> - <argument index="0" name="arg0" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_selected" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="get_selected_ID" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="get_selected_metadata" qualifiers="const"> - <description> - </description> - </method> - <method name="remove_item"> - <argument index="0" name="idx" type="int"> - </argument> - <description> - </description> - </method> - </methods> - <signals> - <signal name="item_selected"> - <argument index="0" name="ID" type="int"> - </argument> - <description> - </description> - </signal> - </signals> - <constants> - </constants> -</class> -<class name="PHashTranslation" inherits="Translation" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - </methods> - <constants> - </constants> -</class> -<class name="PacketPeer" inherits="Object" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - </methods> - <constants> - </constants> -</class> -<class name="PacketPeerStream" inherits="PacketPeer" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="set_stream_peer"> - <argument index="0" name="peer" type="StreamPeer"> - </argument> - <description> - </description> - </method> - </methods> - <constants> - </constants> -</class> -<class name="Panel" inherits="Control" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - </methods> - <constants> - </constants> -</class> -<class name="ParallaxBackground" inherits="CanvasLayer" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="set_scroll_offset"> - <argument index="0" name="ofs" type="Vector2"> - </argument> - <description> - </description> - </method> - <method name="get_scroll_offset" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - </description> - </method> - <method name="set_scroll_base_offset"> - <argument index="0" name="ofs" type="Vector2"> - </argument> - <description> - </description> - </method> - <method name="get_scroll_base_offset" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - </description> - </method> - <method name="set_scroll_base_scale"> - <argument index="0" name="scale" type="Vector2"> - </argument> - <description> - </description> - </method> - <method name="get_scroll_base_scale" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - </description> - </method> - <method name="set_limit_begin"> - <argument index="0" name="ofs" type="Vector2"> - </argument> - <description> - </description> - </method> - <method name="get_limit_begin" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - </description> - </method> - <method name="set_limit_end"> - <argument index="0" name="ofs" type="Vector2"> - </argument> - <description> - </description> - </method> - <method name="get_limit_end" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - </description> - </method> - </methods> - <constants> - </constants> -</class> -<class name="ParallaxLayer" inherits="Node2D" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="set_motion_scale"> - <argument index="0" name="scale" type="Vector2"> - </argument> - <description> - </description> - </method> - <method name="get_motion_scale" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - </description> - </method> - <method name="set_motion_wrap_begin"> - <argument index="0" name="wrap_begin" type="Vector2"> - </argument> - <description> - </description> - </method> - <method name="get_motion_wrap_begin" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - </description> - </method> - <method name="set_motion_wrap_end"> - <argument index="0" name="wrap_end" type="Vector2"> - </argument> - <description> - </description> - </method> - <method name="get_motion_wrap_end" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - </description> - </method> - </methods> - <constants> - </constants> -</class> -<class name="Particles" inherits="VisualInstance" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="set_amount"> - <argument index="0" name="amount" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_amount" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="set_emitting"> - <argument index="0" name="enabled" type="bool"> - </argument> - <description> - </description> - </method> - <method name="is_emitting" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_visibility_aabb"> - <argument index="0" name="aabb" type="AABB"> - </argument> - <description> - </description> - </method> - <method name="get_visibility_aabb" qualifiers="const"> - <return type="AABB"> - </return> - <description> - </description> - </method> - <method name="set_emission_half_extents"> - <argument index="0" name="half_extents" type="Vector3"> - </argument> - <description> - </description> - </method> - <method name="get_emission_half_extents" qualifiers="const"> - <return type="Vector3"> - </return> - <description> - </description> - </method> - <method name="set_emission_base_velocity"> - <argument index="0" name="base_velocity" type="Vector3"> - </argument> - <description> - </description> - </method> - <method name="get_emission_base_velocity" qualifiers="const"> - <return type="Vector3"> - </return> - <description> - </description> - </method> - <method name="set_emission_points"> - <argument index="0" name="points" type="Vector3Array"> - </argument> - <description> - </description> - </method> - <method name="get_emission_points" qualifiers="const"> - <return type="Vector3Array"> - </return> - <description> - </description> - </method> - <method name="set_gravity_normal"> - <argument index="0" name="normal" type="Vector3"> - </argument> - <description> - </description> - </method> - <method name="get_gravity_normal" qualifiers="const"> - <return type="Vector3"> - </return> - <description> - </description> - </method> - <method name="set_variable"> - <argument index="0" name="variable" type="int"> - </argument> - <argument index="1" name="value" type="real"> - </argument> - <description> - </description> - </method> - <method name="get_variable" qualifiers="const"> - <return type="real"> - </return> - <argument index="0" name="variable" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_randomness"> - <argument index="0" name="variable" type="int"> - </argument> - <argument index="1" name="randomness" type="real"> - </argument> - <description> - </description> - </method> - <method name="get_randomness" qualifiers="const"> - <return type="real"> - </return> - <argument index="0" name="arg0" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_color_phase_pos"> - <argument index="0" name="phase" type="int"> - </argument> - <argument index="1" name="pos" type="real"> - </argument> - <description> - </description> - </method> - <method name="get_color_phase_pos" qualifiers="const"> - <return type="real"> - </return> - <argument index="0" name="phase" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_color_phase_color"> - <argument index="0" name="phase" type="int"> - </argument> - <argument index="1" name="color" type="Color"> - </argument> - <description> - </description> - </method> - <method name="get_color_phase_color" qualifiers="const"> - <return type="Color"> - </return> - <argument index="0" name="phase" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_material"> - <argument index="0" name="material" type="Material"> - </argument> - <description> - </description> - </method> - <method name="get_material" qualifiers="const"> - <return type="Material"> - </return> - <description> - </description> - </method> - <method name="set_emit_timeout"> - <argument index="0" name="arg0" type="real"> - </argument> - <description> - </description> - </method> - <method name="get_emit_timeout" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - <method name="set_height_from_velocity"> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - </description> - </method> - <method name="has_height_from_velocity" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_color_phases"> - <argument index="0" name="count" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_color_phases" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - </methods> - <constants> - <constant name="VAR_LIFETIME" value="0"> - </constant> - <constant name="VAR_SPREAD" value="1"> - </constant> - <constant name="VAR_GRAVITY" value="2"> - </constant> - <constant name="VAR_LINEAR_VELOCITY" value="3"> - </constant> - <constant name="VAR_ANGULAR_VELOCITY" value="4"> - </constant> - <constant name="VAR_LINEAR_ACCELERATION" value="5"> - </constant> - <constant name="VAR_DRAG" value="6"> - </constant> - <constant name="VAR_TANGENTIAL_ACCELERATION" value="7"> - </constant> - <constant name="VAR_INITIAL_SIZE" value="9"> - </constant> - <constant name="VAR_FINAL_SIZE" value="10"> - </constant> - <constant name="VAR_INITIAL_ANGLE" value="11"> - </constant> - <constant name="VAR_HEIGHT" value="12"> - </constant> - <constant name="VAR_HEIGHT_SPEED_SCALE" value="13"> - </constant> - <constant name="VAR_MAX" value="14"> - </constant> - </constants> -</class> -<class name="Particles2D" inherits="Node2D" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="set_emitting"> - <argument index="0" name="active" type="bool"> - </argument> - <description> - </description> - </method> - <method name="is_emitting" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_amount"> - <argument index="0" name="amount" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_amount" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="set_lifetime"> - <argument index="0" name="lifetime" type="real"> - </argument> - <description> - </description> - </method> - <method name="get_lifetime" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - <method name="set_pre_process_time"> - <argument index="0" name="time" type="real"> - </argument> - <description> - </description> - </method> - <method name="get_pre_process_time" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - <method name="set_emit_timeout"> - <argument index="0" name="value" type="real"> - </argument> - <description> - </description> - </method> - <method name="get_emit_timeout" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - <method name="set_param"> - <argument index="0" name="param" type="int"> - </argument> - <argument index="1" name="value" type="real"> - </argument> - <description> - </description> - </method> - <method name="get_param" qualifiers="const"> - <return type="real"> - </return> - <argument index="0" name="param" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_randomness"> - <argument index="0" name="param" type="int"> - </argument> - <argument index="1" name="value" type="real"> - </argument> - <description> - </description> - </method> - <method name="get_randomness" qualifiers="const"> - <return type="real"> - </return> - <argument index="0" name="param" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_texture"> - <argument index="0" name="texture" type="Object"> - </argument> - <description> - </description> - </method> - <method name="get_texture" qualifiers="const"> - <return type="Texture"> - </return> - <description> - </description> - </method> - <method name="set_emissor_offset"> - <argument index="0" name="offset" type="Vector2"> - </argument> - <description> - </description> - </method> - <method name="get_emissor_offset" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - </description> - </method> - <method name="set_emission_half_extents"> - <argument index="0" name="extents" type="Vector2"> - </argument> - <description> - </description> - </method> - <method name="get_emission_half_extents" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - </description> - </method> - <method name="set_color_phases"> - <argument index="0" name="phases" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_color_phases" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="set_color_phase_color"> - <argument index="0" name="phase" type="int"> - </argument> - <argument index="1" name="color" type="Color"> - </argument> - <description> - </description> - </method> - <method name="get_color_phase_color" qualifiers="const"> - <return type="Color"> - </return> - <argument index="0" name="phase" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_color_phase_pos"> - <argument index="0" name="phase" type="int"> - </argument> - <argument index="1" name="pos" type="real"> - </argument> - <description> - </description> - </method> - <method name="get_color_phase_pos" qualifiers="const"> - <return type="real"> - </return> - <argument index="0" name="phase" type="int"> - </argument> - <description> - </description> - </method> - <method name="pre_process"> - <argument index="0" name="time" type="real"> - </argument> - <description> - </description> - </method> - <method name="set_use_local_space"> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - </description> - </method> - <method name="is_using_local_space" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_initial_velocity"> - <argument index="0" name="velocity" type="Vector2"> - </argument> - <description> - </description> - </method> - <method name="get_initial_velocity" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - </description> - </method> - <method name="testee"> - <argument index="0" name="arg0" type="int" default="0"> - </argument> - <argument index="1" name="arg1" type="int" default="1"> - </argument> - <argument index="2" name="arg2" type="int" default="2"> - </argument> - <argument index="3" name="arg3" type="int" default="3"> - </argument> - <argument index="4" name="arg4" type="int" default="4"> - </argument> - <description> - </description> - </method> - </methods> - <constants> - <constant name="PARAM_DIRECTION" value="0"> - </constant> - <constant name="PARAM_SPREAD" value="1"> - </constant> - <constant name="PARAM_LINEAR_VELOCITY" value="2"> - </constant> - <constant name="PARAM_SPIN_VELOCITY" value="3"> - </constant> - <constant name="PARAM_GRAVITY_DIRECTION" value="4"> - </constant> - <constant name="PARAM_GRAVITY_STRENGTH" value="5"> - </constant> - <constant name="PARAM_RADIAL_ACCEL" value="6"> - </constant> - <constant name="PARAM_TANGENTIAL_ACCEL" value="7"> - </constant> - <constant name="PARAM_INITIAL_SIZE" value="9"> - </constant> - <constant name="PARAM_FINAL_SIZE" value="10"> - </constant> - <constant name="PARAM_HUE_VARIATION" value="11"> - </constant> - <constant name="PARAM_MAX" value="12"> - </constant> - <constant name="MAX_COLOR_PHASES" value="4"> - </constant> - </constants> -</class> -<class name="PathRemap" inherits="Object" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="add_remap"> - <argument index="0" name="from" type="String"> - </argument> - <argument index="1" name="to" type="String"> - </argument> - <description> - </description> - </method> - <method name="has_remap"> - <argument index="0" name="path" type="String"> - </argument> - <argument index="1" name="arg1" type="String"> - </argument> - <description> - </description> - </method> - <method name="get_remap" qualifiers="const"> - <return type="String"> - </return> - <argument index="0" name="path" type="String"> - </argument> - <description> - </description> - </method> - <method name="erase_remap"> - <argument index="0" name="path" type="String"> - </argument> - <description> - </description> - </method> - <method name="clear_remaps"> - <description> - </description> - </method> - </methods> - <constants> - </constants> -</class> -<class name="Physics2DDirectBodyState" inherits="Object" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="get_total_gravity" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - </description> - </method> - <method name="get_total_density" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - <method name="get_inverse_mass" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - <method name="get_inverse_inertia" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - <method name="set_linear_velocity"> - <argument index="0" name="velocity" type="Vector2"> - </argument> - <description> - </description> - </method> - <method name="get_linear_velocity" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - </description> - </method> - <method name="set_angular_velocity"> - <argument index="0" name="velocity" type="real"> - </argument> - <description> - </description> - </method> - <method name="get_angular_velocity" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - <method name="set_transform"> - <argument index="0" name="transform" type="Matrix32"> - </argument> - <description> - </description> - </method> - <method name="get_transform" qualifiers="const"> - <return type="Matrix32"> - </return> - <description> - </description> - </method> - <method name="set_sleep_state"> - <argument index="0" name="enabled" type="bool"> - </argument> - <description> - </description> - </method> - <method name="is_sleeping" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="get_contact_count" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="get_contact_local_pos" qualifiers="const"> - <return type="Vector2"> - </return> - <argument index="0" name="contact_idx" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_contact_local_normal" qualifiers="const"> - <return type="Vector2"> - </return> - <argument index="0" name="contact_idx" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_contact_local_shape" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="contact_idx" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_contact_collider" qualifiers="const"> - <return type="RID"> - </return> - <argument index="0" name="contact_idx" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_contact_collider_pos" qualifiers="const"> - <return type="Vector2"> - </return> - <argument index="0" name="contact_idx" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_contact_collider_id" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="contact_idx" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_contact_collider_object" qualifiers="const"> - <return type="Object"> - </return> - <argument index="0" name="contact_idx" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_contact_collider_shape" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="contact_idx" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_contact_collider_velocity_at_pos" qualifiers="const"> - <return type="Vector2"> - </return> - <argument index="0" name="contact_idx" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_step" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - <method name="integrate_forces"> - <description> - </description> - </method> - </methods> - <constants> - </constants> -</class> -<class name="Physics2DDirectBodyStateSW" inherits="Physics2DDirectBodyState" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - </methods> - <constants> - </constants> -</class> -<class name="Physics2DServer" inherits="Object" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="shape_create"> - <return type="RID"> - </return> - <argument index="0" name="type" type="int"> - </argument> - <description> - </description> - </method> - <method name="shape_set_data"> - <argument index="0" name="shape" type="RID"> - </argument> - <argument index="1" name="data" type="var"> - </argument> - <description> - </description> - </method> - <method name="shape_get_type" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="shape" type="RID"> - </argument> - <description> - </description> - </method> - <method name="shape_get_data" qualifiers="const"> - <argument index="0" name="shape" type="RID"> - </argument> - <description> - </description> - </method> - <method name="space_create"> - <return type="RID"> - </return> - <description> - </description> - </method> - <method name="space_set_active"> - <argument index="0" name="space" type="RID"> - </argument> - <argument index="1" name="active" type="bool"> - </argument> - <description> - </description> - </method> - <method name="space_is_active" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="space" type="RID"> - </argument> - <description> - </description> - </method> - <method name="space_set_param"> - <argument index="0" name="space" type="RID"> - </argument> - <argument index="1" name="param" type="int"> - </argument> - <argument index="2" name="value" type="real"> - </argument> - <description> - </description> - </method> - <method name="space_get_param" qualifiers="const"> - <return type="real"> - </return> - <argument index="0" name="space" type="RID"> - </argument> - <argument index="1" name="param" type="int"> - </argument> - <description> - </description> - </method> - <method name="area_create"> - <return type="RID"> - </return> - <description> - </description> - </method> - <method name="area_set_space"> - <argument index="0" name="area" type="RID"> - </argument> - <argument index="1" name="space" type="RID"> - </argument> - <description> - </description> - </method> - <method name="area_get_space" qualifiers="const"> - <return type="RID"> - </return> - <argument index="0" name="area" type="RID"> - </argument> - <description> - </description> - </method> - <method name="area_add_shape"> - <argument index="0" name="area" type="RID"> - </argument> - <argument index="1" name="shape" type="int"> - </argument> - <argument index="2" name="transform" type="RID" default="1,0, 0,1, 0,0"> - </argument> - <description> - </description> - </method> - <method name="area_set_shape" qualifiers="const"> - <return type="RID"> - </return> - <argument index="0" name="area" type="RID"> - </argument> - <argument index="1" name="shape_idx" type="int"> - </argument> - <description> - </description> - </method> - <method name="area_set_shape_transform"> - <argument index="0" name="area" type="RID"> - </argument> - <argument index="1" name="shape_idx" type="int"> - </argument> - <argument index="2" name="transform" type="Matrix32"> - </argument> - <description> - </description> - </method> - <method name="area_get_shape_count" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="area" type="RID"> - </argument> - <description> - </description> - </method> - <method name="area_get_shape" qualifiers="const"> - <return type="RID"> - </return> - <argument index="0" name="area" type="RID"> - </argument> - <argument index="1" name="shape_idx" type="int"> - </argument> - <description> - </description> - </method> - <method name="area_get_shape_transform" qualifiers="const"> - <return type="Matrix32"> - </return> - <argument index="0" name="area" type="RID"> - </argument> - <argument index="1" name="shape_idx" type="int"> - </argument> - <description> - </description> - </method> - <method name="area_remove_shape"> - <argument index="0" name="area" type="RID"> - </argument> - <argument index="1" name="shape_idx" type="int"> - </argument> - <description> - </description> - </method> - <method name="area_clear_shapes"> - <argument index="0" name="area" type="RID"> - </argument> - <description> - </description> - </method> - <method name="area_set_param" qualifiers="const"> - <argument index="0" name="area" type="RID"> - </argument> - <argument index="1" name="param" type="int"> - </argument> - <description> - </description> - </method> - <method name="area_set_transform" qualifiers="const"> - <return type="Matrix32"> - </return> - <argument index="0" name="area" type="RID"> - </argument> - <description> - </description> - </method> - <method name="area_get_param" qualifiers="const"> - <argument index="0" name="area" type="RID"> - </argument> - <argument index="1" name="param" type="int"> - </argument> - <description> - </description> - </method> - <method name="area_get_transform" qualifiers="const"> - <return type="Matrix32"> - </return> - <argument index="0" name="area" type="RID"> - </argument> - <description> - </description> - </method> - <method name="area_attach_object_instance_ID"> - <argument index="0" name="area" type="RID"> - </argument> - <argument index="1" name="id" type="int"> - </argument> - <description> - </description> - </method> - <method name="area_get_object_instance_ID" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="area" type="RID"> - </argument> - <description> - </description> - </method> - <method name="body_create"> - <return type="RID"> - </return> - <argument index="0" name="mode" type="int" default="1"> - </argument> - <argument index="1" name="init_sleeping" type="bool" default="false"> - </argument> - <description> - </description> - </method> - <method name="body_set_space"> - <argument index="0" name="body" type="RID"> - </argument> - <argument index="1" name="space" type="RID"> - </argument> - <description> - </description> - </method> - <method name="body_get_space" qualifiers="const"> - <return type="RID"> - </return> - <argument index="0" name="body" type="RID"> - </argument> - <description> - </description> - </method> - <method name="body_set_mode"> - <argument index="0" name="body" type="RID"> - </argument> - <argument index="1" name="mode" type="int"> - </argument> - <description> - </description> - </method> - <method name="body_get_mode" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="body" type="RID"> - </argument> - <argument index="1" name="arg1" type="int"> - </argument> - <description> - </description> - </method> - <method name="body_add_shape"> - <argument index="0" name="body" type="RID"> - </argument> - <argument index="1" name="shape" type="RID"> - </argument> - <argument index="2" name="transform" type="Matrix32" default="1,0, 0,1, 0,0"> - </argument> - <description> - </description> - </method> - <method name="body_set_shape"> - <argument index="0" name="body" type="RID"> - </argument> - <argument index="1" name="shape_idx" type="int"> - </argument> - <argument index="2" name="shape" type="RID"> - </argument> - <description> - </description> - </method> - <method name="body_set_shape_transform"> - <argument index="0" name="body" type="RID"> - </argument> - <argument index="1" name="shape_idx" type="int"> - </argument> - <argument index="2" name="transform" type="Matrix32"> - </argument> - <description> - </description> - </method> - <method name="body_get_shape_count" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="body" type="RID"> - </argument> - <description> - </description> - </method> - <method name="body_get_shape" qualifiers="const"> - <return type="RID"> - </return> - <argument index="0" name="body" type="RID"> - </argument> - <argument index="1" name="shape_idx" type="int"> - </argument> - <description> - </description> - </method> - <method name="body_get_shape_transform" qualifiers="const"> - <return type="Matrix32"> - </return> - <argument index="0" name="body" type="RID"> - </argument> - <argument index="1" name="shape_idx" type="int"> - </argument> - <description> - </description> - </method> - <method name="body_remove_shape"> - <argument index="0" name="body" type="RID"> - </argument> - <argument index="1" name="shape_idx" type="int"> - </argument> - <description> - </description> - </method> - <method name="body_clear_shapes"> - <argument index="0" name="body" type="RID"> - </argument> - <description> - </description> - </method> - <method name="body_attach_object_instance_ID"> - <argument index="0" name="body" type="RID"> - </argument> - <argument index="1" name="id" type="int"> - </argument> - <description> - </description> - </method> - <method name="body_get_object_instance_ID" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="body" type="RID"> - </argument> - <description> - </description> - </method> - <method name="body_set_enable_continuous_collision_detection"> - <argument index="0" name="body" type="RID"> - </argument> - <argument index="1" name="enable" type="bool"> - </argument> - <description> - </description> - </method> - <method name="body_is_continuous_collision_detection_enabled" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="body" type="RID"> - </argument> - <description> - </description> - </method> - <method name="body_set_param"> - <argument index="0" name="body" type="RID"> - </argument> - <argument index="1" name="param" type="int"> - </argument> - <argument index="2" name="value" type="real"> - </argument> - <description> - </description> - </method> - <method name="body_get_param" qualifiers="const"> - <return type="real"> - </return> - <argument index="0" name="body" type="RID"> - </argument> - <argument index="1" name="param" type="int"> - </argument> - <description> - </description> - </method> - <method name="body_static_simulate_motion"> - <argument index="0" name="body" type="RID"> - </argument> - <argument index="1" name="new_xform" type="Matrix32"> - </argument> - <description> - </description> - </method> - <method name="body_set_state"> - <argument index="0" name="body" type="RID"> - </argument> - <argument index="1" name="state" type="int"> - </argument> - <argument index="2" name="value" type="var"> - </argument> - <description> - </description> - </method> - <method name="body_get_state" qualifiers="const"> - <argument index="0" name="body" type="RID"> - </argument> - <argument index="1" name="state" type="int"> - </argument> - <description> - </description> - </method> - <method name="body_apply_impulse"> - <argument index="0" name="body" type="RID"> - </argument> - <argument index="1" name="pos" type="Vector2"> - </argument> - <argument index="2" name="impulse" type="Vector2"> - </argument> - <description> - </description> - </method> - <method name="body_set_axis_velocity"> - <argument index="0" name="body" type="RID"> - </argument> - <argument index="1" name="axis_velocity" type="Vector2"> - </argument> - <description> - </description> - </method> - <method name="body_add_collision_exception"> - <argument index="0" name="body" type="RID"> - </argument> - <argument index="1" name="excepted_body" type="RID"> - </argument> - <description> - </description> - </method> - <method name="body_remove_collision_exception"> - <argument index="0" name="body" type="RID"> - </argument> - <argument index="1" name="excepted_body" type="RID"> - </argument> - <description> - </description> - </method> - <method name="body_set_max_contacts_reported"> - <argument index="0" name="body" type="RID"> - </argument> - <argument index="1" name="amount" type="int"> - </argument> - <description> - </description> - </method> - <method name="body_get_max_contacts_reported" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="body" type="RID"> - </argument> - <description> - </description> - </method> - <method name="body_set_omit_force_integration"> - <argument index="0" name="body" type="RID"> - </argument> - <argument index="1" name="enable" type="bool"> - </argument> - <description> - </description> - </method> - <method name="body_is_omitting_force_integration" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="body" type="RID"> - </argument> - <description> - </description> - </method> - <method name="pin_joint_create"> - <return type="RID"> - </return> - <argument index="0" name="anchor" type="Vector2"> - </argument> - <argument index="1" name="body_a" type="RID"> - </argument> - <argument index="2" name="body_b" type="RID" default="RID()"> - </argument> - <description> - </description> - </method> - <method name="groove_joint_create"> - <return type="RID"> - </return> - <argument index="0" name="groove1_a" type="Vector2"> - </argument> - <argument index="1" name="groove2_a" type="Vector2"> - </argument> - <argument index="2" name="anchor_b" type="Vector2"> - </argument> - <argument index="3" name="body_a" type="RID" default="RID()"> - </argument> - <argument index="4" name="body_b" type="RID" default="RID()"> - </argument> - <description> - </description> - </method> - <method name="damped_spring_joint_create"> - <return type="RID"> - </return> - <argument index="0" name="anchor_a" type="Vector2"> - </argument> - <argument index="1" name="anchor_b" type="Vector2"> - </argument> - <argument index="2" name="body_a" type="RID"> - </argument> - <argument index="3" name="body_b" type="RID" default="RID()"> - </argument> - <description> - </description> - </method> - <method name="damped_string_joint_set_param"> - <argument index="0" name="joint" type="RID"> - </argument> - <argument index="1" name="param" type="int"> - </argument> - <argument index="2" name="value" type="real" default="RID()"> - </argument> - <description> - </description> - </method> - <method name="damped_string_joint_get_param" qualifiers="const"> - <return type="real"> - </return> - <argument index="0" name="joint" type="RID"> - </argument> - <argument index="1" name="param" type="int"> - </argument> - <description> - </description> - </method> - <method name="joint_get_type" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="joint" type="RID"> - </argument> - <description> - </description> - </method> - <method name="query_create"> - <return type="RID"> - </return> - <argument index="0" name="receiver" type="Object"> - </argument> - <argument index="1" name="callback" type="String"> - </argument> - <argument index="2" name="userdata" type="var" default="NULL"> - </argument> - <argument index="3" name="persist" type="bool" default="true"> - </argument> - <description> - </description> - </method> - <method name="query_body_state"> - <argument index="0" name="query" type="RID"> - </argument> - <argument index="1" name="body" type="RID"> - </argument> - <description> - </description> - </method> - <method name="query_body_direct_state"> - <argument index="0" name="query" type="RID"> - </argument> - <argument index="1" name="body" type="RID"> - </argument> - <description> - </description> - </method> - <method name="query_area"> - <argument index="0" name="query" type="RID"> - </argument> - <argument index="1" name="area" type="RID"> - </argument> - <description> - </description> - </method> - <method name="query_intersection"> - <argument index="0" name="query" type="RID"> - </argument> - <argument index="1" name="space" type="RID"> - </argument> - <argument index="2" name="notify_hint_only" type="bool" default="false"> - </argument> - <argument index="3" name="exclude" type="Array" default="Array()"> - </argument> - <argument index="4" name="usermask" type="int" default="0"> - </argument> - <description> - </description> - </method> - <method name="query_intersection_ray"> - <argument index="0" name="query" type="RID"> - </argument> - <argument index="1" name="from" type="Vector2"> - </argument> - <argument index="2" name="dir" type="Vector2"> - </argument> - <description> - </description> - </method> - <method name="query_intersection_segment"> - <argument index="0" name="query" type="RID"> - </argument> - <argument index="1" name="from" type="Vector2"> - </argument> - <argument index="2" name="to" type="Vector2"> - </argument> - <description> - </description> - </method> - <method name="query_intersection_shape"> - <argument index="0" name="query" type="RID"> - </argument> - <argument index="1" name="shape" type="RID"> - </argument> - <argument index="2" name="transform" type="Matrix32"> - </argument> - <description> - </description> - </method> - <method name="query_clear"> - <argument index="0" name="query" type="RID"> - </argument> - <description> - </description> - </method> - <method name="query_get_type" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="query" type="RID"> - </argument> - <description> - </description> - </method> - <method name="query_get_target" qualifiers="const"> - <return type="RID"> - </return> - <argument index="0" name="query" type="RID"> - </argument> - <description> - </description> - </method> - <method name="free"> - <argument index="0" name="rid" type="RID"> - </argument> - <description> - </description> - </method> - <method name="set_active"> - <argument index="0" name="active" type="bool"> - </argument> - <description> - </description> - </method> - </methods> - <constants> - <constant name="SHAPE_LINE" value="0"> - </constant> - <constant name="SHAPE_SEGMENT" value="1"> - </constant> - <constant name="SHAPE_CIRCLE" value="2"> - </constant> - <constant name="SHAPE_RECTANGLE" value="3"> - </constant> - <constant name="SHAPE_CAPSULE" value="4"> - </constant> - <constant name="SHAPE_CONVEX_POLYGON" value="5"> - </constant> - <constant name="SHAPE_CONCAVE_POLYGON" value="6"> - </constant> - <constant name="SHAPE_CUSTOM" value="7"> - </constant> - <constant name="AREA_PARAM_OVERRIDE_PARAMS" value="0"> - </constant> - <constant name="AREA_PARAM_GRAVITY" value="1"> - </constant> - <constant name="AREA_PARAM_GRAVITY_VECTOR" value="2"> - </constant> - <constant name="AREA_PARAM_GRAVITY_IS_POINT" value="3"> - </constant> - <constant name="AREA_PARAM_GRAVITY_POINT_ATTENUATION" value="4"> - </constant> - <constant name="AREA_PARAM_DENSITY" value="5"> - </constant> - <constant name="AREA_PARAM_PRIORITY" value="6"> - </constant> - <constant name="BODY_MODE_STATIC" value="0"> - </constant> - <constant name="BODY_MODE_RIGID" value="1"> - </constant> - <constant name="BODY_MODE_CHARACTER" value="2"> - </constant> - <constant name="BODY_PARAM_BOUNCE" value="0"> - </constant> - <constant name="BODY_PARAM_FRICTION" value="1"> - </constant> - <constant name="BODY_PARAM_MASS" value="2"> - </constant> - <constant name="BODY_PARAM_MAX" value="3"> - </constant> - <constant name="BODY_STATE_TRANSFORM" value="0"> - </constant> - <constant name="BODY_STATE_LINEAR_VELOCITY" value="1"> - </constant> - <constant name="BODY_STATE_ANGULAR_VELOCITY" value="2"> - </constant> - <constant name="BODY_STATE_SLEEPING" value="3"> - </constant> - <constant name="JOINT_PIN" value="0"> - </constant> - <constant name="JOINT_GROOVE" value="1"> - </constant> - <constant name="JOINT_DAMPED_SPRING" value="2"> - </constant> - <constant name="DAMPED_STRING_REST_LENGTH" value="0"> - </constant> - <constant name="DAMPED_STRING_STIFFNESS" value="1"> - </constant> - <constant name="DAMPED_STRING_DAMPING" value="2"> - </constant> - <constant name="TYPE_BODY" value="0"> - </constant> - <constant name="TYPE_AREA" value="1"> - </constant> - <constant name="AREA_BODY_ADDED" value="0"> - </constant> - <constant name="AREA_BODY_REMOVED" value="1"> - </constant> - <constant name="QUERY_NONE" value="0"> - </constant> - <constant name="QUERY_BODY_STATE" value="1"> - </constant> - <constant name="QUERY_BODY_DIRECT_STATE" value="2"> - </constant> - <constant name="QUERY_AREA_MONITOR" value="3"> - </constant> - <constant name="QUERY_INTERSECTION" value="4"> - </constant> - </constants> -</class> -<class name="Physics2DServerSW" inherits="Physics2DServer" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - </methods> - <constants> - </constants> -</class> -<class name="PhysicsBody" inherits="Spatial" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="add_shape"> - <argument index="0" name="shape" type="Shape"> - </argument> - <argument index="1" name="transform" type="Transform" default="Transform()"> - </argument> - <description> - </description> - </method> - <method name="get_shape_count" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="set_shape"> - <argument index="0" name="shape_idx" type="int"> - </argument> - <argument index="1" name="shape" type="Shape"> - </argument> - <description> - </description> - </method> - <method name="set_shape_transform"> - <argument index="0" name="shape_idx" type="int"> - </argument> - <argument index="1" name="transform" type="Transform"> - </argument> - <description> - </description> - </method> - <method name="get_shape" qualifiers="const"> - <return type="Shape"> - </return> - <argument index="0" name="shape_idx" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_shape_transform" qualifiers="const"> - <return type="Transform"> - </return> - <argument index="0" name="shape_idx" type="int"> - </argument> - <description> - </description> - </method> - <method name="remove_shape"> - <argument index="0" name="shape_idx" type="int"> - </argument> - <description> - </description> - </method> - <method name="clear_shapes"> - <description> - </description> - </method> - <method name="get_body" qualifiers="const"> - <return type="RID"> - </return> - <description> - </description> - </method> - <method name="set_max_contacts_reported"> - <argument index="0" name="contacts" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_max_contacts_reported" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="set_contacts_reported_depth_treshold"> - <argument index="0" name="depth" type="real"> - </argument> - <description> - </description> - </method> - <method name="get_contacts_reported_depth_treshold" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - </methods> - <constants> - </constants> -</class> -<class name="PhysicsBody2D" inherits="CollisionObject2D" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - </methods> - <constants> - </constants> -</class> -<class name="PhysicsDirectBodyState" inherits="Object" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="get_total_gravity" qualifiers="const"> - <return type="Vector3"> - </return> - <description> - </description> - </method> - <method name="get_total_density" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - <method name="get_inverse_mass" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - <method name="get_inverse_inertia_tensor" qualifiers="const"> - <return type="Matrix3"> - </return> - <description> - </description> - </method> - <method name="set_linear_velocity"> - <argument index="0" name="velocity" type="Vector3"> - </argument> - <description> - </description> - </method> - <method name="get_linear_velocity" qualifiers="const"> - <return type="Vector3"> - </return> - <description> - </description> - </method> - <method name="set_angular_velocity"> - <argument index="0" name="velocity" type="Vector3"> - </argument> - <description> - </description> - </method> - <method name="get_angular_velocity" qualifiers="const"> - <return type="Vector3"> - </return> - <description> - </description> - </method> - <method name="set_transform"> - <argument index="0" name="transform" type="Transform"> - </argument> - <description> - </description> - </method> - <method name="get_transform" qualifiers="const"> - <return type="Transform"> - </return> - <description> - </description> - </method> - <method name="set_sleep_state"> - <argument index="0" name="enabled" type="bool"> - </argument> - <description> - </description> - </method> - <method name="is_sleeping" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="get_contact_count" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="get_contact_local_pos" qualifiers="const"> - <return type="Vector3"> - </return> - <argument index="0" name="contact_idx" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_contact_local_normal" qualifiers="const"> - <return type="Vector3"> - </return> - <argument index="0" name="contact_idx" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_contact_local_shape" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="contact_idx" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_contact_collider" qualifiers="const"> - <return type="RID"> - </return> - <argument index="0" name="contact_idx" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_contact_collider_pos" qualifiers="const"> - <return type="Vector3"> - </return> - <argument index="0" name="contact_idx" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_contact_collider_id" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="contact_idx" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_contact_collider_shape" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="contact_idx" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_contact_collider_velocity_at_pos" qualifiers="const"> - <return type="Vector3"> - </return> - <argument index="0" name="contact_idx" type="int"> - </argument> - <description> - </description> - </method> - </methods> - <constants> - </constants> -</class> -<class name="PhysicsDirectBodyStateSW" inherits="PhysicsDirectBodyState" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - </methods> - <constants> - </constants> -</class> -<class name="PhysicsServer" inherits="Object" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="shape_create"> - <return type="RID"> - </return> - <argument index="0" name="shape_type" type="int"> - </argument> - <description> - </description> - </method> - <method name="shape_set_data"> - <argument index="0" name="shape" type="RID"> - </argument> - <argument index="1" name="data" type="var" default="-1"> - </argument> - <description> - </description> - </method> - <method name="shape_get_type" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="shape" type="RID"> - </argument> - <description> - </description> - </method> - <method name="shape_get_data" qualifiers="const"> - <argument index="0" name="shape" type="RID"> - </argument> - <description> - </description> - </method> - <method name="space_create"> - <return type="RID"> - </return> - <description> - </description> - </method> - <method name="area_create"> - <return type="RID"> - </return> - <argument index="0" name="space" type="int"> - </argument> - <argument index="1" name="arg1" type="bool" default="RID()"> - </argument> - <description> - </description> - </method> - <method name="area_set_param"> - <argument index="0" name="area" type="RID"> - </argument> - <argument index="1" name="param" type="int"> - </argument> - <argument index="2" name="value" type="var"> - </argument> - <description> - </description> - </method> - <method name="area_set_shape"> - <argument index="0" name="area" type="RID"> - </argument> - <argument index="1" name="shape" type="RID"> - </argument> - <description> - </description> - </method> - <method name="area_set_bounds"> - <argument index="0" name="area" type="RID"> - </argument> - <argument index="1" name="bounds" type="Dictionary"> - </argument> - <description> - </description> - </method> - <method name="area_set_transform"> - <argument index="0" name="area" type="RID"> - </argument> - <argument index="1" name="transform" type="Transform"> - </argument> - <description> - </description> - </method> - <method name="area_get_param" qualifiers="const"> - <argument index="0" name="area" type="RID"> - </argument> - <argument index="1" name="param" type="int"> - </argument> - <description> - </description> - </method> - <method name="area_get_shape" qualifiers="const"> - <return type="RID"> - </return> - <argument index="0" name="area" type="RID"> - </argument> - <description> - </description> - </method> - <method name="area_get_bounds" qualifiers="const"> - <return type="Dictionary"> - </return> - <argument index="0" name="area" type="RID"> - </argument> - <description> - </description> - </method> - <method name="area_get_transform" qualifiers="const"> - <return type="Transform"> - </return> - <argument index="0" name="area" type="RID"> - </argument> - <description> - </description> - </method> - <method name="body_create"> - <return type="RID"> - </return> - <argument index="0" name="space" type="int"> - </argument> - <argument index="1" name="arg1" type="bool" default="RID()"> - </argument> - <description> - </description> - </method> - <method name="body_set_mode"> - <argument index="0" name="body" type="RID"> - </argument> - <argument index="1" name="mode" type="int"> - </argument> - <description> - </description> - </method> - <method name="body_get_mode" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="body" type="RID"> - </argument> - <argument index="1" name="arg1" type="int"> - </argument> - <description> - </description> - </method> - <method name="body_add_shape"> - <argument index="0" name="body" type="RID"> - </argument> - <argument index="1" name="shape" type="RID"> - </argument> - <argument index="2" name="transform" type="Transform" default="Transform()"> - </argument> - <description> - </description> - </method> - <method name="body_set_shape"> - <argument index="0" name="body" type="RID"> - </argument> - <argument index="1" name="shape_idx" type="int"> - </argument> - <argument index="2" name="shape" type="RID"> - </argument> - <description> - </description> - </method> - <method name="body_set_shape_transform"> - <argument index="0" name="body" type="RID"> - </argument> - <argument index="1" name="shape_idx" type="int"> - </argument> - <argument index="2" name="transform" type="Transform"> - </argument> - <description> - </description> - </method> - <method name="body_get_shape_count" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="body" type="RID"> - </argument> - <description> - </description> - </method> - <method name="body_get_shape" qualifiers="const"> - <return type="RID"> - </return> - <argument index="0" name="body" type="RID"> - </argument> - <argument index="1" name="shape_idx" type="int"> - </argument> - <description> - </description> - </method> - <method name="body_get_shape_transform" qualifiers="const"> - <return type="Transform"> - </return> - <argument index="0" name="body" type="RID"> - </argument> - <argument index="1" name="shape_idx" type="int"> - </argument> - <description> - </description> - </method> - <method name="body_attach_object_instance_ID"> - <argument index="0" name="body" type="RID"> - </argument> - <argument index="1" name="ID" type="int"> - </argument> - <description> - </description> - </method> - <method name="body_get_object_instance_ID" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="body" type="RID"> - </argument> - <description> - </description> - </method> - <method name="body_set_user_flags"> - <argument index="0" name="body" type="RID"> - </argument> - <argument index="1" name="user_flags" type="int"> - </argument> - <description> - </description> - </method> - <method name="body_get_user_flags" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="body" type="RID"> - </argument> - <argument index="1" name="arg1" type="int"> - </argument> - <description> - </description> - </method> - <method name="body_set_param"> - <argument index="0" name="body" type="RID"> - </argument> - <argument index="1" name="param" type="int"> - </argument> - <argument index="2" name="value" type="real"> - </argument> - <description> - </description> - </method> - <method name="body_get_param" qualifiers="const"> - <return type="real"> - </return> - <argument index="0" name="body" type="RID"> - </argument> - <argument index="1" name="param" type="int"> - </argument> - <description> - </description> - </method> - <method name="body_static_simulate_motion"> - <argument index="0" name="body" type="RID"> - </argument> - <argument index="1" name="motion" type="Transform"> - </argument> - <description> - </description> - </method> - <method name="body_set_state"> - <argument index="0" name="body" type="RID"> - </argument> - <argument index="1" name="state" type="int"> - </argument> - <argument index="2" name="value" type="var"> - </argument> - <description> - </description> - </method> - <method name="body_get_state" qualifiers="const"> - <argument index="0" name="body" type="RID"> - </argument> - <argument index="1" name="state" type="int"> - </argument> - <description> - </description> - </method> - <method name="body_set_applied_force"> - <argument index="0" name="body" type="RID"> - </argument> - <argument index="1" name="applied_force" type="Vector3"> - </argument> - <description> - </description> - </method> - <method name="body_get_applied_force" qualifiers="const"> - <return type="Vector3"> - </return> - <argument index="0" name="body" type="RID"> - </argument> - <description> - </description> - </method> - <method name="body_set_applied_torque"> - <argument index="0" name="body" type="RID"> - </argument> - <argument index="1" name="applied_torque" type="Vector3"> - </argument> - <description> - </description> - </method> - <method name="body_get_applied_torque" qualifiers="const"> - <return type="Vector3"> - </return> - <argument index="0" name="body" type="RID"> - </argument> - <description> - </description> - </method> - <method name="body_set_axis_velocity"> - <argument index="0" name="body" type="RID"> - </argument> - <argument index="1" name="axis_velocity" type="Vector3"> - </argument> - <description> - </description> - </method> - <method name="body_apply_impulse"> - <argument index="0" name="body" type="RID"> - </argument> - <argument index="1" name="pos" type="Vector3"> - </argument> - <argument index="2" name="impulse" type="Vector3"> - </argument> - <description> - </description> - </method> - <method name="body_add_collision_exception"> - <argument index="0" name="body" type="RID"> - </argument> - <argument index="1" name="against_body" type="RID"> - </argument> - <description> - </description> - </method> - <method name="body_remove_collision_exception"> - <argument index="0" name="body" type="RID"> - </argument> - <argument index="1" name="against_body" type="RID"> - </argument> - <description> - </description> - </method> - <method name="query_create"> - <return type="RID"> - </return> - <argument index="0" name="receiver" type="Object"> - </argument> - <argument index="1" name="callback" type="String"> - </argument> - <argument index="2" name="userdata" type="var"> - </argument> - <argument index="3" name="persist" type="bool" default="true"> - </argument> - <description> - </description> - </method> - <method name="query_body_state"> - <argument index="0" name="query" type="RID"> - </argument> - <argument index="1" name="body" type="RID"> - </argument> - <description> - </description> - </method> - <method name="query_body_direct_state"> - <argument index="0" name="query" type="RID"> - </argument> - <argument index="1" name="body" type="RID"> - </argument> - <description> - </description> - </method> - <method name="query_area"> - <argument index="0" name="query" type="RID"> - </argument> - <argument index="1" name="area" type="RID"> - </argument> - <description> - </description> - </method> - <method name="query_intersection"> - <argument index="0" name="query" type="RID"> - </argument> - <argument index="1" name="space" type="RID"> - </argument> - <argument index="2" name="exclude" type="Array" default="Array()"> - </argument> - <argument index="3" name="usermask" type="int" default="0"> - </argument> - <description> - </description> - </method> - <method name="query_intersection_ray"> - <argument index="0" name="query" type="RID"> - </argument> - <argument index="1" name="origin" type="Vector3"> - </argument> - <argument index="2" name="dir" type="Vector3"> - </argument> - <description> - </description> - </method> - <method name="query_intersection_segment"> - <argument index="0" name="query" type="RID"> - </argument> - <argument index="1" name="from" type="Vector3"> - </argument> - <argument index="2" name="to" type="Vector3"> - </argument> - <description> - </description> - </method> - <method name="query_intersection_shape"> - <argument index="0" name="query" type="RID"> - </argument> - <argument index="1" name="shape" type="RID"> - </argument> - <argument index="2" name="arg2" type="Transform"> - </argument> - <description> - </description> - </method> - <method name="query_intersection_bounds"> - <argument index="0" name="query" type="RID"> - </argument> - <argument index="1" name="bounds" type="Dictionary"> - </argument> - <argument index="2" name="arg2" type="Transform"> - </argument> - <description> - </description> - </method> - <method name="query_clear"> - <argument index="0" name="query" type="RID"> - </argument> - <description> - </description> - </method> - <method name="query_get_type" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="query" type="RID"> - </argument> - <description> - </description> - </method> - <method name="query_get_target" qualifiers="const"> - <return type="RID"> - </return> - <argument index="0" name="query" type="RID"> - </argument> - <description> - </description> - </method> - <method name="free"> - <argument index="0" name="rid" type="RID"> - </argument> - <description> - </description> - </method> - <method name="set_active"> - <argument index="0" name="active" type="bool"> - </argument> - <description> - </description> - </method> - </methods> - <constants> - <constant name="SHAPE_PLANE" value="0"> - </constant> - <constant name="SHAPE_SPHERE" value="2"> - </constant> - <constant name="SHAPE_BOX" value="3"> - </constant> - <constant name="SHAPE_CAPSULE" value="4"> - </constant> - <constant name="SHAPE_CONVEX_POLYGON" value="5"> - </constant> - <constant name="SHAPE_CONCAVE_POLYGON" value="6"> - </constant> - <constant name="SHAPE_HEIGHTMAP" value="7"> - </constant> - <constant name="SHAPE_CUSTOM" value="8"> - </constant> - <constant name="AREA_PARAM_OVERRIDE_PARAMS" value="0"> - </constant> - <constant name="AREA_PARAM_GRAVITY" value="1"> - </constant> - <constant name="AREA_PARAM_GRAVITY_VECTOR" value="2"> - </constant> - <constant name="AREA_PARAM_GRAVITY_IS_POINT" value="3"> - </constant> - <constant name="AREA_PARAM_GRAVITY_POINT_ATTENUATION" value="4"> - </constant> - <constant name="AREA_PARAM_DENSITY" value="5"> - </constant> - <constant name="AREA_PARAM_PRIORITY" value="6"> - </constant> - <constant name="BODY_MODE_STATIC" value="0"> - </constant> - <constant name="BODY_MODE_RIGID" value="1"> - </constant> - <constant name="BODY_MODE_CHARACTER" value="2"> - </constant> - <constant name="BODY_PARAM_BOUNCE" value="0"> - </constant> - <constant name="BODY_PARAM_FRICTION" value="1"> - </constant> - <constant name="BODY_PARAM_MASS" value="2"> - </constant> - <constant name="BODY_STATE_TRANSFORM" value="0"> - </constant> - <constant name="BODY_STATE_LINEAR_VELOCITY" value="1"> - </constant> - <constant name="BODY_STATE_ANGULAR_VELOCITY" value="2"> - </constant> - <constant name="BODY_STATE_SLEEPING" value="3"> - </constant> - <constant name="HINGE_VAR_ANGULAR_ONLY" value="0"> - </constant> - <constant name="HINGE_VAR_LOWER_LIMIT" value="1"> - </constant> - <constant name="HINGE_VAR_HIGHER_LIMIT" value="2"> - </constant> - <constant name="HINGE_VAR_LIMIT_SOFTNESS" value="3"> - </constant> - <constant name="HINGE_VAR_RELAXATION" value="4"> - </constant> - <constant name="HINGE_VAR_MOTOR_ENABLED" value="5"> - </constant> - <constant name="HINGE_VAR_MOTOR_TARGET_VELOCITY" value="6"> - </constant> - <constant name="HINGE_VAR_MOTOR_IMPULSE" value="7"> - </constant> - <constant name="CONE_TWIST_VAR_SWING_SPAN_LIMIT_1" value="0"> - </constant> - <constant name="CONE_TWIST_VAR_SWING_SPAN_LIMIT_2" value="1"> - </constant> - <constant name="CONE_TWIST_VAR_TWIST_SPAN_LIMIT" value="2"> - </constant> - <constant name="CONE_TWIST_VAR_BIAS" value="3"> - </constant> - <constant name="CONE_TWIST_VAR_RELAXATION" value="4"> - </constant> - <constant name="TYPE_BODY" value="0"> - </constant> - <constant name="TYPE_AREA" value="1"> - </constant> - <constant name="QUERY_NONE" value="0"> - </constant> - <constant name="QUERY_BODY_STATE" value="1"> - </constant> - <constant name="QUERY_BODY_DIRECT_STATE" value="2"> - </constant> - <constant name="QUERY_AREA_MONITOR" value="3"> - </constant> - <constant name="QUERY_INTERSECTION" value="4"> - </constant> - </constants> -</class> -<class name="PhysicsServerSW" inherits="PhysicsServer" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - </methods> - <constants> - </constants> -</class> -<class name="PinJoint2D" inherits="Joint2D" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - </methods> - <constants> - </constants> -</class> -<class name="PlaneShape" inherits="Shape" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="set_plane"> - <argument index="0" name="plane" type="Plane"> - </argument> - <description> - </description> - </method> - <method name="get_plane" qualifiers="const"> - <return type="Plane"> - </return> - <description> - </description> - </method> - </methods> - <constants> - </constants> -</class> -<class name="Popup" inherits="Control" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="popup_centered"> - <argument index="0" name="size" type="Vector2" default="Vector2(0,0)"> - </argument> - <description> - </description> - </method> - <method name="popup_centered_ratio"> - <argument index="0" name="ratio" type="real" default="0.75"> - </argument> - <description> - </description> - </method> - <method name="popup_centered_minsize"> - <argument index="0" name="minsize" type="Vector2" default="Vector2(0,0)"> - </argument> - <description> - </description> - </method> - <method name="popup"> - <description> - </description> - </method> - <method name="set_exclusive"> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - </description> - </method> - <method name="is_exclusive" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - </methods> - <signals> - <signal name="about_to_show"> - <description> - </description> - </signal> - </signals> - <constants> - <constant name="NOTIFICATION_POST_POPUP" value="80"> - </constant> - </constants> -</class> -<class name="PopupDialog" inherits="Popup" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - </methods> - <constants> - </constants> -</class> -<class name="PopupMenu" inherits="Popup" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="add_icon_item"> - <argument index="0" name="texture" type="Object"> - </argument> - <argument index="1" name="label" type="String"> - </argument> - <argument index="2" name="id" type="int" default="-1"> - </argument> - <argument index="3" name="accel" type="int" default="0"> - </argument> - <description> - </description> - </method> - <method name="add_item"> - <argument index="0" name="label" type="String"> - </argument> - <argument index="1" name="id" type="int" default="-1"> - </argument> - <argument index="2" name="accel" type="int" default="0"> - </argument> - <description> - </description> - </method> - <method name="add_icon_check_item"> - <argument index="0" name="texture" type="Object"> - </argument> - <argument index="1" name="label" type="String"> - </argument> - <argument index="2" name="id" type="int" default="-1"> - </argument> - <argument index="3" name="accel" type="int" default="0"> - </argument> - <description> - </description> - </method> - <method name="add_check_item"> - <argument index="0" name="label" type="String"> - </argument> - <argument index="1" name="id" type="int" default="-1"> - </argument> - <argument index="2" name="accel" type="int" default="0"> - </argument> - <description> - </description> - </method> - <method name="add_submenu_item"> - <argument index="0" name="label" type="String"> - </argument> - <argument index="1" name="submenu" type="int"> - </argument> - <argument index="2" name="id" type="int" default="-1"> - </argument> - <description> - </description> - </method> - <method name="set_item_text"> - <argument index="0" name="idx" type="int"> - </argument> - <argument index="1" name="text" type="String"> - </argument> - <description> - </description> - </method> - <method name="set_item_icon"> - <argument index="0" name="idx" type="int"> - </argument> - <argument index="1" name="icon" type="Object"> - </argument> - <description> - </description> - </method> - <method name="set_item_accelerator"> - <argument index="0" name="idx" type="int"> - </argument> - <argument index="1" name="accel" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_item_metadata"> - <argument index="0" name="idx" type="int"> - </argument> - <argument index="1" name="metadata" type="var"> - </argument> - <description> - </description> - </method> - <method name="set_item_checked"> - <argument index="0" name="idx" type="int"> - </argument> - <argument index="1" name="arg1" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_item_disabled"> - <argument index="0" name="idx" type="int"> - </argument> - <argument index="1" name="disabled" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_item_submenu"> - <argument index="0" name="idx" type="int"> - </argument> - <argument index="1" name="submenu" type="String"> - </argument> - <description> - </description> - </method> - <method name="set_item_as_separator"> - <argument index="0" name="idx" type="int"> - </argument> - <argument index="1" name="enable" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_item_as_checkable"> - <argument index="0" name="idx" type="int"> - </argument> - <argument index="1" name="enable" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_item_ID"> - <argument index="0" name="idx" type="int"> - </argument> - <argument index="1" name="id" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_item_text" qualifiers="const"> - <return type="String"> - </return> - <argument index="0" name="idx" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_item_icon" qualifiers="const"> - <return type="Object"> - </return> - <argument index="0" name="idx" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_item_metadata" qualifiers="const"> - <argument index="0" name="idx" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_item_accelerator" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="idx" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_item_submenu" qualifiers="const"> - <return type="String"> - </return> - <argument index="0" name="idx" type="int"> - </argument> - <description> - </description> - </method> - <method name="is_item_separator" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="idx" type="int"> - </argument> - <description> - </description> - </method> - <method name="is_item_checkable" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="idx" type="int"> - </argument> - <description> - </description> - </method> - <method name="is_item_checked" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="idx" type="int"> - </argument> - <description> - </description> - </method> - <method name="is_item_disabled" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="idx" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_item_ID" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="idx" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_item_index" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="id" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_item_count" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="add_separator"> - <description> - </description> - </method> - <method name="remove_item"> - <argument index="0" name="idx" type="int"> - </argument> - <description> - </description> - </method> - <method name="clear"> - <description> - </description> - </method> - </methods> - <signals> - <signal name="item_pressed"> - <argument index="0" name="ID" type="int"> - </argument> - <description> - </description> - </signal> - </signals> - <constants> - </constants> -</class> -<class name="PopupPanel" inherits="Popup" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - </methods> - <constants> - </constants> -</class> -<class name="Portal" inherits="VisualInstance" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="set_shape"> - <argument index="0" name="points" type="Vector2Array"> - </argument> - <description> - </description> - </method> - <method name="get_shape" qualifiers="const"> - <return type="Vector2Array"> - </return> - <description> - </description> - </method> - <method name="set_enabled"> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - </description> - </method> - <method name="is_enabled" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_disable_distance"> - <argument index="0" name="distance" type="real"> - </argument> - <description> - </description> - </method> - <method name="get_disable_distance" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - <method name="set_disabled_color"> - <argument index="0" name="color" type="Color"> - </argument> - <description> - </description> - </method> - <method name="get_disabled_color" qualifiers="const"> - <return type="Color"> - </return> - <description> - </description> - </method> - <method name="set_connect_range"> - <argument index="0" name="range" type="real"> - </argument> - <description> - </description> - </method> - <method name="get_connect_range" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - </methods> - <constants> - </constants> -</class> -<class name="Position2D" inherits="Node2D" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - </methods> - <constants> - </constants> -</class> -<class name="Position3D" inherits="Spatial" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - </methods> - <constants> - </constants> -</class> -<class name="ProximityGroup" inherits="Spatial" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="set_group_name"> - <argument index="0" name="name" type="String"> - </argument> - <description> - </description> - </method> - <method name="broadcast"> - <argument index="0" name="name" type="String"> - </argument> - <argument index="1" name="parameters" type="var"> - </argument> - <description> - </description> - </method> - <method name="set_dispatch_mode"> - <argument index="0" name="mode" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_grid_radius"> - <argument index="0" name="radius" type="Vector3"> - </argument> - <description> - </description> - </method> - <method name="get_grid_radius" qualifiers="const"> - <return type="Vector3"> - </return> - <description> - </description> - </method> - </methods> - <signals> - <signal name="broadcast"> - <argument index="0" name="name" type="String"> - </argument> - <argument index="1" name="parameters" type="Array"> - </argument> - <description> - </description> - </signal> - </signals> - <constants> - </constants> -</class> -<class name="ProximityGroup2D" inherits="Node2D" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="set_group_size"> - <argument index="0" name="size" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_group_size" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="set_group_notifym"> - <argument index="0" name="notify" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_group_notify" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - </methods> - <signals> - <signal name="grouped"> - <argument index="0" name="pgroup" type="Object"> - </argument> - <description> - </description> - </signal> - <signal name="ungrouped"> - <argument index="0" name="pgroup" type="Object"> - </argument> - <description> - </description> - </signal> - </signals> - <constants> - </constants> -</class> -<class name="Range" inherits="Control" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="get_val" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - <method name="get_value" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - <method name="get_min" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - <method name="get_max" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - <method name="get_step" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - <method name="get_page" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - <method name="get_unit_value" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - <method name="get_rounded_values" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_val"> - <argument index="0" name="value" type="real"> - </argument> - <description> - </description> - </method> - <method name="set_value"> - <argument index="0" name="value" type="real"> - </argument> - <description> - </description> - </method> - <method name="set_min"> - <argument index="0" name="minimum" type="real"> - </argument> - <description> - </description> - </method> - <method name="set_max"> - <argument index="0" name="maximum" type="real"> - </argument> - <description> - </description> - </method> - <method name="set_step"> - <argument index="0" name="step" type="real"> - </argument> - <description> - </description> - </method> - <method name="set_page"> - <argument index="0" name="pagesize" type="real"> - </argument> - <description> - </description> - </method> - <method name="set_unit_value"> - <argument index="0" name="value" type="real"> - </argument> - <description> - </description> - </method> - <method name="set_rounded_values"> - <argument index="0" name="arg0" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_exp_unit_value"> - <argument index="0" name="enabled" type="bool"> - </argument> - <description> - </description> - </method> - <method name="is_unit_value_exp" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="share"> - <argument index="0" name="with" type="Object"> - </argument> - <description> - </description> - </method> - <method name="unshare"> - <description> - </description> - </method> - </methods> - <signals> - <signal name="value_changed"> - <argument index="0" name="value" type="real"> - </argument> - <description> - </description> - </signal> - <signal name="changed"> - <description> - </description> - </signal> - </signals> - <constants> - </constants> -</class> -<class name="RayShape" inherits="Shape" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="set_length"> - <argument index="0" name="length" type="real"> - </argument> - <description> - </description> - </method> - <method name="get_length" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - </methods> - <constants> - </constants> -</class> -<class name="RectangleShape2D" inherits="Shape2D" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="set_extents"> - <argument index="0" name="extents" type="Vector2"> - </argument> - <description> - </description> - </method> - <method name="get_extents" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - </description> - </method> - </methods> - <constants> - </constants> -</class> -<class name="Reference" inherits="Object" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="init_ref"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="reference"> - <description> - </description> - </method> - <method name="unreference"> - <return type="bool"> - </return> - <description> - </description> - </method> - </methods> - <constants> - </constants> -</class> -<class name="ReferenceFrame" inherits="Control" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - </methods> - <constants> - </constants> -</class> -<class name="Resource" inherits="Reference" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="set_path"> - <argument index="0" name="path" type="String"> - </argument> - <description> - </description> - </method> - <method name="get_path" qualifiers="const"> - <return type="String"> - </return> - <description> - </description> - </method> - <method name="set_name"> - <argument index="0" name="name" type="String"> - </argument> - <description> - </description> - </method> - <method name="get_name" qualifiers="const"> - <return type="String"> - </return> - <description> - </description> - </method> - <method name="get_rid" qualifiers="const"> - <return type="RID"> - </return> - <description> - </description> - </method> - </methods> - <signals> - <signal name="changed"> - <description> - </description> - </signal> - </signals> - <constants> - </constants> -</class> -<class name="_ResourceLoader" inherits="Object" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="load"> - <return type="Resource"> - </return> - <argument index="0" name="path" type="String"> - </argument> - <argument index="1" name="type_hint" type="String" default=""""> - </argument> - <description> - </description> - </method> - <method name="get_recognized_extensions_for_type"> - <return type="StringArray"> - </return> - <argument index="0" name="type" type="String"> - </argument> - <description> - </description> - </method> - </methods> - <constants> - </constants> -</class> -<class name="ResourcePreloader" inherits="Node" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="add_resource"> - <argument index="0" name="name" type="String"> - </argument> - <argument index="1" name="resource" type="Object"> - </argument> - <description> - </description> - </method> - <method name="remove_resource"> - <argument index="0" name="name" type="String"> - </argument> - <description> - </description> - </method> - <method name="rename_resource"> - <argument index="0" name="name" type="String"> - </argument> - <argument index="1" name="newname" type="String"> - </argument> - <description> - </description> - </method> - <method name="has_resource" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="name" type="String"> - </argument> - <description> - </description> - </method> - <method name="get_resource" qualifiers="const"> - <return type="Object"> - </return> - <argument index="0" name="name" type="String"> - </argument> - <description> - </description> - </method> - <method name="get_resource_list" qualifiers="const"> - <return type="StringArray"> - </return> - <description> - </description> - </method> - </methods> - <constants> - </constants> -</class> -<class name="_ResourceSaver" inherits="Object" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="save"> - <return type="int"> - </return> - <argument index="0" name="path" type="String"> - </argument> - <argument index="1" name="resource" type="Resource"> - </argument> - <description> - </description> - </method> - <method name="get_recognized_extensions"> - <return type="StringArray"> - </return> - <argument index="0" name="type" type="Object"> - </argument> - <description> - </description> - </method> - </methods> - <constants> - </constants> -</class> -<class name="RichTextLabel" inherits="Control" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="add_text"> - <argument index="0" name="text" type="String"> - </argument> - <description> - </description> - </method> - <method name="add_image"> - <argument index="0" name="image" type="Texture"> - </argument> - <description> - </description> - </method> - <method name="newline"> - <description> - </description> - </method> - <method name="push_font"> - <argument index="0" name="font" type="Object"> - </argument> - <description> - </description> - </method> - <method name="push_color"> - <argument index="0" name="color" type="Color"> - </argument> - <description> - </description> - </method> - <method name="push_align"> - <argument index="0" name="align" type="int"> - </argument> - <description> - </description> - </method> - <method name="push_indent"> - <argument index="0" name="level" type="int"> - </argument> - <description> - </description> - </method> - <method name="push_list"> - <argument index="0" name="type" type="int"> - </argument> - <description> - </description> - </method> - <method name="push_meta"> - <argument index="0" name="data" type="var"> - </argument> - <description> - </description> - </method> - <method name="push_underline"> - <description> - </description> - </method> - <method name="pop"> - <description> - </description> - </method> - <method name="clear"> - <description> - </description> - </method> - <method name="set_meta_underline"> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - </description> - </method> - <method name="is_meta_underlined" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_scroll_active"> - <argument index="0" name="active" type="bool"> - </argument> - <description> - </description> - </method> - <method name="is_scroll_active" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_scroll_follow"> - <argument index="0" name="follow" type="bool"> - </argument> - <description> - </description> - </method> - <method name="is_scroll_following" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_tab_size"> - <argument index="0" name="spaces" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_tab_size" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - </methods> - <signals> - <signal name="meta_clicked"> - <argument index="0" name="meta" type="Nil"> - </argument> - <description> - </description> - </signal> - </signals> - <constants> - <constant name="ALIGN_LEFT" value="0"> - </constant> - <constant name="ALIGN_CENTER" value="1"> - </constant> - <constant name="ALIGN_RIGHT" value="2"> - </constant> - <constant name="ALIGN_FILL" value="3"> - </constant> - <constant name="LIST_NUMBERS" value="0"> - </constant> - <constant name="LIST_LETTERS" value="1"> - </constant> - <constant name="LIST_DOTS" value="2"> - </constant> - <constant name="ITEM_MAIN" value="0"> - </constant> - <constant name="ITEM_TEXT" value="1"> - </constant> - <constant name="ITEM_IMAGE" value="2"> - </constant> - <constant name="ITEM_NEWLINE" value="3"> - </constant> - <constant name="ITEM_FONT" value="4"> - </constant> - <constant name="ITEM_COLOR" value="5"> - </constant> - <constant name="ITEM_UNDERLINE" value="6"> - </constant> - <constant name="ITEM_ALIGN" value="7"> - </constant> - <constant name="ITEM_INDENT" value="8"> - </constant> - <constant name="ITEM_LIST" value="9"> - </constant> - <constant name="ITEM_META" value="10"> - </constant> - </constants> -</class> -<class name="RigidBody2D" inherits="PhysicsBody2D" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="set_mode"> - <argument index="0" name="mode" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_mode" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="set_mass"> - <argument index="0" name="mass" type="real"> - </argument> - <description> - </description> - </method> - <method name="get_mass" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - <method name="set_weight"> - <argument index="0" name="weight" type="real"> - </argument> - <description> - </description> - </method> - <method name="get_weight" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - <method name="set_friction"> - <argument index="0" name="friction" type="real"> - </argument> - <description> - </description> - </method> - <method name="get_friction" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - <method name="set_bounce"> - <argument index="0" name="bounce" type="real"> - </argument> - <description> - </description> - </method> - <method name="get_bounce" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - <method name="set_linear_velocity"> - <argument index="0" name="linear_velocity" type="Vector2"> - </argument> - <description> - </description> - </method> - <method name="get_linear_velocity" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - </description> - </method> - <method name="set_angular_velocity"> - <argument index="0" name="angular_velocity" type="real"> - </argument> - <description> - </description> - </method> - <method name="get_angular_velocity" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - <method name="set_max_contacts_reported"> - <argument index="0" name="amount" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_max_contacts_reported" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="set_use_custom_integrator"> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - </description> - </method> - <method name="is_using_custom_integrator"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_contact_monitor"> - <argument index="0" name="enabled" type="bool"> - </argument> - <description> - </description> - </method> - <method name="is_contact_monitor_enabled" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_use_continuous_collision_detection"> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - </description> - </method> - <method name="is_using_continuous_collision_detection" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_axis_velocity"> - <argument index="0" name="axis_velocity" type="Vector2"> - </argument> - <description> - </description> - </method> - <method name="apply_impulse"> - <argument index="0" name="pos" type="Vector2"> - </argument> - <argument index="1" name="impulse" type="Vector2"> - </argument> - <description> - </description> - </method> - <method name="set_active"> - <argument index="0" name="active" type="bool"> - </argument> - <description> - </description> - </method> - <method name="is_active" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - </methods> - <signals> - <signal name="body_enter"> - <argument index="0" name="body_id" type="int"> - </argument> - <argument index="1" name="body" type="Object"> - </argument> - <description> - </description> - </signal> - <signal name="body_enter_shape"> - <argument index="0" name="body_id" type="int"> - </argument> - <argument index="1" name="body" type="Object"> - </argument> - <argument index="2" name="body_shape" type="int"> - </argument> - <argument index="3" name="local_shape" type="int"> - </argument> - <description> - </description> - </signal> - <signal name="body_exit"> - <argument index="0" name="body_id" type="int"> - </argument> - <argument index="1" name="body" type="Object"> - </argument> - <description> - </description> - </signal> - <signal name="body_exit_shape"> - <argument index="0" name="body_id" type="int"> - </argument> - <argument index="1" name="body" type="Object"> - </argument> - <argument index="2" name="body_shape" type="int"> - </argument> - <argument index="3" name="local_shape" type="int"> - </argument> - <description> - </description> - </signal> - </signals> - <constants> - <constant name="MODE_STATIC" value="1"> - </constant> - <constant name="MODE_RIGID" value="0"> - </constant> - <constant name="MODE_CHARACTER" value="2"> - </constant> - </constants> -</class> -<class name="Room" inherits="Resource" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="set_bounds"> - <argument index="0" name="bsp_tree" type="Dictionary"> - </argument> - <description> - </description> - </method> - <method name="get_bounds" qualifiers="const"> - <return type="Dictionary"> - </return> - <description> - </description> - </method> - <method name="set_geometry_hint"> - <argument index="0" name="triangles" type="Vector3Array"> - </argument> - <description> - </description> - </method> - <method name="get_geometry_hint" qualifiers="const"> - <return type="Vector3Array"> - </return> - <description> - </description> - </method> - </methods> - <constants> - </constants> -</class> -<class name="RoomInstance" inherits="VisualInstance" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="set_room"> - <argument index="0" name="room" type="Room"> - </argument> - <description> - </description> - </method> - <method name="get_room" qualifiers="const"> - <return type="Room"> - </return> - <description> - </description> - </method> - <method name="compute_room_from_subtree"> - <description> - </description> - </method> - <method name="set_simulate_acoustics"> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - </description> - </method> - <method name="is_simulating_acoustics" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - </methods> - <constants> - </constants> -</class> -<class name="SSAOFX" inherits="ScenarioFX" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - </methods> - <constants> - </constants> -</class> -<class name="Sample" inherits="Resource" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="create"> - <argument index="0" name="format" type="int"> - </argument> - <argument index="1" name="stereo" type="bool"> - </argument> - <argument index="2" name="length" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_format" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="is_stereo" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="get_length" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="set_data"> - <argument index="0" name="data" type="RawArray"> - </argument> - <description> - </description> - </method> - <method name="get_data" qualifiers="const"> - <return type="RawArray"> - </return> - <description> - </description> - </method> - <method name="set_mix_rate"> - <argument index="0" name="hz" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_mix_rate" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="set_loop_format"> - <argument index="0" name="format" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_loop_format" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="set_loop_begin"> - <argument index="0" name="pos" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_loop_begin" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="set_loop_end"> - <argument index="0" name="pos" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_loop_end" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - </methods> - <constants> - <constant name="FORMAT_PCM8" value="0"> - </constant> - <constant name="FORMAT_PCM16" value="1"> - </constant> - <constant name="FORMAT_IMA_ADPCM" value="2"> - </constant> - <constant name="LOOP_NONE" value="0"> - </constant> - <constant name="LOOP_FORWARD" value="1"> - </constant> - <constant name="LOOP_PING_PONG" value="2"> - </constant> - </constants> -</class> -<class name="SampleLibrary" inherits="Resource" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="add_sample"> - <argument index="0" name="name" type="String"> - </argument> - <argument index="1" name="sample" type="Sample"> - </argument> - <description> - </description> - </method> - <method name="get_sample" qualifiers="const"> - <return type="Sample"> - </return> - <argument index="0" name="name" type="String"> - </argument> - <description> - </description> - </method> - <method name="has_sample" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="name" type="String"> - </argument> - <description> - </description> - </method> - <method name="remove_sample"> - <argument index="0" name="name" type="String"> - </argument> - <description> - </description> - </method> - </methods> - <constants> - </constants> -</class> -<class name="SamplePlayer" inherits="Node" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="set_sample_library"> - <argument index="0" name="library" type="SampleLibrary"> - </argument> - <description> - </description> - </method> - <method name="get_sample_library" qualifiers="const"> - <return type="SampleLibrary"> - </return> - <description> - </description> - </method> - <method name="set_voice_count"> - <argument index="0" name="max_voices" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_voice_count" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="play"> - <return type="int"> - </return> - <argument index="0" name="name" type="String"> - </argument> - <argument index="1" name="unique" type="bool" default="false"> - </argument> - <description> - </description> - </method> - <method name="stop"> - <argument index="0" name="voice" type="int"> - </argument> - <description> - </description> - </method> - <method name="stop_all"> - <description> - </description> - </method> - <method name="set_mix_rate"> - <argument index="0" name="voice" type="int"> - </argument> - <argument index="1" name="hz" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_pitch_scale"> - <argument index="0" name="voice" type="int"> - </argument> - <argument index="1" name="ratio" type="real"> - </argument> - <description> - </description> - </method> - <method name="set_volume"> - <argument index="0" name="voice" type="int"> - </argument> - <argument index="1" name="nrg" type="real"> - </argument> - <description> - </description> - </method> - <method name="set_volume_db"> - <argument index="0" name="voice" type="int"> - </argument> - <argument index="1" name="nrg" type="real"> - </argument> - <description> - </description> - </method> - <method name="set_pan"> - <argument index="0" name="voice" type="int"> - </argument> - <argument index="1" name="pan" type="real"> - </argument> - <argument index="2" name="depth" type="real" default="0"> - </argument> - <argument index="3" name="height" type="real" default="0"> - </argument> - <description> - </description> - </method> - <method name="set_filter"> - <argument index="0" name="voice" type="int"> - </argument> - <argument index="1" name="type" type="int"> - </argument> - <argument index="2" name="cutoff_hz" type="real"> - </argument> - <argument index="3" name="resonance" type="real"> - </argument> - <argument index="4" name="gain" type="real" default="0"> - </argument> - <description> - </description> - </method> - <method name="set_chorus"> - <argument index="0" name="voice" type="int"> - </argument> - <argument index="1" name="send" type="real"> - </argument> - <description> - </description> - </method> - <method name="set_reverb"> - <argument index="0" name="voice" type="int"> - </argument> - <argument index="1" name="room_type" type="int"> - </argument> - <argument index="2" name="send" type="real"> - </argument> - <description> - </description> - </method> - <method name="get_mix_rate" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="voice" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_pitch_scale" qualifiers="const"> - <return type="real"> - </return> - <argument index="0" name="voice" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_volume" qualifiers="const"> - <return type="real"> - </return> - <argument index="0" name="voice" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_volume_db" qualifiers="const"> - <return type="real"> - </return> - <argument index="0" name="voice" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_pan" qualifiers="const"> - <return type="real"> - </return> - <argument index="0" name="voice" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_pan_depth" qualifiers="const"> - <return type="real"> - </return> - <argument index="0" name="voice" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_pan_height" qualifiers="const"> - <return type="real"> - </return> - <argument index="0" name="voice" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_filter_type" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="voice" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_filter_cutoff" qualifiers="const"> - <return type="real"> - </return> - <argument index="0" name="voice" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_filter_resonance" qualifiers="const"> - <return type="real"> - </return> - <argument index="0" name="voice" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_filter_gain" qualifiers="const"> - <return type="real"> - </return> - <argument index="0" name="voice" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_chorus" qualifiers="const"> - <return type="real"> - </return> - <argument index="0" name="voice" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_reverb_room" qualifiers="const"> - <return type="real"> - </return> - <argument index="0" name="voice" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_reverb" qualifiers="const"> - <return type="real"> - </return> - <argument index="0" name="voice" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_default_pitch_scale"> - <argument index="0" name="ratio" type="real"> - </argument> - <description> - </description> - </method> - <method name="set_default_volume"> - <argument index="0" name="nrg" type="real"> - </argument> - <description> - </description> - </method> - <method name="set_default_volume_db"> - <argument index="0" name="db" type="real"> - </argument> - <description> - </description> - </method> - <method name="set_default_pan"> - <argument index="0" name="pan" type="real"> - </argument> - <argument index="1" name="depth" type="real" default="0"> - </argument> - <argument index="2" name="height" type="real" default="0"> - </argument> - <description> - </description> - </method> - <method name="set_default_filter"> - <argument index="0" name="type" type="int"> - </argument> - <argument index="1" name="cutoff_hz" type="real"> - </argument> - <argument index="2" name="resonance" type="real"> - </argument> - <argument index="3" name="gain" type="real" default="0"> - </argument> - <description> - </description> - </method> - <method name="set_default_chorus"> - <argument index="0" name="send" type="real"> - </argument> - <description> - </description> - </method> - <method name="set_default_reverb"> - <argument index="0" name="room_type" type="int"> - </argument> - <argument index="1" name="send" type="real"> - </argument> - <description> - </description> - </method> - <method name="get_default_pitch_scale" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - <method name="get_default_volume" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - <method name="get_default_volume_db" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - <method name="get_default_pan" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - <method name="get_default_pan_depth" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - <method name="get_default_pan_height" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - <method name="get_default_filter_type" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="get_default_filter_cutoff" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - <method name="get_default_filter_resonance" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - <method name="get_default_filter_gain" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - <method name="get_default_chorus" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - <method name="get_default_reverb_room" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - <method name="get_default_reverb" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - <method name="is_active" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="is_voice_active" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="voice" type="int"> - </argument> - <description> - </description> - </method> - </methods> - <constants> - <constant name="FILTER_NONE" value="0"> - </constant> - <constant name="FILTER_LOWPASS" value="1"> - </constant> - <constant name="FILTER_BANDPASS" value="2"> - </constant> - <constant name="FILTER_HIPASS" value="3"> - </constant> - <constant name="FILTER_NOTCH" value="4"> - </constant> - <constant name="FILTER_PEAK" value="5"> - </constant> - <constant name="FILTER_BANDLIMIT" value="6"> - </constant> - <constant name="FILTER_LOW_SHELF" value="7"> - </constant> - <constant name="FILTER_HIGH_SHELF" value="8"> - </constant> - <constant name="REVERB_SMALL" value="0"> - </constant> - <constant name="REVERB_MEDIUM" value="1"> - </constant> - <constant name="REVERB_LARGE" value="2"> - </constant> - <constant name="REVERB_HALL" value="3"> - </constant> - </constants> -</class> -<class name="ScenarioFX" inherits="Node" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - </methods> - <constants> - </constants> -</class> -<class name="SceneIO" inherits="Object" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="load"> - <return type="Object"> - </return> - <argument index="0" name="path" type="String"> - </argument> - <description> - </description> - </method> - <method name="save"> - <return type="int"> - </return> - <argument index="0" name="path" type="String"> - </argument> - <argument index="1" name="scene" type="Object"> - </argument> - <argument index="2" name="flags" type="int" default="0"> - </argument> - <argument index="3" name="optimizer" type="Object" default="Object()"> - </argument> - <description> - </description> - </method> - <method name="load_interactive"> - <return type="SceneInteractiveLoader"> - </return> - <argument index="0" name="path" type="String"> - </argument> - <description> - </description> - </method> - </methods> - <constants> - </constants> -</class> -<class name="SceneMainLoop" inherits="MainLoop" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="get_default_world" qualifiers="const"> - <return type="World"> - </return> - <description> - </description> - </method> - <method name="get_default_viewport" qualifiers="const"> - <return type="RID"> - </return> - <description> - </description> - </method> - <method name="get_default_viewport_size" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - </description> - </method> - <method name="get_default_canvas" qualifiers="const"> - <return type="Canvas"> - </return> - <description> - </description> - </method> - <method name="get_default_space_2d" qualifiers="const"> - <return type="Space2D"> - </return> - <description> - </description> - </method> - <method name="notify_group"> - <argument index="0" name="call_flags" type="int"> - </argument> - <argument index="1" name="group" type="String"> - </argument> - <argument index="2" name="notification" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_group"> - <argument index="0" name="call_flags" type="int"> - </argument> - <argument index="1" name="group" type="String"> - </argument> - <argument index="2" name="property" type="String"> - </argument> - <argument index="3" name="value" type="var"> - </argument> - <description> - </description> - </method> - <method name="get_root_node"> - <return type="Node"> - </return> - <description> - </description> - </method> - <method name="set_root_node"> - <argument index="0" name="node" type="Node"> - </argument> - <description> - </description> - </method> - <method name="set_auto_accept_quit"> - <argument index="0" name="enabled" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_editor_hint"> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - </description> - </method> - <method name="is_editor_hint" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_pause"> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - </description> - </method> - <method name="is_paused" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_input_as_handled"> - <description> - </description> - </method> - <method name="get_frame" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="quit"> - <description> - </description> - </method> - <method name="call_group"> - <argument index="0" name="flags" type="int"> - </argument> - <argument index="1" name="group" type="String"> - </argument> - <argument index="2" name="method" type="String"> - </argument> - <argument index="3" name="arg0" type="var" default="NULL"> - </argument> - <argument index="4" name="arg1" type="var" default="NULL"> - </argument> - <argument index="5" name="arg2" type="var" default="NULL"> - </argument> - <argument index="6" name="arg3" type="var" default="NULL"> - </argument> - <argument index="7" name="arg4" type="var" default="NULL"> - </argument> - <description> - </description> - </method> - </methods> - <signals> - <signal name="screen_resized"> - <description> - </description> - </signal> - <signal name="node_removed"> - <argument index="0" name="node" type="Object"> - </argument> - <description> - </description> - </signal> - <signal name="tree_changed"> - <description> - </description> - </signal> - </signals> - <constants> - <constant name="GROUP_CALL_DEFAULT" value="0"> - </constant> - <constant name="GROUP_CALL_REVERSE" value="1"> - </constant> - <constant name="GROUP_CALL_REALTIME" value="2"> - </constant> - <constant name="GROUP_CALL_UNIQUE" value="4"> - </constant> - </constants> -</class> -<class name="ScenePreloader" inherits="Resource" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="load_scene"> - <return type="int"> - </return> - <argument index="0" name="path" type="String"> - </argument> - <description> - </description> - </method> - <method name="get_scene_path" qualifiers="const"> - <return type="String"> - </return> - <description> - </description> - </method> - <method name="instance" qualifiers="const"> - <return type="Node"> - </return> - <description> - </description> - </method> - <method name="can_instance" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - </methods> - <constants> - </constants> -</class> -<class name="ScreenProximity2D" inherits="ProximityGroup2D" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="enter_screen"> - <description> - </description> - </method> - <method name="exit_screen"> - <description> - </description> - </method> - </methods> - <signals> - <signal name="enter_screen"> - <description> - </description> - </signal> - <signal name="exit_screen"> - <description> - </description> - </signal> - </signals> - <constants> - </constants> -</class> -<class name="Script" inherits="Resource" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="can_instance" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="instance_has" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="base_object" type="Object"> - </argument> - <description> - </description> - </method> - <method name="has_source_code" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="get_source_code" qualifiers="const"> - <return type="String"> - </return> - <description> - </description> - </method> - <method name="set_source_code"> - <argument index="0" name="source" type="String"> - </argument> - <description> - </description> - </method> - <method name="reload"> - <return type="int"> - </return> - <description> - </description> - </method> - </methods> - <constants> - </constants> -</class> -<class name="ScrollBar" inherits="Range" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="set_custom_step"> - <argument index="0" name="step" type="real"> - </argument> - <description> - </description> - </method> - <method name="get_custom_step" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - </methods> - <constants> - </constants> -</class> -<class name="SegmentShape2D" inherits="Shape2D" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="set_a"> - <argument index="0" name="a" type="Vector2"> - </argument> - <description> - </description> - </method> - <method name="get_a" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - </description> - </method> - <method name="set_b"> - <argument index="0" name="b" type="Vector2"> - </argument> - <description> - </description> - </method> - <method name="get_b" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - </description> - </method> - </methods> - <constants> - </constants> -</class> -<class name="Separator" inherits="Control" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - </methods> - <constants> - </constants> -</class> -<class name="Shader" inherits="Resource" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="set_mode"> - <argument index="0" name="mode" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_mode" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="set_vertex_code"> - <argument index="0" name="code" type="String"> - </argument> - <description> - </description> - </method> - <method name="get_vertex_code" qualifiers="const"> - <return type="String"> - </return> - <description> - </description> - </method> - <method name="set_fragment_code"> - <argument index="0" name="code" type="String"> - </argument> - <description> - </description> - </method> - <method name="get_fragment_code" qualifiers="const"> - <return type="String"> - </return> - <description> - </description> - </method> - <method name="set_use_world_transform"> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - </description> - </method> - <method name="is_using_world_transform" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_param"> - <argument index="0" name="param" type="String"> - </argument> - <argument index="1" name="value" type="var"> - </argument> - <description> - </description> - </method> - <method name="get_param" qualifiers="const"> - <argument index="0" name="param" type="String"> - </argument> - <description> - </description> - </method> - <method name="get_param_list" qualifiers="const"> - <return type="StringArray"> - </return> - <description> - </description> - </method> - </methods> - <constants> - <constant name="MODE_MATERIAL" value="0"> - </constant> - <constant name="MODE_POST_PROCESS" value="1"> - </constant> - </constants> -</class> -<class name="ShaderMaterial" inherits="Material" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="set_shader"> - <argument index="0" name="shader" type="Shader"> - </argument> - <description> - </description> - </method> - <method name="get_shader" qualifiers="const"> - <return type="Shader"> - </return> - <description> - </description> - </method> - </methods> - <constants> - </constants> -</class> -<class name="Shape" inherits="Resource" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - </methods> - <constants> - </constants> -</class> -<class name="Shape2D" inherits="Resource" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - </methods> - <constants> - </constants> -</class> -<class name="Skeleton" inherits="Spatial" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="add_bone"> - <argument index="0" name="name" type="String"> - </argument> - <description> - </description> - </method> - <method name="find_bone" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="name" type="String"> - </argument> - <description> - </description> - </method> - <method name="get_bone_name" qualifiers="const"> - <return type="String"> - </return> - <argument index="0" name="bone_idx" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_bone_parent" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="bone_idx" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_bone_parent"> - <argument index="0" name="bone_idx" type="int"> - </argument> - <argument index="1" name="parent_idx" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_bone_count" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="get_bone_rest" qualifiers="const"> - <return type="Transform"> - </return> - <argument index="0" name="bone_idx" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_bone_rest"> - <argument index="0" name="bone_idx" type="int"> - </argument> - <argument index="1" name="rest" type="Transform"> - </argument> - <description> - </description> - </method> - <method name="bind_child_node_to_bone"> - <argument index="0" name="bone_idx" type="int"> - </argument> - <argument index="1" name="node" type="Node"> - </argument> - <description> - </description> - </method> - <method name="unbind_child_node_from_bone"> - <argument index="0" name="bone_idx" type="int"> - </argument> - <argument index="1" name="node" type="Node"> - </argument> - <description> - </description> - </method> - <method name="get_bound_child_nodes_to_bone" qualifiers="const"> - <return type="Array"> - </return> - <argument index="0" name="bone_idx" type="int"> - </argument> - <description> - </description> - </method> - <method name="clear_bones"> - <description> - </description> - </method> - <method name="get_bone_pose" qualifiers="const"> - <return type="Transform"> - </return> - <argument index="0" name="bone_idx" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_bone_pose"> - <argument index="0" name="bone_idx" type="int"> - </argument> - <argument index="1" name="pose" type="Transform"> - </argument> - <description> - </description> - </method> - <method name="get_bone_custom_pose" qualifiers="const"> - <return type="Transform"> - </return> - <argument index="0" name="bone_idx" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_bone_custom_pose"> - <argument index="0" name="bone_idx" type="int"> - </argument> - <argument index="1" name="custom_pose" type="Transform"> - </argument> - <description> - </description> - </method> - <method name="get_bone_transform" qualifiers="const"> - <return type="Transform"> - </return> - <argument index="0" name="bone_idx" type="int"> - </argument> - <description> - </description> - </method> - </methods> - <constants> - <constant name="NOTIFICATION_UPDATE_SKELETON" value="50"> - </constant> - </constants> -</class> -<class name="SkyBoxFX" inherits="ScenarioFX" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - </methods> - <constants> - </constants> -</class> -<class name="Slider" inherits="Range" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="set_ticks"> - <argument index="0" name="count" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_ticks" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="get_ticks_on_borders" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_ticks_on_borders"> - <argument index="0" name="ticks_on_border" type="bool"> - </argument> - <description> - </description> - </method> - </methods> - <constants> - </constants> -</class> -<class name="SoundRoomParams" inherits="Node" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="set_param"> - <argument index="0" name="param" type="int"> - </argument> - <argument index="1" name="value" type="real"> - </argument> - <description> - </description> - </method> - <method name="get_param" qualifiers="const"> - <return type="real"> - </return> - <argument index="0" name="param" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_reverb_mode"> - <argument index="0" name="reverb_mode" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_reverb_mode" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="set_force_params_to_all_sources"> - <argument index="0" name="enabled" type="bool"> - </argument> - <description> - </description> - </method> - <method name="is_forcing_params_to_all_sources"> - <return type="bool"> - </return> - <description> - </description> - </method> - </methods> - <constants> - </constants> -</class> -<class name="Spatial" inherits="Node" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="set_transform"> - <argument index="0" name="local" type="Transform"> - </argument> - <description> - </description> - </method> - <method name="get_transform" qualifiers="const"> - <return type="Transform"> - </return> - <description> - </description> - </method> - <method name="set_global_transform"> - <argument index="0" name="global" type="Transform"> - </argument> - <description> - </description> - </method> - <method name="get_global_transform" qualifiers="const"> - <return type="Transform"> - </return> - <description> - </description> - </method> - <method name="get_parent_spatial" qualifiers="const"> - <return type="Object"> - </return> - <description> - </description> - </method> - <method name="update_gizmo"> - <description> - </description> - </method> - </methods> - <constants> - <constant name="NOTIFICATION_UPDATE_GIZMO" value="43"> - </constant> - <constant name="NOTIFICATION_TRANSFORM_CHANGED" value="40"> - </constant> - <constant name="NOTIFICATION_SCENARIO_CHANGED" value="41"> - </constant> - </constants> -</class> -<class name="SpatialPlayer" inherits="Spatial" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="set_param"> - <argument index="0" name="param" type="int"> - </argument> - <argument index="1" name="value" type="real"> - </argument> - <description> - </description> - </method> - <method name="get_param" qualifiers="const"> - <return type="real"> - </return> - <argument index="0" name="param" type="int"> - </argument> - <description> - </description> - </method> - </methods> - <constants> - <constant name="PARAM_VOLUME_DB" value="0"> - </constant> - <constant name="PARAM_PITCH_SCALE" value="1"> - </constant> - <constant name="PARAM_ATTENUATION_MIN_DISTANCE" value="2"> - </constant> - <constant name="PARAM_ATTENUATION_MAX_DISTANCE" value="3"> - </constant> - <constant name="PARAM_ATTENUATION_DISTANCE_EXP" value="4"> - </constant> - <constant name="PARAM_EMISSION_CONE_DEGREES" value="5"> - </constant> - <constant name="PARAM_EMISSION_CONE_ATTENUATION_DB" value="6"> - </constant> - <constant name="PARAM_MAX" value="7"> - </constant> - </constants> -</class> -<class name="SpatialSamplePlayer" inherits="SpatialPlayer" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="set_sample_library"> - <argument index="0" name="library" type="SampleLibrary"> - </argument> - <description> - </description> - </method> - <method name="get_sample_library" qualifiers="const"> - <return type="SampleLibrary"> - </return> - <description> - </description> - </method> - <method name="set_polyphony"> - <argument index="0" name="voices" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_polyphony" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="play"> - <return type="int"> - </return> - <argument index="0" name="sample" type="String"> - </argument> - <argument index="1" name="voice" type="int" default="-2"> - </argument> - <description> - </description> - </method> - <method name="voice_set_pitch_scale"> - <argument index="0" name="voice" type="int"> - </argument> - <argument index="1" name="ratio" type="real"> - </argument> - <description> - </description> - </method> - <method name="voice_set_volume_scale_db"> - <argument index="0" name="voice" type="int"> - </argument> - <argument index="1" name="db" type="real"> - </argument> - <description> - </description> - </method> - <method name="is_voice_active" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="voice" type="int"> - </argument> - <description> - </description> - </method> - <method name="stop_voice"> - <argument index="0" name="voice" type="int"> - </argument> - <description> - </description> - </method> - <method name="stop_all"> - <description> - </description> - </method> - </methods> - <constants> - <constant name="INVALID_VOICE" value="-1"> - </constant> - <constant name="NEXT_VOICE" value="-2"> - </constant> - </constants> -</class> -<class name="SpatialSoundServer" inherits="Object" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - </methods> - <constants> - </constants> -</class> -<class name="SpatialSoundServerSW" inherits="SpatialSoundServer" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - </methods> - <constants> - </constants> -</class> -<class name="SpatialStreamPlayer" inherits="SpatialPlayer" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="set_stream"> - <argument index="0" name="stream" type="Stream"> - </argument> - <description> - </description> - </method> - <method name="get_stream" qualifiers="const"> - <return type="Stream"> - </return> - <description> - </description> - </method> - <method name="play"> - <description> - </description> - </method> - <method name="stop"> - <description> - </description> - </method> - <method name="is_playing" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_loop"> - <argument index="0" name="enabled" type="bool"> - </argument> - <description> - </description> - </method> - <method name="has_loop" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="get_stream_name" qualifiers="const"> - <return type="String"> - </return> - <description> - </description> - </method> - <method name="get_loop_count" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="get_pos" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - <method name="seek_pos"> - <argument index="0" name="time" type="real"> - </argument> - <description> - </description> - </method> - </methods> - <constants> - </constants> -</class> -<class name="SphereShape" inherits="Shape" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="set_radius"> - <argument index="0" name="radius" type="real"> - </argument> - <description> - </description> - </method> - <method name="get_radius" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - </methods> - <constants> - </constants> -</class> -<class name="SpinBox" inherits="Range" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="set_suffix"> - <argument index="0" name="suffix" type="String"> - </argument> - <description> - </description> - </method> - <method name="get_suffix" qualifiers="const"> - <return type="String"> - </return> - <description> - </description> - </method> - <method name="set_prefix"> - <argument index="0" name="prefix" type="String"> - </argument> - <description> - </description> - </method> - <method name="get_prefix" qualifiers="const"> - <return type="String"> - </return> - <description> - </description> - </method> - <method name="set_editable"> - <argument index="0" name="editable" type="bool"> - </argument> - <description> - </description> - </method> - <method name="is_editable" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - </methods> - <constants> - </constants> -</class> -<class name="SpotLight" inherits="Light" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - </methods> - <constants> - </constants> -</class> -<class name="Sprite" inherits="Node2D" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="set_texture"> - <argument index="0" name="texture" type="Texture"> - </argument> - <description> - </description> - </method> - <method name="get_texture" qualifiers="const"> - <return type="Texture"> - </return> - <description> - </description> - </method> - <method name="set_centered"> - <argument index="0" name="centered" type="bool"> - </argument> - <description> - </description> - </method> - <method name="is_centered" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_flip_h"> - <argument index="0" name="flip_h" type="bool"> - </argument> - <description> - </description> - </method> - <method name="is_flipped_h" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_flip_v"> - <argument index="0" name="flip_v" type="bool"> - </argument> - <description> - </description> - </method> - <method name="is_flipped_v" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_region"> - <argument index="0" name="enabled" type="bool"> - </argument> - <description> - </description> - </method> - <method name="is_region" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_region_rect"> - <argument index="0" name="rect" type="Rect2"> - </argument> - <description> - </description> - </method> - <method name="get_region_rect" qualifiers="const"> - <return type="Rect2"> - </return> - <description> - </description> - </method> - <method name="set_frame"> - <argument index="0" name="frame" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_frame" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="set_vframes"> - <argument index="0" name="vframes" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_vframes" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="set_hframes"> - <argument index="0" name="hframes" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_hframes" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="set_modulate"> - <argument index="0" name="modulate" type="Color"> - </argument> - <description> - </description> - </method> - <method name="get_modulate" qualifiers="const"> - <return type="Color"> - </return> - <description> - </description> - </method> - </methods> - <constants> - </constants> -</class> -<class name="SquirrelScript" inherits="Script" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - </methods> - <constants> - </constants> -</class> -<class name="StaticBody" inherits="PhysicsBody" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="set_simulated_motion"> - <argument index="0" name="enabled" type="bool"> - </argument> - <description> - </description> - </method> - <method name="is_simulating_motion" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="simulate_motion"> - <argument index="0" name="new_transform" type="Transform"> - </argument> - <description> - </description> - </method> - <method name="create_shapes_from_child_meshes"> - <description> - </description> - </method> - </methods> - <constants> - </constants> -</class> -<class name="StaticBody2D" inherits="PhysicsBody2D" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="set_simulate_motion"> - <argument index="0" name="enabled" type="bool"> - </argument> - <description> - </description> - </method> - <method name="is_simulating_motion" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_constant_linear_velocity"> - <argument index="0" name="vel" type="Vector2"> - </argument> - <description> - </description> - </method> - <method name="set_constant_angular_velocity"> - <argument index="0" name="vel" type="real"> - </argument> - <description> - </description> - </method> - <method name="get_constant_linear_velocity" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - </description> - </method> - <method name="get_constant_angular_velocity" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - </methods> - <constants> - </constants> -</class> -<class name="StreamPeer" inherits="Object" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="put_data"> - <return type="int"> - </return> - <argument index="0" name="data" type="RawArray"> - </argument> - <description> - </description> - </method> - <method name="put_partial_data"> - <return type="Array"> - </return> - <argument index="0" name="data" type="RawArray"> - </argument> - <description> - </description> - </method> - <method name="get_data"> - <return type="Array"> - </return> - <argument index="0" name="bytes" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_partial_data"> - <return type="Array"> - </return> - <argument index="0" name="bytes" type="int"> - </argument> - <description> - </description> - </method> - </methods> - <constants> - </constants> -</class> -<class name="StreamPeerTCP" inherits="StreamPeer" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="connect"> - <return type="int"> - </return> - <argument index="0" name="host" type="String"> - </argument> - <argument index="1" name="ip" type="int"> - </argument> - <description> - </description> - </method> - <method name="is_connected" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="get_connected_host" qualifiers="const"> - <return type="String"> - </return> - <description> - </description> - </method> - <method name="get_connected_port" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="disconnect"> - <description> - </description> - </method> - </methods> - <constants> - </constants> -</class> -<class name="StreamPlayer" inherits="Node" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="set_stream"> - <argument index="0" name="stream" type="Stream"> - </argument> - <description> - </description> - </method> - <method name="get_stream" qualifiers="const"> - <return type="Stream"> - </return> - <description> - </description> - </method> - <method name="play"> - <description> - </description> - </method> - <method name="stop"> - <description> - </description> - </method> - <method name="is_playing" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_paused"> - <argument index="0" name="paused" type="bool"> - </argument> - <description> - </description> - </method> - <method name="is_paused" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_loop"> - <argument index="0" name="enabled" type="bool"> - </argument> - <description> - </description> - </method> - <method name="has_loop" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_volume"> - <argument index="0" name="volume" type="real"> - </argument> - <description> - </description> - </method> - <method name="get_volume" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - <method name="set_volume_db"> - <argument index="0" name="db" type="real"> - </argument> - <description> - </description> - </method> - <method name="get_volume_db" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - <method name="get_stream_name" qualifiers="const"> - <return type="String"> - </return> - <description> - </description> - </method> - <method name="get_loop_count" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="get_pos" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - <method name="seek_pos"> - <argument index="0" name="time" type="real"> - </argument> - <description> - </description> - </method> - <method name="set_autoplay"> - <argument index="0" name="enabled" type="bool"> - </argument> - <description> - </description> - </method> - <method name="has_autoplay" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="get_length" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - </methods> - <constants> - </constants> -</class> -<class name="StyleBox" inherits="Resource" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="test_mask" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="point" type="Vector2"> - </argument> - <argument index="1" name="rect" type="Rect2"> - </argument> - <description> - </description> - </method> - <method name="set_default_margin"> - <argument index="0" name="margin" type="int"> - </argument> - <argument index="1" name="offset" type="real"> - </argument> - <description> - </description> - </method> - <method name="get_default_margin" qualifiers="const"> - <return type="real"> - </return> - <argument index="0" name="margin" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_margin" qualifiers="const"> - <return type="real"> - </return> - <argument index="0" name="margin" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_minimum_size" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - </description> - </method> - <method name="get_center_size" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - </description> - </method> - <method name="get_offset" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - </description> - </method> - <method name="draw" qualifiers="const"> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="Rect2"> - </argument> - <description> - </description> - </method> - </methods> - <constants> - </constants> -</class> -<class name="StyleBoxEmpty" inherits="StyleBox" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - </methods> - <constants> - </constants> -</class> -<class name="StyleBoxFlat" inherits="StyleBox" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="set_bg_color"> - <argument index="0" name="color" type="Color"> - </argument> - <description> - </description> - </method> - <method name="get_bg_color" qualifiers="const"> - <return type="Color"> - </return> - <description> - </description> - </method> - <method name="set_light_color"> - <argument index="0" name="color" type="Color"> - </argument> - <description> - </description> - </method> - <method name="get_light_color" qualifiers="const"> - <return type="Color"> - </return> - <description> - </description> - </method> - <method name="set_dark_color"> - <argument index="0" name="color" type="Color"> - </argument> - <description> - </description> - </method> - <method name="get_dark_color" qualifiers="const"> - <return type="Color"> - </return> - <description> - </description> - </method> - <method name="set_border_size"> - <argument index="0" name="size" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_border_size" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="set_border_blend"> - <argument index="0" name="blend" type="bool"> - </argument> - <description> - </description> - </method> - <method name="get_border_blend" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_draw_center"> - <argument index="0" name="size" type="bool"> - </argument> - <description> - </description> - </method> - <method name="get_draw_center" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - </methods> - <constants> - </constants> -</class> -<class name="StyleBoxImageMask" inherits="StyleBox" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="set_image"> - <argument index="0" name="image" type="Image"> - </argument> - <description> - </description> - </method> - <method name="get_image" qualifiers="const"> - <return type="Image"> - </return> - <description> - </description> - </method> - <method name="set_expand"> - <argument index="0" name="expand" type="bool"> - </argument> - <description> - </description> - </method> - <method name="get_expand" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_expand_margin_size"> - <argument index="0" name="margin" type="int"> - </argument> - <argument index="1" name="size" type="real"> - </argument> - <description> - </description> - </method> - <method name="get_expand_margin_size" qualifiers="const"> - <return type="real"> - </return> - <argument index="0" name="arg0" type="int"> - </argument> - <description> - </description> - </method> - </methods> - <constants> - </constants> -</class> -<class name="StyleBoxTexture" inherits="StyleBox" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="set_texture"> - <argument index="0" name="texture" type="Texture"> - </argument> - <description> - </description> - </method> - <method name="get_texture" qualifiers="const"> - <return type="Texture"> - </return> - <description> - </description> - </method> - <method name="set_margin_size"> - <argument index="0" name="margin" type="int"> - </argument> - <argument index="1" name="size" type="real"> - </argument> - <description> - </description> - </method> - <method name="get_margin_size" qualifiers="const"> - <return type="real"> - </return> - <argument index="0" name="arg0" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_expand_margin_size"> - <argument index="0" name="margin" type="int"> - </argument> - <argument index="1" name="size" type="real"> - </argument> - <description> - </description> - </method> - <method name="get_expand_margin_size" qualifiers="const"> - <return type="real"> - </return> - <argument index="0" name="arg0" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_draw_center"> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - </description> - </method> - <method name="get_draw_center" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - </methods> - <constants> - </constants> -</class> -<class name="SurfaceTool" inherits="Reference" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="begin"> - <argument index="0" name="primitive" type="int"> - </argument> - <description> - </description> - </method> - <method name="add_vertex"> - <argument index="0" name="vertex" type="Vector3"> - </argument> - <description> - </description> - </method> - <method name="add_color"> - <argument index="0" name="color" type="Color"> - </argument> - <description> - </description> - </method> - <method name="add_normal"> - <argument index="0" name="normal" type="Vector3"> - </argument> - <description> - </description> - </method> - <method name="add_tangent"> - <argument index="0" name="tangent" type="Plane"> - </argument> - <description> - </description> - </method> - <method name="add_uv"> - <argument index="0" name="uv" type="Vector3"> - </argument> - <description> - </description> - </method> - <method name="add_uv2"> - <argument index="0" name="uv2" type="Vector3"> - </argument> - <description> - </description> - </method> - <method name="add_bones"> - <argument index="0" name="bones" type="IntArray"> - </argument> - <description> - </description> - </method> - <method name="add_weights"> - <argument index="0" name="weights" type="RealArray"> - </argument> - <description> - </description> - </method> - <method name="set_material"> - <argument index="0" name="material" type="Material"> - </argument> - <description> - </description> - </method> - <method name="index"> - <description> - </description> - </method> - <method name="deindex"> - <description> - </description> - </method> - <method name="generate_flat_normals"> - <description> - </description> - </method> - <method name="generate_smooth_normals"> - <description> - </description> - </method> - <method name="generate_tangents"> - <description> - </description> - </method> - <method name="commit"> - <return type="Mesh"> - </return> - <argument index="0" name="existing" type="Mesh" default="Object()"> - </argument> - <description> - </description> - </method> - <method name="clear"> - <description> - </description> - </method> - </methods> - <constants> - </constants> -</class> -<class name="TCP_Server" inherits="Object" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="listen"> - <return type="int"> - </return> - <argument index="0" name="port" type="int"> - </argument> - <argument index="1" name="accepted_hosts" type="StringArray" default="StringArray()"> - </argument> - <description> - </description> - </method> - <method name="is_connection_available" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="take_connection"> - <return type="Object"> - </return> - <description> - </description> - </method> - <method name="stop"> - <description> - </description> - </method> - </methods> - <constants> - </constants> -</class> -<class name="TabContainer" inherits="Control" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="get_tab_count" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="set_current_tab"> - <argument index="0" name="tab_idx" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_current_tab" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="set_tab_align"> - <argument index="0" name="align" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_tab_align" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="set_tabs_visible"> - <argument index="0" name="visible" type="bool"> - </argument> - <description> - </description> - </method> - <method name="are_tabs_visible" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_tab_title"> - <argument index="0" name="tab_idx" type="int"> - </argument> - <argument index="1" name="title" type="String"> - </argument> - <description> - </description> - </method> - <method name="get_tab_title" qualifiers="const"> - <return type="String"> - </return> - <argument index="0" name="tab_idx" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_tab_icon"> - <argument index="0" name="tab_idx" type="int"> - </argument> - <argument index="1" name="icon" type="Texture"> - </argument> - <description> - </description> - </method> - <method name="get_tab_icon" qualifiers="const"> - <return type="Texture"> - </return> - <argument index="0" name="tab_idx" type="int"> - </argument> - <description> - </description> - </method> - </methods> - <signals> - <signal name="tab_changed"> - <argument index="0" name="tab" type="int"> - </argument> - <description> - </description> - </signal> - </signals> - <constants> - </constants> -</class> -<class name="TestCube" inherits="GeometryInstance" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - </methods> - <constants> - </constants> -</class> -<class name="TextEdit" inherits="Control" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="set_text"> - <argument index="0" name="text" type="String"> - </argument> - <description> - </description> - </method> - <method name="insert_text_at_cursor"> - <argument index="0" name="text" type="String"> - </argument> - <description> - </description> - </method> - <method name="get_line_count" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="get_text"> - <return type="String"> - </return> - <description> - </description> - </method> - <method name="get_line"> - <return type="String"> - </return> - <argument index="0" name="arg0" type="int"> - </argument> - <description> - </description> - </method> - <method name="cursor_set_column"> - <argument index="0" name="column" type="int"> - </argument> - <description> - </description> - </method> - <method name="cursor_set_line"> - <argument index="0" name="line" type="int"> - </argument> - <description> - </description> - </method> - <method name="cursor_get_column" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="cursor_get_line" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="set_readonly"> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_wrap"> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - </description> - </method> - <method name="set_max_chars"> - <argument index="0" name="amount" type="int"> - </argument> - <description> - </description> - </method> - <method name="cut"> - <description> - </description> - </method> - <method name="copy"> - <description> - </description> - </method> - <method name="paste"> - <description> - </description> - </method> - <method name="select_all"> - <description> - </description> - </method> - <method name="select"> - <argument index="0" name="from_line" type="int"> - </argument> - <argument index="1" name="from_column" type="int"> - </argument> - <argument index="2" name="to_line" type="int"> - </argument> - <argument index="3" name="to_column" type="int"> - </argument> - <description> - </description> - </method> - <method name="is_selection_active" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="get_selection_from_line" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="get_selection_from_column" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="get_selection_to_line" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="get_selection_to_column" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="get_selection_text" qualifiers="const"> - <return type="String"> - </return> - <description> - </description> - </method> - <method name="search" qualifiers="const"> - <return type="IntArray"> - </return> - <argument index="0" name="flags" type="String"> - </argument> - <argument index="1" name="from_line" type="int"> - </argument> - <argument index="2" name="from_column" type="int"> - </argument> - <argument index="3" name="to_line" type="int"> - </argument> - <description> - </description> - </method> - <method name="undo"> - <description> - </description> - </method> - <method name="redo"> - <description> - </description> - </method> - <method name="clear_undo_history"> - <description> - </description> - </method> - <method name="set_syntax_coloring"> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - </description> - </method> - <method name="is_syntax_coloring_enabled" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="add_keyword_color"> - <argument index="0" name="keyword" type="String"> - </argument> - <argument index="1" name="color" type="Color"> - </argument> - <description> - </description> - </method> - <method name="add_color_region"> - <argument index="0" name="begin_key" type="String"> - </argument> - <argument index="1" name="end_key" type="String"> - </argument> - <argument index="2" name="color" type="Color"> - </argument> - <argument index="3" name="line_only" type="bool" default="false"> - </argument> - <description> - </description> - </method> - <method name="set_symbol_color"> - <argument index="0" name="color" type="Color"> - </argument> - <description> - </description> - </method> - <method name="set_custom_bg_color"> - <argument index="0" name="color" type="Color"> - </argument> - <description> - </description> - </method> - <method name="clear_colors"> - <description> - </description> - </method> - </methods> - <signals> - <signal name="text_changed"> - <description> - </description> - </signal> - <signal name="cursor_changed"> - <description> - </description> - </signal> - </signals> - <constants> - <constant name="SEARCH_MATCH_CASE" value="1"> - </constant> - <constant name="SEARCH_WHOLE_WORDS" value="2"> - </constant> - <constant name="SEARCH_BACKWARDS" value="4"> - </constant> - </constants> -</class> -<class name="Texture" inherits="Resource" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="create"> - <argument index="0" name="width" type="int"> - </argument> - <argument index="1" name="height" type="int"> - </argument> - <argument index="2" name="format" type="int"> - </argument> - <argument index="3" name="flags" type="int"> - </argument> - <argument index="4" name="arg4" type="int" default="7"> - </argument> - <description> - </description> - </method> - <method name="create_from_image"> - <argument index="0" name="image" type="Image"> - </argument> - <argument index="1" name="flags" type="int" default="7"> - </argument> - <description> - </description> - </method> - <method name="set_flags"> - <argument index="0" name="flags" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_flags" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="get_format" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="load"> - <argument index="0" name="path" type="String"> - </argument> - <description> - </description> - </method> - <method name="set_data"> - <argument index="0" name="image" type="Image"> - </argument> - <argument index="1" name="cube_side" type="int" default="0"> - </argument> - <description> - </description> - </method> - <method name="get_data" qualifiers="const"> - <return type="Image"> - </return> - <argument index="0" name="cube_side" type="int" default="0"> - </argument> - <description> - </description> - </method> - <method name="get_width" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="get_height" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="get_size" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - </description> - </method> - <method name="get_rid" qualifiers="const"> - <return type="RID"> - </return> - <description> - </description> - </method> - <method name="has_alpha" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="draw" qualifiers="const"> - <argument index="0" name="canvas_item" type="RID"> - </argument> - <argument index="1" name="pos" type="Vector2"> - </argument> - <argument index="2" name="modulate" type="Color" default="Color(1,1,1,1)"> - </argument> - <description> - </description> - </method> - </methods> - <constants> - <constant name="FLAG_MIPMAPS" value="1"> - </constant> - <constant name="FLAG_REPEAT" value="2"> - </constant> - <constant name="FLAG_FILTER" value="4"> - </constant> - <constant name="FLAG_CUBEMAP" value="8"> - </constant> - <constant name="FLAG_VIDEO_SURFACE" value="16"> - </constant> - <constant name="FLAGS_DEFAULT" value="7"> - </constant> - <constant name="CUBEMAP_LEFT" value="0"> - </constant> - <constant name="CUBEMAP_RIGHT" value="1"> - </constant> - <constant name="CUBEMAP_BOTTOM" value="2"> - </constant> - <constant name="CUBEMAP_TOP" value="3"> - </constant> - <constant name="CUBEMAP_FRONT" value="4"> - </constant> - <constant name="CUBEMAP_BACK" value="5"> - </constant> - </constants> -</class> -<class name="TextureButton" inherits="BaseButton" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="set_normal_texture"> - <argument index="0" name="texture" type="Texture"> - </argument> - <description> - </description> - </method> - <method name="set_pressed_texture"> - <argument index="0" name="texture" type="Texture"> - </argument> - <description> - </description> - </method> - <method name="set_hover_texture"> - <argument index="0" name="texture" type="Texture"> - </argument> - <description> - </description> - </method> - <method name="set_disabled_texture"> - <argument index="0" name="texture" type="Texture"> - </argument> - <description> - </description> - </method> - <method name="set_focused_texture"> - <argument index="0" name="texture" type="Texture"> - </argument> - <description> - </description> - </method> - <method name="set_click_mask"> - <argument index="0" name="texture:Image" type="Image"> - </argument> - <description> - </description> - </method> - <method name="get_normal_texture" qualifiers="const"> - <return type="Texture"> - </return> - <description> - </description> - </method> - <method name="get_pressed_texture" qualifiers="const"> - <return type="Texture"> - </return> - <description> - </description> - </method> - <method name="get_hover_texture" qualifiers="const"> - <return type="Texture"> - </return> - <description> - </description> - </method> - <method name="get_disabled_texture" qualifiers="const"> - <return type="Texture"> - </return> - <description> - </description> - </method> - <method name="get_focused_texture" qualifiers="const"> - <return type="Texture"> - </return> - <description> - </description> - </method> - <method name="get_click_mask" qualifiers="const"> - <return type="Image"> - </return> - <description> - </description> - </method> - </methods> - <constants> - </constants> -</class> -<class name="TextureFrame" inherits="Control" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="set_texture"> - <argument index="0" name="texture" type="Object"> - </argument> - <description> - </description> - </method> - <method name="get_texture" qualifiers="const"> - <return type="Object"> - </return> - <description> - </description> - </method> - <method name="set_expand"> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - </description> - </method> - <method name="has_expand" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - </methods> - <constants> - </constants> -</class> -<class name="TextureProgress" inherits="Range" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="set_under_texture"> - <argument index="0" name="tex" type="Object"> - </argument> - <description> - </description> - </method> - <method name="get_under_texture" qualifiers="const"> - <return type="Object"> - </return> - <description> - </description> - </method> - <method name="set_progress_texture"> - <argument index="0" name="tex" type="Object"> - </argument> - <description> - </description> - </method> - <method name="get_progress_texture" qualifiers="const"> - <return type="Object"> - </return> - <description> - </description> - </method> - <method name="set_over_texture"> - <argument index="0" name="tex" type="Object"> - </argument> - <description> - </description> - </method> - <method name="get_over_texture" qualifiers="const"> - <return type="Object"> - </return> - <description> - </description> - </method> - </methods> - <constants> - </constants> -</class> -<class name="Theme" inherits="Resource" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="set_icon"> - <argument index="0" name="name" type="String"> - </argument> - <argument index="1" name="type" type="String"> - </argument> - <argument index="2" name="texture" type="Texture"> - </argument> - <description> - </description> - </method> - <method name="get_icon" qualifiers="const"> - <return type="Texture"> - </return> - <argument index="0" name="name" type="String"> - </argument> - <argument index="1" name="type" type="String"> - </argument> - <description> - </description> - </method> - <method name="has_icon" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="name" type="String"> - </argument> - <argument index="1" name="type" type="String"> - </argument> - <description> - </description> - </method> - <method name="clear_icon"> - <argument index="0" name="name" type="String"> - </argument> - <argument index="1" name="type" type="String"> - </argument> - <description> - </description> - </method> - <method name="get_icon_list" qualifiers="const"> - <return type="StringArray"> - </return> - <argument index="0" name="arg0" type="String"> - </argument> - <description> - </description> - </method> - <method name="set_stylebox"> - <argument index="0" name="name" type="String"> - </argument> - <argument index="1" name="type" type="String"> - </argument> - <argument index="2" name="texture" type="StyleBox"> - </argument> - <description> - </description> - </method> - <method name="get_stylebox" qualifiers="const"> - <return type="StyleBox"> - </return> - <argument index="0" name="name" type="String"> - </argument> - <argument index="1" name="type" type="String"> - </argument> - <description> - </description> - </method> - <method name="has_stylebox" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="name" type="String"> - </argument> - <argument index="1" name="type" type="String"> - </argument> - <description> - </description> - </method> - <method name="clear_stylebox"> - <argument index="0" name="name" type="String"> - </argument> - <argument index="1" name="type" type="String"> - </argument> - <description> - </description> - </method> - <method name="get_stylebox_list" qualifiers="const"> - <return type="StringArray"> - </return> - <argument index="0" name="arg0" type="String"> - </argument> - <description> - </description> - </method> - <method name="set_font"> - <argument index="0" name="name" type="String"> - </argument> - <argument index="1" name="type" type="String"> - </argument> - <argument index="2" name="font" type="Font"> - </argument> - <description> - </description> - </method> - <method name="get_font" qualifiers="const"> - <return type="Font"> - </return> - <argument index="0" name="name" type="String"> - </argument> - <argument index="1" name="type" type="String"> - </argument> - <description> - </description> - </method> - <method name="has_font" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="name" type="String"> - </argument> - <argument index="1" name="type" type="String"> - </argument> - <description> - </description> - </method> - <method name="clear_font"> - <argument index="0" name="name" type="String"> - </argument> - <argument index="1" name="type" type="String"> - </argument> - <description> - </description> - </method> - <method name="get_font_list" qualifiers="const"> - <return type="StringArray"> - </return> - <argument index="0" name="arg0" type="String"> - </argument> - <description> - </description> - </method> - <method name="set_color"> - <argument index="0" name="name" type="String"> - </argument> - <argument index="1" name="type" type="String"> - </argument> - <argument index="2" name="color" type="Color"> - </argument> - <description> - </description> - </method> - <method name="get_color" qualifiers="const"> - <return type="Color"> - </return> - <argument index="0" name="name" type="String"> - </argument> - <argument index="1" name="type" type="String"> - </argument> - <description> - </description> - </method> - <method name="has_color" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="name" type="String"> - </argument> - <argument index="1" name="type" type="String"> - </argument> - <description> - </description> - </method> - <method name="clear_color"> - <argument index="0" name="name" type="String"> - </argument> - <argument index="1" name="type" type="String"> - </argument> - <description> - </description> - </method> - <method name="get_color_list" qualifiers="const"> - <return type="StringArray"> - </return> - <argument index="0" name="arg0" type="String"> - </argument> - <description> - </description> - </method> - <method name="set_constant"> - <argument index="0" name="name" type="String"> - </argument> - <argument index="1" name="type" type="String"> - </argument> - <argument index="2" name="constant" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_constant" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="name" type="String"> - </argument> - <argument index="1" name="type" type="String"> - </argument> - <description> - </description> - </method> - <method name="has_constant" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="name" type="String"> - </argument> - <argument index="1" name="type" type="String"> - </argument> - <description> - </description> - </method> - <method name="clear_constant"> - <argument index="0" name="name" type="String"> - </argument> - <argument index="1" name="type" type="String"> - </argument> - <description> - </description> - </method> - <method name="get_constant_list" qualifiers="const"> - <return type="StringArray"> - </return> - <argument index="0" name="arg0" type="String"> - </argument> - <description> - </description> - </method> - <method name="get_type_list" qualifiers="const"> - <return type="StringArray"> - </return> - <argument index="0" name="arg0" type="String"> - </argument> - <description> - </description> - </method> - <method name="copy_default_theme"> - <description> - </description> - </method> - </methods> - <constants> - </constants> -</class> -<class name="TileMap" inherits="Node2D" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="set_tileset"> - <argument index="0" name="tileset" type="TileSet"> - </argument> - <description> - </description> - </method> - <method name="get_tileset" qualifiers="const"> - <return type="TileSet"> - </return> - <description> - </description> - </method> - <method name="set_cell_size"> - <argument index="0" name="size" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_cell_size" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="set_quadrant_size"> - <argument index="0" name="size" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_quadrant_size" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="set_center_x"> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - </description> - </method> - <method name="get_center_x" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_center_y"> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - </description> - </method> - <method name="get_center_y" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_cell"> - <argument index="0" name="x" type="int"> - </argument> - <argument index="1" name="y" type="int"> - </argument> - <argument index="2" name="tile" type="int"> - </argument> - <argument index="3" name="flip_x" type="bool" default="false"> - </argument> - <argument index="4" name="flip_y" type="bool" default="false"> - </argument> - <description> - </description> - </method> - <method name="get_cell" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="x" type="int"> - </argument> - <argument index="1" name="y" type="int"> - </argument> - <description> - </description> - </method> - <method name="is_cell_x_flipped" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="x" type="int"> - </argument> - <argument index="1" name="y" type="int"> - </argument> - <description> - </description> - </method> - <method name="is_cell_y_flipped" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="x" type="int"> - </argument> - <argument index="1" name="y" type="int"> - </argument> - <description> - </description> - </method> - <method name="clear"> - <description> - </description> - </method> - </methods> - <constants> - <constant name="INVALID_CELL" value="-1"> - </constant> - </constants> -</class> -<class name="TileSet" inherits="Resource" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="create_tile"> - <argument index="0" name="id" type="int"> - </argument> - <description> - </description> - </method> - <method name="tile_set_name"> - <argument index="0" name="id" type="int"> - </argument> - <argument index="1" name="name" type="String"> - </argument> - <description> - </description> - </method> - <method name="tile_get_name" qualifiers="const"> - <return type="String"> - </return> - <argument index="0" name="id" type="int"> - </argument> - <description> - </description> - </method> - <method name="tile_set_texture"> - <argument index="0" name="id" type="int"> - </argument> - <argument index="1" name="texture" type="Texture"> - </argument> - <description> - </description> - </method> - <method name="tile_get_texture" qualifiers="const"> - <return type="Texture"> - </return> - <argument index="0" name="id" type="int"> - </argument> - <description> - </description> - </method> - <method name="tile_set_offset"> - <argument index="0" name="id" type="int"> - </argument> - <argument index="1" name="offset" type="Vector2"> - </argument> - <description> - </description> - </method> - <method name="tile_get_offset" qualifiers="const"> - <return type="Vector2"> - </return> - <argument index="0" name="id" type="int"> - </argument> - <description> - </description> - </method> - <method name="tile_set_region"> - <argument index="0" name="id" type="int"> - </argument> - <argument index="1" name="region" type="Rect2"> - </argument> - <description> - </description> - </method> - <method name="tile_get_region" qualifiers="const"> - <return type="Rect2"> - </return> - <argument index="0" name="id" type="int"> - </argument> - <description> - </description> - </method> - <method name="tile_set_shape"> - <argument index="0" name="id" type="int"> - </argument> - <argument index="1" name="shape" type="Shape2D"> - </argument> - <description> - </description> - </method> - <method name="tile_get_shape" qualifiers="const"> - <return type="Shape2D"> - </return> - <argument index="0" name="id" type="int"> - </argument> - <description> - </description> - </method> - <method name="remove_tile"> - <argument index="0" name="id" type="int"> - </argument> - <description> - </description> - </method> - <method name="clear"> - <description> - </description> - </method> - <method name="get_last_unused_tile_id" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="find_tile_by_name" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="name" type="String"> - </argument> - <description> - </description> - </method> - <method name="get_tiles_ids" qualifiers="const"> - <return type="Array"> - </return> - <description> - - </description> - </method> - </methods> - <constants> - </constants> -</class> -<class name="Timer" inherits="Node" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="set_wait_time"> - <argument index="0" name="time_sec" type="real"> - </argument> - <description> - </description> - </method> - <method name="get_wait_time" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - <method name="set_one_shot"> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - </description> - </method> - <method name="is_one_shot" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_autostart"> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - </description> - </method> - <method name="has_autostart" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="start"> - <description> - </description> - </method> - <method name="stop"> - <description> - </description> - </method> - <method name="get_time_left" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - </methods> - <signals> - <signal name="timeout"> - <description> - </description> - </signal> - </signals> - <constants> - </constants> -</class> -<class name="Translation" inherits="Resource" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="set_locale"> - <argument index="0" name="locale" type="String"> - </argument> - <description> - </description> - </method> - <method name="get_locale" qualifiers="const"> - <return type="String"> - </return> - <description> - </description> - </method> - <method name="add_message"> - <argument index="0" name="src_message" type="String"> - </argument> - <argument index="1" name="xlated_message" type="String"> - </argument> - <description> - </description> - </method> - <method name="get_message" qualifiers="const"> - <return type="String"> - </return> - <argument index="0" name="src_message" type="String"> - </argument> - <description> - </description> - </method> - <method name="erase_message"> - <argument index="0" name="src_message" type="String"> - </argument> - <description> - </description> - </method> - <method name="get_message_list" qualifiers="const"> - <return type="StringArray"> - </return> - <description> - </description> - </method> - </methods> - <constants> - </constants> -</class> -<class name="TranslationServer" inherits="Object" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - </methods> - <constants> - </constants> -</class> -<class name="Tree" inherits="Control" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="clear"> - <description> - </description> - </method> - <method name="create_item"> - <return type="TreeItem"> - </return> - <argument index="0" name="parent" type="TreeItem" default="Object()"> - </argument> - <description> - </description> - </method> - <method name="get_root"> - <return type="TreeItem"> - </return> - <description> - </description> - </method> - <method name="set_column_min_width"> - <argument index="0" name="arg0" type="int"> - </argument> - <argument index="1" name="arg1" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_column_expand"> - <argument index="0" name="arg0" type="int"> - </argument> - <argument index="1" name="arg1" type="bool"> - </argument> - <description> - </description> - </method> - <method name="get_column_width" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="arg0" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_hide_root"> - <argument index="0" name="arg0" type="bool"> - </argument> - <description> - </description> - </method> - <method name="get_next_selected"> - <return type="TreeItem"> - </return> - <argument index="0" name="from" type="TreeItem"> - </argument> - <description> - </description> - </method> - <method name="get_selected" qualifiers="const"> - <return type="TreeItem"> - </return> - <description> - </description> - </method> - <method name="get_selected_column" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="get_pressed_button" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="set_select_mode"> - <argument index="0" name="mode" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_columns"> - <argument index="0" name="amount" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_columns" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="get_edited" qualifiers="const"> - <return type="TreeItem"> - </return> - <description> - </description> - </method> - <method name="get_edited_column" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="get_custom_popup_rect" qualifiers="const"> - <return type="Rect2"> - </return> - <description> - </description> - </method> - <method name="get_item_area_rect" qualifiers="const"> - <return type="Rect2"> - </return> - <argument index="0" name="item" type="TreeItem"> - </argument> - <argument index="1" name="column" type="int" default="-1"> - </argument> - <description> - </description> - </method> - <method name="ensure_cursor_is_visible"> - <description> - </description> - </method> - <method name="set_column_titles_visible"> - <argument index="0" name="visible" type="bool"> - </argument> - <description> - </description> - </method> - <method name="are_column_titles_visible" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_column_title"> - <argument index="0" name="column" type="int"> - </argument> - <argument index="1" name="title" type="String"> - </argument> - <description> - </description> - </method> - <method name="get_column_title" qualifiers="const"> - <return type="String"> - </return> - <argument index="0" name="column" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_scroll" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - </description> - </method> - </methods> - <signals> - <signal name="item_activated"> - <description> - </description> - </signal> - <signal name="multi_selected"> - <argument index="0" name="item" type="Object"> - </argument> - <argument index="1" name="column" type="int"> - </argument> - <argument index="2" name="selected" type="bool"> - </argument> - <description> - </description> - </signal> - <signal name="custom_popup_edited"> - <argument index="0" name="arrow_clicked" type="bool"> - </argument> - <description> - </description> - </signal> - <signal name="item_edited"> - <description> - </description> - </signal> - <signal name="item_selected"> - <description> - </description> - </signal> - <signal name="cell_selected"> - <description> - </description> - </signal> - <signal name="button_pressed"> - <argument index="0" name="item" type="Object"> - </argument> - <argument index="1" name="column" type="int"> - </argument> - <argument index="2" name="id" type="int"> - </argument> - <description> - </description> - </signal> - </signals> - <constants> - <constant name="SELECT_SINGLE" value="0"> - </constant> - <constant name="SELECT_ROW" value="1"> - </constant> - <constant name="SELECT_MULTI" value="2"> - </constant> - </constants> -</class> -<class name="TreeItem" inherits="Object" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="set_cell_mode"> - <argument index="0" name="column" type="int"> - </argument> - <argument index="1" name="mode" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_cell_mode" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="column" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_checked"> - <argument index="0" name="column" type="int"> - </argument> - <argument index="1" name="checked" type="bool"> - </argument> - <description> - </description> - </method> - <method name="is_checked" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="column" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_text"> - <argument index="0" name="column" type="int"> - </argument> - <argument index="1" name="text" type="String"> - </argument> - <description> - </description> - </method> - <method name="get_text" qualifiers="const"> - <return type="String"> - </return> - <argument index="0" name="column" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_icon"> - <argument index="0" name="column" type="int"> - </argument> - <argument index="1" name="texture" type="Texture"> - </argument> - <description> - </description> - </method> - <method name="get_icon" qualifiers="const"> - <return type="Texture"> - </return> - <argument index="0" name="column" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_icon_region"> - <argument index="0" name="column" type="int"> - </argument> - <argument index="1" name="region" type="Rect2"> - </argument> - <description> - </description> - </method> - <method name="get_icon_region" qualifiers="const"> - <return type="Rect2"> - </return> - <argument index="0" name="column" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_icon_max_width"> - <argument index="0" name="column" type="int"> - </argument> - <argument index="1" name="width" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_icon_max_width" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="column" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_range"> - <argument index="0" name="column" type="int"> - </argument> - <argument index="1" name="value" type="real"> - </argument> - <description> - </description> - </method> - <method name="get_range" qualifiers="const"> - <return type="real"> - </return> - <argument index="0" name="column" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_range_config"> - <argument index="0" name="column" type="int"> - </argument> - <argument index="1" name="min" type="real"> - </argument> - <argument index="2" name="max" type="real"> - </argument> - <argument index="3" name="step" type="real"> - </argument> - <argument index="4" name="expr" type="bool" default="false"> - </argument> - <description> - </description> - </method> - <method name="get_range_config"> - <return type="Dictionary"> - </return> - <argument index="0" name="column" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_metadata"> - <argument index="0" name="column" type="int"> - </argument> - <argument index="1" name="meta" type="var"> - </argument> - <description> - </description> - </method> - <method name="get_metadata" qualifiers="const"> - <argument index="0" name="column" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_collapsed"> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - </description> - </method> - <method name="is_collapsed"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="get_next"> - <return type="TreeItem"> - </return> - <description> - </description> - </method> - <method name="get_prev"> - <return type="TreeItem"> - </return> - <description> - </description> - </method> - <method name="get_parent"> - <return type="TreeItem"> - </return> - <description> - </description> - </method> - <method name="get_children"> - <return type="TreeItem"> - </return> - <description> - </description> - </method> - <method name="get_next_visible"> - <return type="TreeItem"> - </return> - <description> - </description> - </method> - <method name="get_prev_visible"> - <return type="TreeItem"> - </return> - <description> - </description> - </method> - <method name="remove_child"> - <argument index="0" name="child" type="Object"> - </argument> - <description> - </description> - </method> - <method name="set_selectable"> - <argument index="0" name="column" type="int"> - </argument> - <argument index="1" name="selectable" type="bool"> - </argument> - <description> - </description> - </method> - <method name="is_selectable" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="column" type="int"> - </argument> - <description> - </description> - </method> - <method name="is_selected"> - <return type="bool"> - </return> - <argument index="0" name="column" type="int"> - </argument> - <description> - </description> - </method> - <method name="select"> - <argument index="0" name="column" type="int"> - </argument> - <description> - </description> - </method> - <method name="deselect"> - <argument index="0" name="column" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_editable"> - <argument index="0" name="column" type="int"> - </argument> - <argument index="1" name="enabled" type="bool"> - </argument> - <description> - </description> - </method> - <method name="is_editable"> - <return type="bool"> - </return> - <argument index="0" name="column" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_custom_color"> - <argument index="0" name="column" type="int"> - </argument> - <argument index="1" name="color" type="Color"> - </argument> - <description> - </description> - </method> - <method name="clear_custom_color"> - <argument index="0" name="column" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_custom_bg_color"> - <argument index="0" name="column" type="int"> - </argument> - <argument index="1" name="color" type="Color"> - </argument> - <description> - </description> - </method> - <method name="clear_custom_bg_color"> - <argument index="0" name="column" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_custom_bg_color" qualifiers="const"> - <return type="Color"> - </return> - <argument index="0" name="column" type="int"> - </argument> - <description> - </description> - </method> - <method name="add_button"> - <argument index="0" name="column" type="int"> - </argument> - <argument index="1" name="button" type="Texture"> - </argument> - <argument index="2" name="arg2" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_button_count" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="column" type="int"> - </argument> - <description> - </description> - </method> - <method name="get_button" qualifiers="const"> - <return type="Texture"> - </return> - <argument index="0" name="column" type="int"> - </argument> - <argument index="1" name="button_idx" type="int"> - </argument> - <description> - </description> - </method> - <method name="erase_button"> - <argument index="0" name="column" type="int"> - </argument> - <argument index="1" name="button_idx" type="int"> - </argument> - <description> - </description> - </method> - <method name="set_tooltip"> - <argument index="0" name="column" type="int"> - </argument> - <argument index="1" name="tooltip" type="String"> - </argument> - <description> - </description> - </method> - <method name="get_tooltip" qualifiers="const"> - <return type="String"> - </return> - <argument index="0" name="column" type="int"> - </argument> - <description> - </description> - </method> - </methods> - <constants> - <constant name="CELL_MODE_STRING" value="0"> - </constant> - <constant name="CELL_MODE_CHECK" value="1"> - </constant> - <constant name="CELL_MODE_RANGE" value="2"> - </constant> - <constant name="CELL_MODE_ICON" value="3"> - </constant> - <constant name="CELL_MODE_CUSTOM" value="4"> - </constant> - </constants> -</class> -<class name="VBoxContainer" inherits="BoxContainer" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - </methods> - <constants> - </constants> -</class> -<class name="VButtonArray" inherits="ButtonArray" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - </methods> - <constants> - </constants> -</class> -<class name="VScrollBar" inherits="ScrollBar" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - </methods> - <constants> - </constants> -</class> -<class name="VSeparator" inherits="Separator" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - </methods> - <constants> - </constants> -</class> -<class name="VSlider" inherits="Slider" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - </methods> - <constants> - </constants> -</class> -<class name="VideoPlayer" inherits="Control" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="set_stream"> - <argument index="0" name="stream" type="Stream"> - </argument> - <description> - </description> - </method> - <method name="get_stream" qualifiers="const"> - <return type="Stream"> - </return> - <description> - </description> - </method> - <method name="play"> - <description> - </description> - </method> - <method name="stop"> - <description> - </description> - </method> - <method name="is_playing" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_paused"> - <argument index="0" name="paused" type="bool"> - </argument> - <description> - </description> - </method> - <method name="is_paused" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_volume"> - <argument index="0" name="volume" type="real"> - </argument> - <description> - </description> - </method> - <method name="get_volume" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - <method name="set_volume_db"> - <argument index="0" name="db" type="real"> - </argument> - <description> - </description> - </method> - <method name="get_volume_db" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - <method name="get_stream_name" qualifiers="const"> - <return type="String"> - </return> - <description> - </description> - </method> - <method name="get_pos" qualifiers="const"> - <return type="real"> - </return> - <description> - </description> - </method> - <method name="set_autoplay"> - <argument index="0" name="enabled" type="bool"> - </argument> - <description> - </description> - </method> - <method name="has_autoplay" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_expand"> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - </description> - </method> - <method name="has_expand" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - </methods> - <constants> - </constants> -</class> -<class name="VideoStream" inherits="AudioStreamResampled" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="get_pending_frame_count" qualifiers="const"> - <return type="int"> - </return> - <description> - </description> - </method> - <method name="pop_frame"> - <return type="Image"> - </return> - <description> - </description> - </method> - <method name="peek_frame" qualifiers="const"> - <return type="Image"> - </return> - <description> - </description> - </method> - </methods> - <constants> - </constants> -</class> -<class name="VideoStreamTheora" inherits="VideoStream" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - </methods> - <constants> - </constants> -</class> -<class name="Viewport" inherits="Node" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="set_rect"> - <argument index="0" name="rect" type="Rect2"> - </argument> - <description> - </description> - </method> - <method name="get_rect" qualifiers="const"> - <return type="Rect2"> - </return> - <description> - </description> - </method> - <method name="get_visible_rect" qualifiers="const"> - <return type="Rect2"> - </return> - <description> - </description> - </method> - <method name="set_transparent_background"> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - </description> - </method> - <method name="has_transparent_background" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="get_viewport" qualifiers="const"> - <return type="RID"> - </return> - <description> - </description> - </method> - </methods> - <constants> - </constants> -</class> -<class name="VisualInstance" inherits="Spatial" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="set_base"> - <argument index="0" name="base" type="RID"> - </argument> - <description> - </description> - </method> - </methods> - <constants> - </constants> -</class> -<class name="VisualServer" inherits="Object" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="texture_create"> - <return type="RID"> - </return> - <description> - </description> - </method> - <method name="texture_create_from_image"> - <return type="RID"> - </return> - <argument index="0" name="arg0" type="Image"> - </argument> - <argument index="1" name="arg1" type="int" default="7"> - </argument> - <description> - </description> - </method> - <method name="texture_set_flags"> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="int"> - </argument> - <description> - </description> - </method> - <method name="texture_get_flags" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="arg0" type="RID"> - </argument> - <description> - </description> - </method> - <method name="texture_get_width" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="arg0" type="RID"> - </argument> - <description> - </description> - </method> - <method name="texture_get_height" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="arg0" type="RID"> - </argument> - <description> - </description> - </method> - <method name="shader_create"> - <return type="RID"> - </return> - <argument index="0" name="mode" type="int" default="0"> - </argument> - <description> - </description> - </method> - <method name="shader_set_mode"> - <argument index="0" name="shader" type="RID"> - </argument> - <argument index="1" name="mode" type="int"> - </argument> - <description> - </description> - </method> - <method name="shader_get_mode" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="shader" type="RID"> - </argument> - <description> - </description> - </method> - <method name="shader_set_vertex_code"> - <argument index="0" name="shader" type="RID"> - </argument> - <argument index="1" name="code" type="String"> - </argument> - <description> - </description> - </method> - <method name="shader_get_vertex_code" qualifiers="const"> - <return type="String"> - </return> - <argument index="0" name="shader" type="RID"> - </argument> - <description> - </description> - </method> - <method name="shader_set_fragment_code"> - <argument index="0" name="shader" type="RID"> - </argument> - <argument index="1" name="code" type="String"> - </argument> - <description> - </description> - </method> - <method name="shader_get_fragment_code" qualifiers="const"> - <return type="String"> - </return> - <argument index="0" name="shader" type="RID"> - </argument> - <description> - </description> - </method> - <method name="shader_set_param"> - <argument index="0" name="shader" type="RID"> - </argument> - <argument index="1" name="param" type="String"> - </argument> - <argument index="2" name="value" type="var"> - </argument> - <description> - </description> - </method> - <method name="shader_get_param" qualifiers="const"> - <argument index="0" name="shader" type="RID"> - </argument> - <argument index="1" name="param" type="String"> - </argument> - <description> - </description> - </method> - <method name="shader_get_param_list" qualifiers="const"> - <return type="StringArray"> - </return> - <argument index="0" name="shader" type="RID"> - </argument> - <description> - </description> - </method> - <method name="shader_set_use_world_transform"> - <argument index="0" name="shader" type="RID"> - </argument> - <argument index="1" name="enable" type="bool"> - </argument> - <description> - </description> - </method> - <method name="shader_is_using_world_transform" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="shader" type="RID"> - </argument> - <description> - </description> - </method> - <method name="material_create"> - <return type="RID"> - </return> - <description> - </description> - </method> - <method name="material_set_shader"> - <argument index="0" name="shader" type="RID"> - </argument> - <argument index="1" name="arg1" type="RID"> - </argument> - <description> - </description> - </method> - <method name="material_get_shader" qualifiers="const"> - <return type="RID"> - </return> - <argument index="0" name="arg0" type="RID"> - </argument> - <description> - </description> - </method> - <method name="material_set_param"> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="String"> - </argument> - <argument index="2" name="arg2" type="var"> - </argument> - <description> - </description> - </method> - <method name="material_get_param" qualifiers="const"> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="String"> - </argument> - <description> - </description> - </method> - <method name="material_set_flag"> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="int"> - </argument> - <argument index="2" name="arg2" type="bool"> - </argument> - <description> - </description> - </method> - <method name="material_get_flag" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="int"> - </argument> - <description> - </description> - </method> - <method name="material_set_blend_mode"> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="int"> - </argument> - <description> - </description> - </method> - <method name="material_get_blend_mode" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="arg0" type="RID"> - </argument> - <description> - </description> - </method> - <method name="material_set_line_width"> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="real"> - </argument> - <description> - </description> - </method> - <method name="material_get_line_width" qualifiers="const"> - <return type="real"> - </return> - <argument index="0" name="arg0" type="RID"> - </argument> - <description> - </description> - </method> - <method name="fixed_material_set_parameter"> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="int"> - </argument> - <argument index="2" name="arg2" type="var"> - </argument> - <description> - </description> - </method> - <method name="fixed_material_get_parameter" qualifiers="const"> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="int"> - </argument> - <description> - </description> - </method> - <method name="fixed_material_set_texture"> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="int"> - </argument> - <argument index="2" name="arg2" type="RID"> - </argument> - <description> - </description> - </method> - <method name="fixed_material_get_texture" qualifiers="const"> - <return type="RID"> - </return> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="int"> - </argument> - <description> - </description> - </method> - <method name="fixed_material_set_texgen_mode"> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="int"> - </argument> - <description> - </description> - </method> - <method name="fixed_material_get_texgen_mode" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="arg0" type="RID"> - </argument> - <description> - </description> - </method> - <method name="fixed_material_set_texcoord_mode"> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="int"> - </argument> - <argument index="2" name="arg2" type="int"> - </argument> - <description> - </description> - </method> - <method name="fixed_material_get_texcoord_mode" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="int"> - </argument> - <description> - </description> - </method> - <method name="fixed_material_set_uv_transform"> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="Transform"> - </argument> - <description> - </description> - </method> - <method name="fixed_material_get_uv_transform" qualifiers="const"> - <return type="Transform"> - </return> - <argument index="0" name="arg0" type="RID"> - </argument> - <description> - </description> - </method> - <method name="mesh_create"> - <return type="RID"> - </return> - <description> - </description> - </method> - <method name="mesh_add_surface"> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="int"> - </argument> - <argument index="2" name="arg2" type="int"> - </argument> - <argument index="3" name="arg3" type="int"> - </argument> - <argument index="4" name="arg4" type="int" default="-1"> - </argument> - <description> - </description> - </method> - <method name="mesh_surface_set_array"> - <return type="int"> - </return> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="int"> - </argument> - <argument index="2" name="arg2" type="int"> - </argument> - <argument index="3" name="arg3" type="var"> - </argument> - <description> - </description> - </method> - <method name="mesh_surface_get_array" qualifiers="const"> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="int"> - </argument> - <argument index="2" name="arg2" type="int"> - </argument> - <description> - </description> - </method> - <method name="mesh_surface_set_material"> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="int"> - </argument> - <argument index="2" name="arg2" type="RID"> - </argument> - <argument index="3" name="arg3" type="bool" default="false"> - </argument> - <description> - </description> - </method> - <method name="mesh_surface_get_material" qualifiers="const"> - <return type="RID"> - </return> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="int"> - </argument> - <description> - </description> - </method> - <method name="mesh_surface_get_array_len" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="int"> - </argument> - <description> - </description> - </method> - <method name="mesh_surface_get_array_index_len" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="int"> - </argument> - <description> - </description> - </method> - <method name="mesh_surface_get_format" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="int"> - </argument> - <description> - </description> - </method> - <method name="mesh_surface_get_primitive_type" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="int"> - </argument> - <description> - </description> - </method> - <method name="mesh_erase_surface"> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="int"> - </argument> - <description> - </description> - </method> - <method name="mesh_get_surface_count" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="arg0" type="RID"> - </argument> - <description> - </description> - </method> - <method name="multimesh_create"> - <return type="RID"> - </return> - <description> - </description> - </method> - <method name="multimesh_set_mesh"> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="RID"> - </argument> - <description> - </description> - </method> - <method name="multimesh_set_aabb"> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="AABB"> - </argument> - <description> - </description> - </method> - <method name="multimesh_instance_set_transform"> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="int"> - </argument> - <argument index="2" name="arg2" type="Transform"> - </argument> - <description> - </description> - </method> - <method name="multimesh_instance_set_color"> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="int"> - </argument> - <argument index="2" name="arg2" type="Color"> - </argument> - <description> - </description> - </method> - <method name="multimesh_get_mesh" qualifiers="const"> - <return type="RID"> - </return> - <argument index="0" name="arg0" type="RID"> - </argument> - <description> - </description> - </method> - <method name="multimesh_get_aabb" qualifiers="const"> - <return type="AABB"> - </return> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="AABB"> - </argument> - <description> - </description> - </method> - <method name="multimesh_instance_get_transform" qualifiers="const"> - <return type="Transform"> - </return> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="int"> - </argument> - <description> - </description> - </method> - <method name="multimesh_instance_get_color" qualifiers="const"> - <return type="Color"> - </return> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="int"> - </argument> - <description> - </description> - </method> - <method name="poly_create"> - <return type="RID"> - </return> - <description> - </description> - </method> - <method name="poly_set_material"> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="RID"> - </argument> - <argument index="2" name="arg2" type="bool" default="false"> - </argument> - <description> - </description> - </method> - <method name="poly_clear"> - <argument index="0" name="arg0" type="RID"> - </argument> - <description> - </description> - </method> - <method name="particles_create"> - <return type="RID"> - </return> - <description> - </description> - </method> - <method name="particles_set_amount"> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="int"> - </argument> - <description> - </description> - </method> - <method name="particles_get_amount" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="arg0" type="RID"> - </argument> - <description> - </description> - </method> - <method name="particles_set_emitting"> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="bool"> - </argument> - <description> - </description> - </method> - <method name="particles_is_emitting" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="arg0" type="RID"> - </argument> - <description> - </description> - </method> - <method name="particles_set_visibility_aabb"> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="AABB"> - </argument> - <description> - </description> - </method> - <method name="particles_get_visibility_aabb" qualifiers="const"> - <return type="AABB"> - </return> - <argument index="0" name="arg0" type="RID"> - </argument> - <description> - </description> - </method> - <method name="particles_set_variable"> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="int"> - </argument> - <argument index="2" name="arg2" type="real"> - </argument> - <description> - </description> - </method> - <method name="particles_get_variable" qualifiers="const"> - <return type="real"> - </return> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="int"> - </argument> - <description> - </description> - </method> - <method name="particles_set_randomness"> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="int"> - </argument> - <argument index="2" name="arg2" type="real"> - </argument> - <description> - </description> - </method> - <method name="particles_get_randomness" qualifiers="const"> - <return type="real"> - </return> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="int"> - </argument> - <description> - </description> - </method> - <method name="particles_set_color_phases"> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="int"> - </argument> - <description> - </description> - </method> - <method name="particles_get_color_phases" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="arg0" type="RID"> - </argument> - <description> - </description> - </method> - <method name="particles_set_color_phase_pos"> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="int"> - </argument> - <argument index="2" name="arg2" type="real"> - </argument> - <description> - </description> - </method> - <method name="particles_get_color_phase_pos" qualifiers="const"> - <return type="real"> - </return> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="int"> - </argument> - <description> - </description> - </method> - <method name="particles_set_color_phase_color"> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="int"> - </argument> - <argument index="2" name="arg2" type="Color"> - </argument> - <description> - </description> - </method> - <method name="particles_get_color_phase_color" qualifiers="const"> - <return type="Color"> - </return> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="int"> - </argument> - <description> - </description> - </method> - <method name="particles_set_attractors"> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="int"> - </argument> - <description> - </description> - </method> - <method name="particles_get_attractors" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="arg0" type="RID"> - </argument> - <description> - </description> - </method> - <method name="particles_set_attractor_pos"> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="int"> - </argument> - <argument index="2" name="arg2" type="Vector3"> - </argument> - <description> - </description> - </method> - <method name="particles_get_attractor_pos" qualifiers="const"> - <return type="Vector3"> - </return> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="int"> - </argument> - <description> - </description> - </method> - <method name="particles_set_attractor_strength"> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="int"> - </argument> - <argument index="2" name="arg2" type="real"> - </argument> - <description> - </description> - </method> - <method name="particles_get_attractor_strength" qualifiers="const"> - <return type="real"> - </return> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="int"> - </argument> - <description> - </description> - </method> - <method name="particles_set_material"> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="RID"> - </argument> - <argument index="2" name="arg2" type="bool" default="false"> - </argument> - <description> - </description> - </method> - <method name="particles_set_height_from_velocity"> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="bool"> - </argument> - <description> - </description> - </method> - <method name="particles_has_height_from_velocity" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="arg0" type="RID"> - </argument> - <description> - </description> - </method> - <method name="light_create"> - <return type="RID"> - </return> - <argument index="0" name="arg0" type="int"> - </argument> - <description> - </description> - </method> - <method name="light_get_type" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="arg0" type="RID"> - </argument> - <description> - </description> - </method> - <method name="light_set_color"> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="int"> - </argument> - <argument index="2" name="arg2" type="Color"> - </argument> - <description> - </description> - </method> - <method name="light_get_color" qualifiers="const"> - <return type="Color"> - </return> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="int"> - </argument> - <description> - </description> - </method> - <method name="light_set_shadow"> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="bool"> - </argument> - <description> - </description> - </method> - <method name="light_has_shadow" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="arg0" type="RID"> - </argument> - <description> - </description> - </method> - <method name="light_set_volumetric"> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="bool"> - </argument> - <description> - </description> - </method> - <method name="light_is_volumetric" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="arg0" type="RID"> - </argument> - <description> - </description> - </method> - <method name="light_set_projector"> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="RID"> - </argument> - <description> - </description> - </method> - <method name="light_get_projector" qualifiers="const"> - <return type="RID"> - </return> - <argument index="0" name="arg0" type="RID"> - </argument> - <description> - </description> - </method> - <method name="light_set_var"> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="int"> - </argument> - <argument index="2" name="arg2" type="real"> - </argument> - <description> - </description> - </method> - <method name="light_get_var" qualifiers="const"> - <return type="real"> - </return> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="int"> - </argument> - <description> - </description> - </method> - <method name="skeleton_create"> - <return type="RID"> - </return> - <description> - </description> - </method> - <method name="skeleton_resize"> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="int"> - </argument> - <description> - </description> - </method> - <method name="skeleton_get_bone_count" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="arg0" type="RID"> - </argument> - <description> - </description> - </method> - <method name="skeleton_bone_set_transform"> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="int"> - </argument> - <argument index="2" name="arg2" type="Transform"> - </argument> - <description> - </description> - </method> - <method name="skeleton_bone_get_transform"> - <return type="Transform"> - </return> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="int"> - </argument> - <description> - </description> - </method> - <method name="room_create"> - <return type="RID"> - </return> - <description> - </description> - </method> - <method name="room_set_bounds"> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="Dictionary"> - </argument> - <description> - </description> - </method> - <method name="room_get_bounds" qualifiers="const"> - <return type="Dictionary"> - </return> - <argument index="0" name="arg0" type="RID"> - </argument> - <description> - </description> - </method> - <method name="portal_create"> - <return type="RID"> - </return> - <description> - </description> - </method> - <method name="portal_set_shape"> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="Vector2Array"> - </argument> - <description> - </description> - </method> - <method name="portal_get_shape" qualifiers="const"> - <return type="Vector2Array"> - </return> - <argument index="0" name="arg0" type="RID"> - </argument> - <description> - </description> - </method> - <method name="portal_set_enabled"> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="bool"> - </argument> - <description> - </description> - </method> - <method name="portal_is_enabled" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="arg0" type="RID"> - </argument> - <description> - </description> - </method> - <method name="portal_set_disable_distance"> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="real"> - </argument> - <description> - </description> - </method> - <method name="portal_get_disable_distance" qualifiers="const"> - <return type="real"> - </return> - <argument index="0" name="arg0" type="RID"> - </argument> - <description> - </description> - </method> - <method name="portal_set_disabled_color"> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="Color"> - </argument> - <description> - </description> - </method> - <method name="portal_get_disabled_color" qualifiers="const"> - <return type="Color"> - </return> - <argument index="0" name="arg0" type="RID"> - </argument> - <description> - </description> - </method> - <method name="camera_create"> - <return type="RID"> - </return> - <description> - </description> - </method> - <method name="camera_set_perspective"> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="real"> - </argument> - <argument index="2" name="arg2" type="real"> - </argument> - <argument index="3" name="arg3" type="real"> - </argument> - <description> - </description> - </method> - <method name="camera_set_orthogonal"> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="real"> - </argument> - <argument index="2" name="arg2" type="real"> - </argument> - <argument index="3" name="arg3" type="real"> - </argument> - <description> - </description> - </method> - <method name="camera_set_transform"> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="Transform"> - </argument> - <description> - </description> - </method> - <method name="viewport_create"> - <return type="RID"> - </return> - <description> - </description> - </method> - <method name="viewport_set_rect"> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="Rect2"> - </argument> - <description> - </description> - </method> - <method name="viewport_get_rect" qualifiers="const"> - <return type="Rect2"> - </return> - <argument index="0" name="arg0" type="RID"> - </argument> - <description> - </description> - </method> - <method name="viewport_attach_camera"> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="RID" default="RID()"> - </argument> - <description> - </description> - </method> - <method name="viewport_get_attached_camera" qualifiers="const"> - <return type="RID"> - </return> - <argument index="0" name="arg0" type="RID"> - </argument> - <description> - </description> - </method> - <method name="viewport_get_scenario" qualifiers="const"> - <return type="RID"> - </return> - <argument index="0" name="arg0" type="RID"> - </argument> - <description> - </description> - </method> - <method name="viewport_attach_canvas"> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="RID"> - </argument> - <description> - </description> - </method> - <method name="viewport_remove_canvas"> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="RID"> - </argument> - <description> - </description> - </method> - <method name="scenario_create"> - <return type="RID"> - </return> - <description> - </description> - </method> - <method name="scenario_set_debug"> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="int"> - </argument> - <description> - </description> - </method> - <method name="scenario_fx_get_effects" qualifiers="const"> - <return type="StringArray"> - </return> - <argument index="0" name="arg0" type="RID"> - </argument> - <description> - </description> - </method> - <method name="scenario_fx_set_active"> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="String"> - </argument> - <argument index="2" name="arg2" type="bool"> - </argument> - <description> - </description> - </method> - <method name="scenario_fx_is_active" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="String"> - </argument> - <description> - </description> - </method> - <method name="scenario_fx_get_effect_params" qualifiers="const"> - <return type="Array"> - </return> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="String"> - </argument> - <description> - </description> - </method> - <method name="scenario_fx_get_effect_param" qualifiers="const"> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="String"> - </argument> - <argument index="2" name="arg2" type="String"> - </argument> - <description> - </description> - </method> - <method name="scenario_fx_set_effect_param"> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="String"> - </argument> - <argument index="2" name="arg2" type="String"> - </argument> - <argument index="3" name="arg3" type="var"> - </argument> - <description> - </description> - </method> - <method name="instance_create"> - <return type="RID"> - </return> - <description> - </description> - </method> - <method name="instance_get_base" qualifiers="const"> - <return type="RID"> - </return> - <argument index="0" name="arg0" type="RID"> - </argument> - <description> - </description> - </method> - <method name="instance_get_base_aabb" qualifiers="const"> - <return type="RID"> - </return> - <argument index="0" name="arg0" type="RID"> - </argument> - <description> - </description> - </method> - <method name="instance_set_transform"> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="Transform"> - </argument> - <description> - </description> - </method> - <method name="instance_get_transform" qualifiers="const"> - <return type="Transform"> - </return> - <argument index="0" name="arg0" type="RID"> - </argument> - <description> - </description> - </method> - <method name="instance_attach_object_instance_ID"> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="int"> - </argument> - <description> - </description> - </method> - <method name="instance_get_object_instance_ID" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="arg0" type="RID"> - </argument> - <description> - </description> - </method> - <method name="instance_attach_skeleton"> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="RID"> - </argument> - <description> - </description> - </method> - <method name="instance_get_skeleton" qualifiers="const"> - <return type="RID"> - </return> - <argument index="0" name="arg0" type="RID"> - </argument> - <description> - </description> - </method> - <method name="instance_set_room"> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="RID"> - </argument> - <description> - </description> - </method> - <method name="instance_get_room" qualifiers="const"> - <return type="RID"> - </return> - <argument index="0" name="arg0" type="RID"> - </argument> - <description> - </description> - </method> - <method name="instance_set_exterior"> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="bool"> - </argument> - <description> - </description> - </method> - <method name="instance_is_exterior" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="arg0" type="RID"> - </argument> - <description> - </description> - </method> - <method name="instances_cull_aabb" qualifiers="const"> - <return type="Array"> - </return> - <argument index="0" name="arg0" type="AABB"> - </argument> - <argument index="1" name="arg1" type="RID"> - </argument> - <description> - </description> - </method> - <method name="instances_cull_ray" qualifiers="const"> - <return type="Array"> - </return> - <argument index="0" name="arg0" type="Vector3"> - </argument> - <argument index="1" name="arg1" type="Vector3"> - </argument> - <argument index="2" name="arg2" type="RID"> - </argument> - <description> - </description> - </method> - <method name="instances_cull_convex" qualifiers="const"> - <return type="Array"> - </return> - <argument index="0" name="arg0" type="Vector3"> - </argument> - <argument index="1" name="arg1" type="Vector3"> - </argument> - <argument index="2" name="arg2" type="RID"> - </argument> - <description> - </description> - </method> - <method name="instance_geometry_set_visible"> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="bool"> - </argument> - <description> - </description> - </method> - <method name="instance_geometry_is_visible" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="arg0" type="RID"> - </argument> - <description> - </description> - </method> - <method name="instance_geometry_override_material_param" qualifiers="const"> - <return type="RID"> - </return> - <argument index="0" name="arg0" type="RID"> - </argument> - <description> - </description> - </method> - <method name="instance_geometry_get_material_param" qualifiers="const"> - <return type="RID"> - </return> - <argument index="0" name="arg0" type="RID"> - </argument> - <description> - </description> - </method> - <method name="canvas_create"> - <return type="RID"> - </return> - <description> - </description> - </method> - <method name="canvas_item_create"> - <return type="RID"> - </return> - <description> - </description> - </method> - <method name="canvas_item_set_parent"> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="RID"> - </argument> - <description> - </description> - </method> - <method name="canvas_item_get_parent" qualifiers="const"> - <return type="RID"> - </return> - <argument index="0" name="arg0" type="RID"> - </argument> - <description> - </description> - </method> - <method name="canvas_item_set_transform"> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="Matrix32"> - </argument> - <description> - </description> - </method> - <method name="canvas_item_set_custom_rect"> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="bool"> - </argument> - <argument index="2" name="arg2" type="Rect2"> - </argument> - <description> - </description> - </method> - <method name="canvas_item_set_clip"> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="bool"> - </argument> - <description> - </description> - </method> - <method name="canvas_item_set_opacity"> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="real"> - </argument> - <description> - </description> - </method> - <method name="canvas_item_get_opacity" qualifiers="const"> - <return type="real"> - </return> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="real"> - </argument> - <description> - </description> - </method> - <method name="canvas_item_set_self_opacity"> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="real"> - </argument> - <description> - </description> - </method> - <method name="canvas_item_get_self_opacity" qualifiers="const"> - <return type="real"> - </return> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="real"> - </argument> - <description> - </description> - </method> - <method name="canvas_item_add_line"> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="Vector2"> - </argument> - <argument index="2" name="arg2" type="Vector2"> - </argument> - <argument index="3" name="arg3" type="Color"> - </argument> - <argument index="4" name="arg4" type="real" default="1"> - </argument> - <description> - </description> - </method> - <method name="canvas_item_add_rect"> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="Rect2"> - </argument> - <argument index="2" name="arg2" type="Color"> - </argument> - <description> - </description> - </method> - <method name="canvas_item_add_texture_rect"> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="Rect2"> - </argument> - <argument index="2" name="arg2" type="RID"> - </argument> - <argument index="3" name="arg3" type="bool"> - </argument> - <argument index="4" name="arg4" type="Color" default="Color(1,1,1,1)"> - </argument> - <description> - </description> - </method> - <method name="canvas_item_add_texture_rect_region"> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="Rect2"> - </argument> - <argument index="2" name="arg2" type="RID"> - </argument> - <argument index="3" name="arg3" type="Rect2"> - </argument> - <argument index="4" name="arg4" type="Color" default="Color(1,1,1,1)"> - </argument> - <description> - </description> - </method> - <method name="canvas_item_add_style_box"> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="Rect2"> - </argument> - <argument index="2" name="arg2" type="RID"> - </argument> - <argument index="3" name="arg3" type="RealArray"> - </argument> - <argument index="4" name="arg4" type="Color" default="Color(1,1,1,1)"> - </argument> - <description> - </description> - </method> - <method name="canvas_item_add_circle"> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="Vector2"> - </argument> - <argument index="2" name="arg2" type="real"> - </argument> - <argument index="3" name="arg3" type="Color"> - </argument> - <description> - </description> - </method> - <method name="viewport_set_canvas_transform"> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="RID"> - </argument> - <argument index="2" name="arg2" type="Matrix32"> - </argument> - <description> - </description> - </method> - <method name="canvas_item_clear"> - <argument index="0" name="arg0" type="RID"> - </argument> - <description> - </description> - </method> - <method name="canvas_item_raise"> - <argument index="0" name="arg0" type="RID"> - </argument> - <description> - </description> - </method> - <method name="cursor_set_rotation"> - <argument index="0" name="arg0" type="real"> - </argument> - <argument index="1" name="arg1" type="int"> - </argument> - <description> - </description> - </method> - <method name="cursor_set_texture"> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="Vector2"> - </argument> - <argument index="2" name="arg2" type="int"> - </argument> - <description> - </description> - </method> - <method name="cursor_set_visible"> - <argument index="0" name="arg0" type="bool"> - </argument> - <argument index="1" name="arg1" type="int"> - </argument> - <description> - </description> - </method> - <method name="cursor_set_pos"> - <argument index="0" name="arg0" type="Vector2"> - </argument> - <argument index="1" name="arg1" type="int"> - </argument> - <description> - </description> - </method> - <method name="make_sphere_mesh"> - <return type="RID"> - </return> - <argument index="0" name="arg0" type="int"> - </argument> - <argument index="1" name="arg1" type="int"> - </argument> - <argument index="2" name="arg2" type="real"> - </argument> - <description> - </description> - </method> - <method name="mesh_add_surface_from_planes"> - <argument index="0" name="arg0" type="RID"> - </argument> - <argument index="1" name="arg1" type="Array"> - </argument> - <description> - </description> - </method> - <method name="free"> - <argument index="0" name="arg0" type="RID"> - </argument> - <description> - </description> - </method> - </methods> - <constants> - <constant name="NO_INDEX_ARRAY" value="-1"> - </constant> - <constant name="CUSTOM_ARRAY_SIZE" value="8"> - </constant> - <constant name="ARRAY_WEIGHTS_SIZE" value="4"> - </constant> - <constant name="MAX_PARTICLE_COLOR_PHASES" value="4"> - </constant> - <constant name="MAX_PARTICLE_ATTRACTORS" value="4"> - </constant> - <constant name="MAX_CURSORS" value="8"> - </constant> - <constant name="TEXTURE_FLAG_MIPMAPS" value="1"> - </constant> - <constant name="TEXTURE_FLAG_REPEAT" value="2"> - </constant> - <constant name="TEXTURE_FLAG_FILTER" value="4"> - </constant> - <constant name="TEXTURE_FLAG_CUBEMAP" value="8"> - </constant> - <constant name="TEXTURE_FLAGS_DEFAULT" value="7"> - </constant> - <constant name="CUBEMAP_LEFT" value="0"> - </constant> - <constant name="CUBEMAP_RIGHT" value="1"> - </constant> - <constant name="CUBEMAP_BOTTOM" value="2"> - </constant> - <constant name="CUBEMAP_TOP" value="3"> - </constant> - <constant name="CUBEMAP_FRONT" value="4"> - </constant> - <constant name="CUBEMAP_BACK" value="5"> - </constant> - <constant name="SHADER_MATERIAL" value="0"> - </constant> - <constant name="SHADER_POST_PROCESS" value="1"> - </constant> - <constant name="MATERIAL_FLAG_VISIBLE" value="0"> - </constant> - <constant name="MATERIAL_FLAG_DOUBLE_SIDED" value="1"> - </constant> - <constant name="MATERIAL_FLAG_INVERT_FACES" value="2"> - </constant> - <constant name="MATERIAL_FLAG_UNSHADED" value="3"> - </constant> - <constant name="MATERIAL_FLAG_ONTOP" value="4"> - </constant> - <constant name="MATERIAL_FLAG_WIREFRAME" value="5"> - </constant> - <constant name="MATERIAL_FLAG_BILLBOARD" value="6"> - </constant> - <constant name="MATERIAL_FLAG_MAX" value="7"> - </constant> - <constant name="MATERIAL_BLEND_MODE_MIX" value="0"> - </constant> - <constant name="MATERIAL_BLEND_MODE_ADD" value="1"> - </constant> - <constant name="MATERIAL_BLEND_MODE_SUB" value="2"> - </constant> - <constant name="MATERIAL_BLEND_MODE_MUL" value="3"> - </constant> - <constant name="FIXED_MATERIAL_PARAM_DIFFUSE" value="0"> - </constant> - <constant name="FIXED_MATERIAL_PARAM_DETAIL" value="1"> - </constant> - <constant name="FIXED_MATERIAL_PARAM_SPECULAR" value="2"> - </constant> - <constant name="FIXED_MATERIAL_PARAM_EMISSION" value="3"> - </constant> - <constant name="FIXED_MATERIAL_PARAM_SPECULAR_EXP" value="4"> - </constant> - <constant name="FIXED_MATERIAL_PARAM_GLOW" value="5"> - </constant> - <constant name="FIXED_MATERIAL_PARAM_NORMAL" value="6"> - </constant> - <constant name="FIXED_MATERIAL_PARAM_SHADE_PARAM" value="7"> - </constant> - <constant name="FIXED_MATERIAL_PARAM_MAX" value="8"> - </constant> - <constant name="FIXED_MATERIAL_TEXGEN_SPHERE" value="1"> - </constant> - <constant name="FIXED_MATERIAL_TEXGEN_SCREEN" value="2"> - </constant> - <constant name="FIXED_MATERIAL_TEXGEN_SCREENZ" value="3"> - </constant> - <constant name="FIXED_MATERIAL_TEXGEN_LOCAL_XY" value="0"> - </constant> - <constant name="FIXED_MATERIAL_TEXCOORD_TEXGEN" value="3"> - </constant> - <constant name="FIXED_MATERIAL_TEXCOORD_UV" value="0"> - </constant> - <constant name="FIXED_MATERIAL_TEXCOORD_UV_TRANSFORM" value="1"> - </constant> - <constant name="FIXED_MATERIAL_TEXCOORD_UV2" value="2"> - </constant> - <constant name="ARRAY_VERTEX" value="0"> - </constant> - <constant name="ARRAY_NORMAL" value="1"> - </constant> - <constant name="ARRAY_TANGENT" value="2"> - </constant> - <constant name="ARRAY_COLOR" value="3"> - </constant> - <constant name="ARRAY_TEX_UV" value="4"> - </constant> - <constant name="ARRAY_BONES" value="6"> - </constant> - <constant name="ARRAY_WEIGHTS" value="7"> - </constant> - <constant name="ARRAY_INDEX" value="8"> - </constant> - <constant name="ARRAY_MAX" value="9"> - </constant> - <constant name="ARRAY_FORMAT_VERTEX" value="1"> - </constant> - <constant name="ARRAY_FORMAT_NORMAL" value="2"> - </constant> - <constant name="ARRAY_FORMAT_TANGENT" value="4"> - </constant> - <constant name="ARRAY_FORMAT_COLOR" value="8"> - </constant> - <constant name="ARRAY_FORMAT_TEX_UV" value="16"> - </constant> - <constant name="ARRAY_FORMAT_BONES" value="64"> - </constant> - <constant name="ARRAY_FORMAT_WEIGHTS" value="128"> - </constant> - <constant name="ARRAY_FORMAT_INDEX" value="256"> - </constant> - <constant name="PRIMITIVE_POINTS" value="0"> - </constant> - <constant name="PRIMITIVE_LINES" value="1"> - </constant> - <constant name="PRIMITIVE_LINE_STRIP" value="2"> - </constant> - <constant name="PRIMITIVE_LINE_LOOP" value="3"> - </constant> - <constant name="PRIMITIVE_TRIANGLES" value="4"> - </constant> - <constant name="PRIMITIVE_TRIANGLE_STRIP" value="5"> - </constant> - <constant name="PRIMITIVE_TRIANGLE_FAN" value="6"> - </constant> - <constant name="PRIMITIVE_MAX" value="7"> - </constant> - <constant name="PARTICLE_LIFETIME" value="0"> - </constant> - <constant name="PARTICLE_SPREAD" value="1"> - </constant> - <constant name="PARTICLE_GRAVITY" value="2"> - </constant> - <constant name="PARTICLE_LINEAR_VELOCITY" value="3"> - </constant> - <constant name="PARTICLE_ANGULAR_VELOCITY" value="4"> - </constant> - <constant name="PARTICLE_LINEAR_ACCELERATION" value="5"> - </constant> - <constant name="PARTICLE_RADIAL_ACCELERATION" value="6"> - </constant> - <constant name="PARTICLE_TANGENTIAL_ACCELERATION" value="7"> - </constant> - <constant name="PARTICLE_INITIAL_SIZE" value="9"> - </constant> - <constant name="PARTICLE_FINAL_SIZE" value="10"> - </constant> - <constant name="PARTICLE_INITIAL_ANGLE" value="11"> - </constant> - <constant name="PARTICLE_HEIGHT" value="12"> - </constant> - <constant name="PARTICLE_HEIGHT_SPEED_SCALE" value="13"> - </constant> - <constant name="PARTICLE_VAR_MAX" value="14"> - </constant> - <constant name="LIGHT_DIRECTIONAL" value="0"> - </constant> - <constant name="LIGHT_OMNI" value="1"> - </constant> - <constant name="LIGHT_SPOT" value="2"> - </constant> - <constant name="LIGHT_COLOR_AMBIENT" value="0"> - </constant> - <constant name="LIGHT_COLOR_DIFFUSE" value="1"> - </constant> - <constant name="LIGHT_COLOR_SPECULAR" value="2"> - </constant> - <constant name="LIGHT_VAR_SPOT_ATTENUATION" value="0"> - </constant> - <constant name="LIGHT_VAR_SPOT_ANGLE" value="1"> - </constant> - <constant name="LIGHT_VAR_RADIUS" value="2"> - </constant> - <constant name="LIGHT_VAR_ENERGY" value="3"> - </constant> - <constant name="LIGHT_VAR_ATTENUATION" value="4"> - </constant> - <constant name="LIGHT_VAR_MAX" value="6"> - </constant> - <constant name="SCENARIO_DEBUG_DISABLED" value="0"> - </constant> - <constant name="SCENARIO_DEBUG_WIREFRAME" value="1"> - </constant> - <constant name="SCENARIO_DEBUG_OVERDRAW" value="2"> - </constant> - <constant name="INSTANCE_MESH" value="1"> - </constant> - <constant name="INSTANCE_MULTIMESH" value="2"> - </constant> - <constant name="INSTANCE_POLY" value="3"> - </constant> - <constant name="INSTANCE_PARTICLES" value="4"> - </constant> - <constant name="INSTANCE_LIGHT" value="5"> - </constant> - <constant name="INSTANCE_ROOM" value="6"> - </constant> - <constant name="INSTANCE_PORTAL" value="7"> - </constant> - <constant name="INSTANCE_GEOMETRY_MASK" value="30"> - </constant> - <constant name="INFO_OBJECTS_IN_FRAME" value="0"> - </constant> - <constant name="INFO_MATERIAL_CHANGES_IN_FRAME" value="1"> - </constant> - <constant name="INFO_USAGE_VIDEO_MEM_TOTAL" value="2"> - </constant> - <constant name="INFO_VIDEO_MEM_USED" value="3"> - </constant> - <constant name="INFO_TEXTURE_MEM_USED" value="4"> - </constant> - <constant name="INFO_VERTEX_MEM_USED" value="5"> - </constant> - </constants> -</class> -<class name="WindowDialog" inherits="Popup" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="set_title"> - <argument index="0" name="title" type="String"> - </argument> - <description> - </description> - </method> - <method name="get_title" qualifiers="const"> - <return type="String"> - </return> - <description> - </description> - </method> - <method name="get_close_button"> - <return type="TextureButton"> - </return> - <description> - </description> - </method> - </methods> - <constants> - </constants> -</class> -<class name="World" inherits="Resource" category="Core"> - <brief_description> - </brief_description> - <description> - </description> - <methods> - <method name="get_space" qualifiers="const"> - <return type="RID"> - </return> - <description> - </description> - </method> - <method name="get_scenario" qualifiers="const"> - <return type="RID"> - </return> - <description> - </description> - </method> - <method name="get_sound_space" qualifiers="const"> - <return type="RID"> - </return> - <description> - </description> - </method> - </methods> - <constants> - </constants> -</class> -</doc> diff --git a/doc/examples/physics/script/test_base.sq b/doc/examples/physics/script/test_base.sq deleted file mode 100644 index 9d5451728f..0000000000 --- a/doc/examples/physics/script/test_base.sq +++ /dev/null @@ -1,295 +0,0 @@ - -class PhysicsTestBase extends MainLoopScripted { - - - bodies=[] - type_mesh_map={} - type_shape_map={} - cameratr=Transform() - - - function body_changed_transform(p_transform, p_velocity, p_angular_velocity,p_sleeping, p_visual_instance) { - - VisualServer.instance_set_transform(p_visual_instance,p_transform); - } - - - function create_body(p_shape, p_body_mode, p_location, p_active=true) { - - local mesh_instance = VisualServer.instance_create( type_mesh_map[p_shape] ) - local body = PhysicsServer.body_create(RID(),p_body_mode,!p_active) - PhysicsServer.body_add_shape(body,type_shape_map[p_shape]) - - local query = PhysicsServer.query_create(this,"body_changed_transform",mesh_instance) - PhysicsServer.query_body_state(query, body) - - PhysicsServer.body_set_state( body, PhysicsServer.BODY_STATE_TRANSFORM, p_location ) - bodies.append( body ) - return body - - } - - - function create_static_plane(p_plane) { - - local plane_shape = PhysicsServer.shape_create(PhysicsServer.SHAPE_PLANE) - PhysicsServer.shape_set_data( plane_shape, p_plane ); - - local b = PhysicsServer.body_create(RID(), PhysicsServer.BODY_MODE_STATIC ); - PhysicsServer.body_add_shape(b, plane_shape); - return b; - } - - function configure_body( p_body, p_mass, p_friction, p_bounce) { - - PhysicsServer.body_set_param( p_body, PhysicsServer.BODY_PARAM_MASS, p_mass ); - PhysicsServer.body_set_param( p_body, PhysicsServer.BODY_PARAM_FRICTION, p_friction ); - PhysicsServer.body_set_param( p_body, PhysicsServer.BODY_PARAM_BOUNCE, p_bounce ); - - } - - function init_shapes() { - - - /* SPHERE SHAPE */ - local sphere_mesh = VisualServer.make_sphere_mesh(10,20,1.0); - local sphere_material = VisualServer.fixed_material_create(); - //VisualServer.material_set_flag( sphere_material, VisualServer.MATERIAL_FLAG_WIREFRAME, true ); - VisualServer.fixed_material_set_parameter( sphere_material, VisualServer.FIXED_MATERIAL_PARAM_DIFFUSE, Color(0.7,0.8,3.0) ); - VisualServer.mesh_surface_set_material( sphere_mesh, 0, sphere_material ); - type_mesh_map[PhysicsServer.SHAPE_SPHERE] <- sphere_mesh; - - local sphere_shape=PhysicsServer.shape_create(PhysicsServer.SHAPE_SPHERE); - PhysicsServer.shape_set_data( sphere_shape, 1.0 ); - type_shape_map[PhysicsServer.SHAPE_SPHERE] <- sphere_shape; - - /* BOX SHAPE */ - - local box_planes = GeometryUtils.build_box_planes(Vector3(0.5,0.5,0.5)); - local box_material = VisualServer.fixed_material_create(); - VisualServer.fixed_material_set_parameter( box_material, VisualServer.FIXED_MATERIAL_PARAM_DIFFUSE, Color(1.0,0.2,0.2) ); - local box_mesh = VisualServer.mesh_create(); - - VisualServer.mesh_add_surface_from_planes(box_mesh,box_planes); - VisualServer.mesh_surface_set_material( box_mesh, 0, box_material ); - type_mesh_map[PhysicsServer.SHAPE_BOX]<- box_mesh; - - local box_shape=PhysicsServer.shape_create(PhysicsServer.SHAPE_BOX); - PhysicsServer.shape_set_data( box_shape, Vector3(0.5,0.5,0.5) ); - type_shape_map[PhysicsServer.SHAPE_BOX]<- box_shape; - - /* CYLINDER SHAPE */ - - local cylinder_planes = GeometryUtils.build_cylinder_planes(0.5,1,12 - ,Vector3.AXIS_Z); - local cylinder_material = VisualServer.fixed_material_create(); - VisualServer.fixed_material_set_parameter( cylinder_material, VisualServer.FIXED_MATERIAL_PARAM_DIFFUSE, Color(0.3,0.4,1.0) ); - local cylinder_mesh = VisualServer.mesh_create(); - - VisualServer.mesh_add_surface_from_planes(cylinder_mesh,cylinder_planes); - VisualServer.mesh_surface_set_material( cylinder_mesh, 0, cylinder_material ); - type_mesh_map[PhysicsServer.SHAPE_CYLINDER]<- cylinder_mesh; - - local cylinder_shape=PhysicsServer.shape_create(PhysicsServer.SHAPE_CYLINDER); - local cylinder_params={} - cylinder_params["radius"]<- 0.5; - cylinder_params["height"]<- 2; - PhysicsServer.shape_set_data( cylinder_shape, cylinder_params ); - type_shape_map[PhysicsServer.SHAPE_CYLINDER]<- cylinder_shape; - - /* CAPSULE SHAPE */ - - local capsule_planes = GeometryUtils.build_capsule_planes(0.5,0.7,12,Vector3.AXIS_Z); - local capsule_material = VisualServer.fixed_material_create(); - VisualServer.fixed_material_set_parameter( capsule_material, VisualServer.FIXED_MATERIAL_PARAM_DIFFUSE, Color(0.3,0.4,1.0) ); - - local capsule_mesh = VisualServer.mesh_create(); - - VisualServer.mesh_add_surface_from_planes(capsule_mesh,capsule_planes); - VisualServer.mesh_surface_set_material( capsule_mesh, 0, capsule_material ); - type_mesh_map[PhysicsServer.SHAPE_CAPSULE]<-capsule_mesh; - - local capsule_shape=PhysicsServer.shape_create(PhysicsServer.SHAPE_CAPSULE); - local capsule_params={} - capsule_params["radius"]<- 0.5; - capsule_params["height"]<- 1.4; - PhysicsServer.shape_set_data( capsule_shape, capsule_params ); - type_shape_map[PhysicsServer.SHAPE_CAPSULE]<- capsule_shape; - - /* CONVEX SHAPE */ - - local convex_planes = GeometryUtils.build_cylinder_planes(0.5,0.7,5,Vector3.AXIS_Z); - local convex_material = VisualServer.fixed_material_create(); - VisualServer.fixed_material_set_parameter( convex_material, VisualServer.FIXED_MATERIAL_PARAM_DIFFUSE, Color(0.8,0.2,0.9)); - - local convex_mesh = VisualServer.mesh_create(); - VisualServer.mesh_add_surface_from_planes(convex_mesh,convex_planes); - VisualServer.mesh_surface_set_material( convex_mesh, 0, convex_material ); - type_mesh_map[PhysicsServer.SHAPE_CONVEX_POLYGON]<- convex_mesh; - - local convex_shape=PhysicsServer.shape_create(PhysicsServer.SHAPE_CONVEX_POLYGON); - PhysicsServer.shape_set_data( convex_shape, convex_planes ); - type_shape_map[PhysicsServer.SHAPE_CONVEX_POLYGON]<- convex_shape; - - } - - function make_trimesh(p_faces,p_xform=Transform()) { - - local trimesh_shape = PhysicsServer.shape_create(PhysicsServer.SHAPE_CONCAVE_POLYGON); - PhysicsServer.shape_set_data(trimesh_shape, p_faces); - p_faces=PhysicsServer.shape_get_data(trimesh_shape); // optimized one - normals=[] - - for (i=0;i<p_faces.length()/3;i++) { - - p=Plane( p_faces[i*3+0],p_faces[i*3+1], p_faces[i*3+2] ); - normals.append(p.normal); - normals.append(p.normal); - normals.append(p.normal); - } - - local trimesh_mesh = VisualServer.mesh_create(); - VisualServer.mesh_add_surface(trimesh_mesh, VS::PRIMITIVE_TRIANGLES, VS::ARRAY_FORMAT_VERTEX|VS::ARRAY_FORMAT_NORMAL, p_faces.length() ); - VisualServer.mesh_surface_set_array(trimesh_mesh,0,VS::ARRAY_VERTEX, p_faces ); - VisualServer.mesh_surface_set_array(trimesh_mesh,0,VS::ARRAY_NORMAL, normals ); - local trimesh_mat = VisualServer.fixed_material_create(); - VisualServer.fixed_material_set_parameter( trimesh_mat, VisualServer.FIXED_MATERIAL_PARAM_DIFFUSE, Color(1.0,0.5,0.8)); - //VisualServer.material_set_flag( trimesh_mat, VisualServer.MATERIAL_FLAG_UNSHADED,true); - VisualServer.mesh_surface_set_material( trimesh_mesh, 0, trimesh_mat ); - - local triins = VisualServer.instance_create(trimesh_mesh); - - - local tribody = PhysicsServer.body_create(RID(), PhysicsServer.BODY_MODE_STATIC); - PhysicsServer.body_add_shape(tribody, trimesh_shape); - tritrans = p_xform; - PhysicsServer.body_set_state( tribody, PhysicsServer.BODY_STATE_TRANSFORM, tritrans ); - VisualServer.instance_set_transform( triins, tritrans ); - //RID trimesh_material = VisualServer.fixed_material_create(); - //VisualServer.material_generate( trimesh_material, Color(0.2,0.4,0.6) ); - //VisualServer.mesh_surface_set_material( trimesh_mesh, 0, trimesh_material ); - - } - - function make_grid(p_width,p_height,p_cellsize,p_cellheight,p_xform=Transform()) { - - local grid = [] - - for (local i =0;i<p_width;i++) { - - local row = [] - - for (local j=0;j<p_height;j++) { - - local val = 1.0+Math.random(-p_cellheight, p_cellheight ); - row.append(val) - } - grid.append(row) - } - - local faces=[] - - for (local i =1;i<p_width;i++) { - - for (local j=1;j<p_height;j++) { - - function MAKE_VERTEX(m_x,m_z) { - local v= Vector3( (m_x-p_width/2)*p_cellsize, grid[m_x][m_z], (m_z-p_height/2)*p_cellsize ) - faces.push_back(v) - } - - - MAKE_VERTEX(i,j-1) - MAKE_VERTEX(i,j) - MAKE_VERTEX(i-1,j) - - MAKE_VERTEX(i-1,j-1) - MAKE_VERTEX(i,j-1) - MAKE_VERTEX(i-1,j) - - } - } - - make_trimesh(faces,p_xform); - } - - quit=false - - transform = Transform() - camera=RID() - - function init_internal() {} - function iteration_internal(time) {} -//public - - - function input_event(p_event) { - - - } - - function request_quit() { - - quit=true; - } - - function init() { - - init_shapes(); - - - /* LIGHT */ - local lightaux = VisualServer.light_create( VisualServer.LIGHT_DIRECTIONAL ); - //VisualServer.light_set_color( lightaux, VisualServer.LIGHT_COLOR_AMBIENT, Color(0.0,0.0,0.0) ); - VisualServer.light_set_shadow(lightaux,true); - local light = VisualServer.instance_create( lightaux ); - local t=Transform() - t.rotate(Vector3(1.0,0,0),0.6); - VisualServer.instance_set_transform(light,t); - - - /* CAMERA */ - - camera = VisualServer.camera_create(); - local viewport = VisualServer.viewport_create(); - VisualServer.viewport_attach_camera( viewport, camera ); - VisualServer.viewport_set_parent(viewport, RID() ); - - VisualServer.camera_set_perspective(camera,60,0.1,20.0); - cameratr=Transform( Matrix3(), Vector3(0,2,8)) - VisualServer.camera_set_transform(camera,cameratr); - - quit=false; - - init_internal() - - } - - - function iteration(p_time) { - - // VisualServer.camera_set_transform(camera,cameratr); - iteration_internal(p_time) - - return quit; - } - - function idle(p_time) { - - return quit; - } - - - function finish() { - - } - - - constructor() { - MainLoopScripted.constructor(); - } - -} - - -return PhysicsTestBase; diff --git a/doc/examples/physics/script/test_fall.sq b/doc/examples/physics/script/test_fall.sq deleted file mode 100644 index 79526da8b4..0000000000 --- a/doc/examples/physics/script/test_fall.sq +++ /dev/null @@ -1,42 +0,0 @@ - -include("test_base.sq") - -class TestFall extends PhysicsTestBase { - - - fall_elements=10 - - function init_internal() { - - for (local i=0;i<10;i++) { - - local shape_idx=[ - PhysicsServer.SHAPE_SPHERE, - PhysicsServer.SHAPE_BOX, - PhysicsServer.SHAPE_CAPSULE, - PhysicsServer.SHAPE_CYLINDER, - PhysicsServer.SHAPE_CONVEX_POLYGON - ]; - - local stype=shape_idx[i%5]; -// stype=PhysicsServer.SHAPE_SPHERE; - - local t=Transform() - t.set_origin(Vector3(-0.7+0.0*i,3.5+4.1*i,0)) - t.rotate_basis(Vector3(1,0,0),Math.PI/4*i) - - local b = create_body(stype,PhysicsServer.BODY_MODE_RIGID,t); - - } - - create_static_plane( Plane( Vector3(0,1,0), -1) ); - - } - - constructor() { - PhysicsTestBase.constructor() - } -} - - -return TestFall diff --git a/doc/gdscript.lyx b/doc/gdscript.lyx deleted file mode 100644 index a4b2230121..0000000000 --- a/doc/gdscript.lyx +++ /dev/null @@ -1,2531 +0,0 @@ -#LyX 2.0 created this file. For more info see http://www.lyx.org/ -\lyxformat 413 -\begin_document -\begin_header -\textclass article -\use_default_options true -\maintain_unincluded_children false -\language english -\language_package default -\inputencoding auto -\fontencoding global -\font_roman default -\font_sans default -\font_typewriter default -\font_default_family default -\use_non_tex_fonts false -\font_sc false -\font_osf false -\font_sf_scale 100 -\font_tt_scale 100 - -\graphics default -\default_output_format default -\output_sync 0 -\bibtex_command default -\index_command default -\paperfontsize default -\use_hyperref false -\papersize default -\use_geometry false -\use_amsmath 1 -\use_esint 1 -\use_mhchem 1 -\use_mathdots 1 -\cite_engine basic -\use_bibtopic false -\use_indices false -\paperorientation portrait -\suppress_date false -\use_refstyle 0 -\index Index -\shortcut idx -\color #008000 -\end_index -\secnumdepth 3 -\tocdepth 3 -\paragraph_separation indent -\paragraph_indentation default -\quotes_language english -\papercolumns 1 -\papersides 1 -\paperpagestyle default -\tracking_changes false -\output_changes false -\html_math_output 0 -\html_css_as_file 0 -\html_be_strict false -\end_header - -\begin_body - -\begin_layout Title -GD Scripting Language (GDScript) -\end_layout - -\begin_layout Section -Introduction -\end_layout - -\begin_layout Standard -GDScript is a high level, dynamically typed programming language used to - create content. - It uses a syntax that is very similar to the Python language (blocks are - indent-based) and it's goal is to be very optimal and tigthly integrated - with the engine, allowing great flexibility for content creation and integratio -n. - -\end_layout - -\begin_layout Section -Example -\end_layout - -\begin_layout Standard -Some people can learn better by just taking a look at the syntax, so here's - a simple example of how it looks. - -\end_layout - -\begin_layout Standard -\begin_inset listings -inline false -status open - -\begin_layout Plain Layout - -#a file is a class! -\end_layout - -\begin_layout Plain Layout - -\end_layout - -\begin_layout Plain Layout - -#inheritance -\end_layout - -\begin_layout Plain Layout - -extends BaseClass -\end_layout - -\begin_layout Plain Layout - -\end_layout - -\begin_layout Plain Layout - -#member variables -\end_layout - -\begin_layout Plain Layout - -\end_layout - -\begin_layout Plain Layout - -var a=5 -\end_layout - -\begin_layout Plain Layout - -var s="Hello" -\end_layout - -\begin_layout Plain Layout - -var arr=[1,2,3] -\end_layout - -\begin_layout Plain Layout - -var dict={"key":"value", 2:3} -\end_layout - -\begin_layout Plain Layout - -\end_layout - -\begin_layout Plain Layout - -#constants -\end_layout - -\begin_layout Plain Layout - -\end_layout - -\begin_layout Plain Layout - -const answer=42 -\end_layout - -\begin_layout Plain Layout - -const thename="Charly" -\end_layout - -\begin_layout Plain Layout - -\end_layout - -\begin_layout Plain Layout - -#built-in vector types -\end_layout - -\begin_layout Plain Layout - -\end_layout - -\begin_layout Plain Layout - -var v2 = Vector2(1,2) -\end_layout - -\begin_layout Plain Layout - -var v3 = Vector3(1,2,3) -\end_layout - -\begin_layout Plain Layout - -\end_layout - -\begin_layout Plain Layout - -#function -\end_layout - -\begin_layout Plain Layout - -\end_layout - -\begin_layout Plain Layout - -func some_function(param1,param2): -\end_layout - -\begin_layout Plain Layout - - var local_var=5 -\end_layout - -\begin_layout Plain Layout - -\end_layout - -\begin_layout Plain Layout - - if param1 < local_var: -\end_layout - -\begin_layout Plain Layout - - print(param1) -\end_layout - -\begin_layout Plain Layout - - elif param2 > 5: -\end_layout - -\begin_layout Plain Layout - - print(param2) -\end_layout - -\begin_layout Plain Layout - - else: -\end_layout - -\begin_layout Plain Layout - - print("fail!") -\end_layout - -\begin_layout Plain Layout - -\end_layout - -\begin_layout Plain Layout - - for i in range(20): -\end_layout - -\begin_layout Plain Layout - - print(i) -\end_layout - -\begin_layout Plain Layout - -\end_layout - -\begin_layout Plain Layout - - while(param2!=0): -\end_layout - -\begin_layout Plain Layout - - param2-=1 -\end_layout - -\begin_layout Plain Layout - -\end_layout - -\begin_layout Plain Layout - - var local_var2 = param1+3 -\end_layout - -\begin_layout Plain Layout - - return local_var2 -\end_layout - -\begin_layout Plain Layout - -\end_layout - -\begin_layout Plain Layout - -\end_layout - -\begin_layout Plain Layout - -#subclass -\end_layout - -\begin_layout Plain Layout - -\end_layout - -\begin_layout Plain Layout - -class Something: -\end_layout - -\begin_layout Plain Layout - - var a=10 -\end_layout - -\begin_layout Plain Layout - -\end_layout - -\begin_layout Plain Layout - -#constructor -\end_layout - -\begin_layout Plain Layout - -\end_layout - -\begin_layout Plain Layout - -func _init(): -\end_layout - -\begin_layout Plain Layout - - print("constructed!") -\end_layout - -\begin_layout Plain Layout - - var lv = Something.new() -\end_layout - -\begin_layout Plain Layout - - print(lv.a) -\end_layout - -\begin_layout Plain Layout - -\end_layout - -\begin_layout Plain Layout - -\end_layout - -\end_inset - - -\end_layout - -\begin_layout Section -Language -\end_layout - -\begin_layout Subsection -Identifiers -\end_layout - -\begin_layout Standard -Any string that restricts itself to alphabetic characters ('a' to 'z' and - 'A' to 'Z'), digits ('0' to '9') and '_' qualifies as an identifier. - As an extra restriction, identifiers must not begin with a digit. - Identifiers are case-sensitive ('foo' is different to 'FOO'). -\end_layout - -\begin_layout Subsection -Keywords -\end_layout - -\begin_layout Standard -The following is the list of keywords supported by the language. - Since keywords are reserved words (tokens), they can't be used as identifiers. -\end_layout - -\begin_layout Subsection -Operators -\end_layout - -\begin_layout Standard -The following is the list of supported operators and their precedence (TODO, - change since this was made to reflect python operators) -\end_layout - -\begin_layout Standard -\begin_inset Tabular -<lyxtabular version="3" rows="18" columns="2"> -<features tabularvalignment="middle"> -<column alignment="center" valignment="top" width="0"> -<column alignment="center" valignment="top" width="0"> -<row> -<cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none"> -\begin_inset Text - -\begin_layout Plain Layout -Operator -\end_layout - -\end_inset -</cell> -<cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none"> -\begin_inset Text - -\begin_layout Plain Layout -Note -\end_layout - -\end_inset -</cell> -</row> -<row> -<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none"> -\begin_inset Text - -\begin_layout Plain Layout -x[index] -\end_layout - -\end_inset -</cell> -<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none"> -\begin_inset Text - -\begin_layout Plain Layout -Subscription, Highest Priority -\end_layout - -\end_inset -</cell> -</row> -<row> -<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none"> -\begin_inset Text - -\begin_layout Plain Layout -x.attribute -\end_layout - -\end_inset -</cell> -<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none"> -\begin_inset Text - -\begin_layout Plain Layout -Attribute Reference -\end_layout - -\end_inset -</cell> -</row> -<row> -<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none"> -\begin_inset Text - -\begin_layout Plain Layout -extends -\end_layout - -\end_inset -</cell> -<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none"> -\begin_inset Text - -\begin_layout Plain Layout -Instance Type Checker -\end_layout - -\end_inset -</cell> -</row> -<row> -<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none"> -\begin_inset Text - -\begin_layout Plain Layout -~ -\end_layout - -\end_inset -</cell> -<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none"> -\begin_inset Text - -\begin_layout Plain Layout -Bitwise NOT -\end_layout - -\end_inset -</cell> -</row> -<row> -<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none"> -\begin_inset Text - -\begin_layout Plain Layout --x -\end_layout - -\end_inset -</cell> -<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none"> -\begin_inset Text - -\begin_layout Plain Layout -Negative -\end_layout - -\end_inset -</cell> -</row> -<row> -<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none"> -\begin_inset Text - -\begin_layout Plain Layout -* / % -\end_layout - -\end_inset -</cell> -<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none"> -\begin_inset Text - -\begin_layout Plain Layout -Mult / Div / Remainder -\end_layout - -\end_inset -</cell> -</row> -<row> -<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none"> -\begin_inset Text - -\begin_layout Plain Layout -+ - -\end_layout - -\end_inset -</cell> -<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none"> -\begin_inset Text - -\begin_layout Plain Layout -Addition / Substraction -\end_layout - -\end_inset -</cell> -</row> -<row> -<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none"> -\begin_inset Text - -\begin_layout Plain Layout -<< >> -\end_layout - -\end_inset -</cell> -<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none"> -\begin_inset Text - -\begin_layout Plain Layout -Bit Shifting -\end_layout - -\end_inset -</cell> -</row> -<row> -<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none"> -\begin_inset Text - -\begin_layout Plain Layout -& -\end_layout - -\end_inset -</cell> -<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none"> -\begin_inset Text - -\begin_layout Plain Layout -Bitwise AND -\end_layout - -\end_inset -</cell> -</row> -<row> -<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none"> -\begin_inset Text - -\begin_layout Plain Layout -^ -\end_layout - -\end_inset -</cell> -<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none"> -\begin_inset Text - -\begin_layout Plain Layout -Bitwise XOR -\end_layout - -\end_inset -</cell> -</row> -<row> -<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none"> -\begin_inset Text - -\begin_layout Plain Layout -| -\end_layout - -\end_inset -</cell> -<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none"> -\begin_inset Text - -\begin_layout Plain Layout -Bitwise OR -\end_layout - -\end_inset -</cell> -</row> -<row> -<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none"> -\begin_inset Text - -\begin_layout Plain Layout -< > == != >= <= -\end_layout - -\end_inset -</cell> -<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none"> -\begin_inset Text - -\begin_layout Plain Layout -Comparisons -\end_layout - -\end_inset -</cell> -</row> -<row> -<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none"> -\begin_inset Text - -\begin_layout Plain Layout -in -\end_layout - -\end_inset -</cell> -<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none"> -\begin_inset Text - -\begin_layout Plain Layout -Content Test -\end_layout - -\end_inset -</cell> -</row> -<row> -<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none"> -\begin_inset Text - -\begin_layout Plain Layout -! not -\end_layout - -\end_inset -</cell> -<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none"> -\begin_inset Text - -\begin_layout Plain Layout -Boolean NOT -\end_layout - -\end_inset -</cell> -</row> -<row> -<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none"> -\begin_inset Text - -\begin_layout Plain Layout -and && -\end_layout - -\end_inset -</cell> -<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none"> -\begin_inset Text - -\begin_layout Plain Layout -Boolean AND -\end_layout - -\end_inset -</cell> -</row> -<row> -<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none"> -\begin_inset Text - -\begin_layout Plain Layout -or || -\end_layout - -\end_inset -</cell> -<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none"> -\begin_inset Text - -\begin_layout Plain Layout -Boolean OR -\end_layout - -\end_inset -</cell> -</row> -<row> -<cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none"> -\begin_inset Text - -\begin_layout Plain Layout -= += -= *= /= ^= &= |= -\end_layout - -\end_inset -</cell> -<cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none"> -\begin_inset Text - -\begin_layout Plain Layout -Assignment, Lowest Priority -\end_layout - -\end_inset -</cell> -</row> -</lyxtabular> - -\end_inset - - -\end_layout - -\begin_layout Subsection -Literals -\end_layout - -\begin_layout Standard -\begin_inset Tabular -<lyxtabular version="3" rows="6" columns="2"> -<features tabularvalignment="middle"> -<column alignment="center" valignment="top" width="0"> -<column alignment="center" valignment="top" width="0"> -<row> -<cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none"> -\begin_inset Text - -\begin_layout Plain Layout -Literal -\end_layout - -\end_inset -</cell> -<cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none"> -\begin_inset Text - -\begin_layout Plain Layout -Name -\end_layout - -\end_inset -</cell> -</row> -<row> -<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none"> -\begin_inset Text - -\begin_layout Plain Layout -45 -\end_layout - -\end_inset -</cell> -<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none"> -\begin_inset Text - -\begin_layout Plain Layout -Base 10 Integer -\end_layout - -\end_inset -</cell> -</row> -<row> -<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none"> -\begin_inset Text - -\begin_layout Plain Layout -0x8F51 -\end_layout - -\end_inset -</cell> -<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none"> -\begin_inset Text - -\begin_layout Plain Layout -Base 16 (hex) Integer -\end_layout - -\end_inset -</cell> -</row> -<row> -<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none"> -\begin_inset Text - -\begin_layout Plain Layout -3.14, 58.1e-10 -\end_layout - -\end_inset -</cell> -<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none"> -\begin_inset Text - -\begin_layout Plain Layout -Floating Point Number (real) -\end_layout - -\end_inset -</cell> -</row> -<row> -<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none"> -\begin_inset Text - -\begin_layout Plain Layout -'Hello', -\begin_inset Quotes eld -\end_inset - -Hi -\begin_inset Quotes erd -\end_inset - - -\end_layout - -\end_inset -</cell> -<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none"> -\begin_inset Text - -\begin_layout Plain Layout -Strings -\end_layout - -\end_inset -</cell> -</row> -<row> -<cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none"> -\begin_inset Text - -\begin_layout Plain Layout -@'Hello', @'Hi' -\end_layout - -\end_inset -</cell> -<cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none"> -\begin_inset Text - -\begin_layout Plain Layout -Internationalized Strings -\end_layout - -\end_inset -</cell> -</row> -</lyxtabular> - -\end_inset - - -\end_layout - -\begin_layout Subsection -Comments -\end_layout - -\begin_layout Standard -Anything from a '#' to the end of the line is ignored and is considered - a comment. -\end_layout - -\begin_layout Standard -\begin_inset listings -lstparams "language=Python" -inline false -status open - -\begin_layout Plain Layout - -# This is a comment -\end_layout - -\end_inset - - -\end_layout - -\begin_layout Section -Built-in Types -\end_layout - -\begin_layout Subsection -Basic Bult-In Types -\end_layout - -\begin_layout Standard -A variable in GDScript can be assigned many of several built-in types. - -\end_layout - -\begin_layout Subsubsection -null -\end_layout - -\begin_layout Standard -'null' is a data type that contains no information, nothing assigned, and - it's just empy. - It can only be set to one value: 'null'. -\end_layout - -\begin_layout Subsubsection -bool -\end_layout - -\begin_layout Standard -Boolean data type, can only contain 'true' or 'false'. -\end_layout - -\begin_layout Subsubsection -int -\end_layout - -\begin_layout Standard -Integer data type, can only contain integer numbers, negative and positive. -\end_layout - -\begin_layout Subsubsection -float -\end_layout - -\begin_layout Standard -contains a floating point value (real). -\end_layout - -\begin_layout Subsubsection -String -\end_layout - -\begin_layout Standard -Sequence of characters in unicode format. - Strings can contain the standard C escape sequences. -\end_layout - -\begin_layout Subsection -Vector Built-In Types -\end_layout - -\begin_layout Subsubsection -Vector2/Size2 -\end_layout - -\begin_layout Standard -2D vector type, containing x and y fields. - Can alternatively access fields as width and height for readability. - Can also be accessed as array. -\end_layout - -\begin_layout Subsubsection -Rect2 -\end_layout - -\begin_layout Standard -2D Rectangle type. - Contains 2 vectors fields, -\begin_inset Quotes eld -\end_inset - -pos -\begin_inset Quotes erd -\end_inset - - and size -\begin_inset Quotes erd -\end_inset - -. - Alternatively contains an -\begin_inset Quotes eld -\end_inset - -end -\begin_inset Quotes erd -\end_inset - - field which is -\begin_inset Quotes eld -\end_inset - -pos+size -\begin_inset Quotes erd -\end_inset - -. -\end_layout - -\begin_layout Subsubsection -Vector3 -\end_layout - -\begin_layout Standard -3D vector type. - Contains x, y and z fields. - Can also be accessed as array. -\end_layout - -\begin_layout Subsubsection -Matrix32 -\end_layout - -\begin_layout Standard -3x2 matrix used for 2D transforms. -\end_layout - -\begin_layout Subsubsection -Plane -\end_layout - -\begin_layout Standard -3D Plane type in normalized form. - Contains a -\begin_inset Quotes eld -\end_inset - -normal -\begin_inset Quotes erd -\end_inset - - vector field and a -\begin_inset Quotes eld -\end_inset - -d -\begin_inset Quotes erd -\end_inset - - scalar distance. -\end_layout - -\begin_layout Subsubsection -Quat -\end_layout - -\begin_layout Standard -Quaternion, datatype used for representing a 3D rotation. - It's useful for interpolating rotations. -\end_layout - -\begin_layout Subsubsection -AABB/Box3 -\end_layout - -\begin_layout Standard -Axis Aligned bounding box (or alternatively, 3D box). - Contains 2 vectors fields, -\begin_inset Quotes eld -\end_inset - -pos -\begin_inset Quotes erd -\end_inset - - and size -\begin_inset Quotes erd -\end_inset - -. - Alternatively contains an -\begin_inset Quotes eld -\end_inset - -end -\begin_inset Quotes erd -\end_inset - - field which is -\begin_inset Quotes eld -\end_inset - -pos+size -\begin_inset Quotes erd -\end_inset - -. -\end_layout - -\begin_layout Subsubsection -Matrix3 -\end_layout - -\begin_layout Standard -3x3 matrix used for 3D rotation and scale. - Contains 3 vector fields x,y and z. - Can also be accessed as array of 3D vectors. -\end_layout - -\begin_layout Subsubsection -Transform -\end_layout - -\begin_layout Standard -3D Transform, contains a Matrix3 field -\begin_inset Quotes eld -\end_inset - -basis -\begin_inset Quotes erd -\end_inset - - and a Vector3 field -\begin_inset Quotes eld -\end_inset - -origin -\begin_inset Quotes erd -\end_inset - -. -\end_layout - -\begin_layout Subsection -Engine Built-In Types -\end_layout - -\begin_layout Subsubsection -Color -\end_layout - -\begin_layout Standard -Color datatype, contains r,g,b,a fields. - Can also be accessed as h,s,v for hue/saturation/value. -\end_layout - -\begin_layout Subsubsection -Image -\end_layout - -\begin_layout Standard -Contains a 2D Image of custom format and allows direct access to the pixels. -\end_layout - -\begin_layout Subsubsection -NodePath -\end_layout - -\begin_layout Standard -Compiled path to a node, used mainly in the scene system. - Can be easily asigned from/to a String. -\end_layout - -\begin_layout Subsubsection -RID -\end_layout - -\begin_layout Standard -Resource ID (RID). - Servers use generic RIDs to reference opaque data. -\end_layout - -\begin_layout Subsubsection -Object -\end_layout - -\begin_layout Standard -Base class for anything not a built-in type. - -\end_layout - -\begin_layout Subsubsection -InputEvent -\end_layout - -\begin_layout Standard -Events from input devices are contained in very compact form in InputEvent - objects. - Due to fact they can be received in high amounts from frame to frame, they - are optimized in their own datatype. - -\end_layout - -\begin_layout Subsection -Container Built-In Types -\end_layout - -\begin_layout Subsubsection -Array -\end_layout - -\begin_layout Standard -Generic sequence of objects. - It's size can be changed to anything and starts from index 0. - -\end_layout - -\begin_layout Standard -\begin_inset listings -inline false -status open - -\begin_layout Plain Layout - -var arr=[] -\end_layout - -\begin_layout Plain Layout - -arr=[1,2,3] -\end_layout - -\begin_layout Plain Layout - -arr[0]="Hi!" -\end_layout - -\end_inset - - -\end_layout - -\begin_layout Standard -Arrays are allocated linearly in memory, so they are fast, but very large - arrays (more than tens of thousands of elements) may cause fragmentation. - There are specialized arrays for some built-in datatypes which do not suffer - from this and use much less memory. -\end_layout - -\begin_layout Subsubsection -Dictionary -\end_layout - -\begin_layout Standard -Associative container which contains values referenced by unique keys. -\end_layout - -\begin_layout Standard -\begin_inset listings -inline false -status open - -\begin_layout Plain Layout - -var dict={4:5, "a key":"a value", 28:[1,2,3]} -\end_layout - -\begin_layout Plain Layout - -dict["Hi!"]=0 -\end_layout - -\end_inset - - -\end_layout - -\begin_layout Subsubsection -ByteArray -\end_layout - -\begin_layout Standard -Array of bytes. - Can only contains bytes (integers from 0 to 255). - Optimized for memory usage, can't fragment the memory. -\end_layout - -\begin_layout Subsubsection -IntArray -\end_layout - -\begin_layout Standard -Array of integers. - Can only contain integers. - Optimized for memory usage, can't fragment the memory. -\end_layout - -\begin_layout Subsubsection -FloatArray -\end_layout - -\begin_layout Standard -Array of floats, can only contain floats. - Optimized for memory usage, can't fragment the memory. -\end_layout - -\begin_layout Subsubsection -StringArray -\end_layout - -\begin_layout Standard -Array of strings, can only contain strings. - Optimized for memory usage, can't fragment the memory. -\end_layout - -\begin_layout Subsubsection -Vector2Array -\end_layout - -\begin_layout Standard -Array of Vector2, can only contain 2D Vectors. - Optimized for memory usage, can't fragment the memory. -\end_layout - -\begin_layout Subsubsection -Vector3Array -\end_layout - -\begin_layout Standard -Array of Vector3, can only contain 3D Vectors. - Optimized for memory usage, can't fragment the memory. -\end_layout - -\begin_layout Subsubsection -ColorArray -\end_layout - -\begin_layout Standard -Array of Color, can only contains colors. - Optimized for memory usage, can't fragment the memory. -\end_layout - -\begin_layout Section -Data -\end_layout - -\begin_layout Subsection -Variables -\end_layout - -\begin_layout Standard -Variables can exist as class members or local to functions. - They are created with the -\begin_inset Quotes eld -\end_inset - -var -\begin_inset Quotes erd -\end_inset - - keyword and may be, optionally, be assigned a value upon initialization. -\end_layout - -\begin_layout Standard -\begin_inset listings -inline false -status open - -\begin_layout Plain Layout - -var a # datatype is null by default -\end_layout - -\begin_layout Plain Layout - -var b = 5 -\end_layout - -\begin_layout Plain Layout - -var c = 3.8 -\end_layout - -\begin_layout Plain Layout - -var d = b+c # variables are always initialized in order -\end_layout - -\end_inset - - -\end_layout - -\begin_layout Subsection -Constants -\end_layout - -\begin_layout Standard -Constants are similar to variables, but must be constants or constant expression -s and must be assigned on initialization. -\end_layout - -\begin_layout Standard -\begin_inset listings -inline false -status open - -\begin_layout Plain Layout - -const a = 5 -\end_layout - -\begin_layout Plain Layout - -const b = Vector2(20,20) -\end_layout - -\begin_layout Plain Layout - -const c = 10+20 # constant expression -\end_layout - -\begin_layout Plain Layout - -const d = Vector2(20,30).x # constant expression: 20 -\end_layout - -\begin_layout Plain Layout - -const e = [1,2,3,4][0] # constant expression: 1 -\end_layout - -\begin_layout Plain Layout - -const f = sin(20) # sin() can be used in constant expression -\end_layout - -\begin_layout Plain Layout - -const g = x+20 # invalid, not a constant expression! -\end_layout - -\begin_layout Plain Layout - -\end_layout - -\end_inset - - -\end_layout - -\begin_layout Subsection -Functions -\end_layout - -\begin_layout Standard -Functions always belong to a class. - The scope priority for variable look-up is: local -> class member -> global. - -\begin_inset Quotes eld -\end_inset - -self -\begin_inset Quotes erd -\end_inset - - is provided as an option for accessing class members but is not required - always (and must -\emph on -not -\emph default - be defined as first parameter, like in Python). - For performance reasons, functions are not considered class members, so - they can't be referenced directly. - A function can return at any point. - The default return value is null. -\end_layout - -\begin_layout Standard -\begin_inset listings -inline false -status open - -\begin_layout Plain Layout - -func myfunction(a,b): -\end_layout - -\begin_layout Plain Layout - - print(a) -\end_layout - -\begin_layout Plain Layout - - print(b) -\end_layout - -\begin_layout Plain Layout - - return a+b # return is optional, otherwise null is returned -\end_layout - -\end_inset - - -\end_layout - -\begin_layout Subsubsection -Statements and Control Flow -\end_layout - -\begin_layout Standard -Statements are standard, and can be assignments, function calls, control - flow structures, etc (see below). - -\begin_inset Quotes eld -\end_inset - -; -\begin_inset Quotes erd -\end_inset - - as separator is entirely optional. -\end_layout - -\begin_layout Subsubsection -if/else/elif -\end_layout - -\begin_layout Standard -Simple conditions are created by using the -\emph on -if/else/elif -\emph default - syntax. - Parenthesis around statements is allowed but not requiered. - Given the nature of the tab-based indentation, elif can be used instead - of else:/if: to mantain a level of indentation. -\end_layout - -\begin_layout Standard -\begin_inset listings -inline false -status open - -\begin_layout Plain Layout - -if [expression]: -\end_layout - -\begin_layout Plain Layout - - statement(s) -\end_layout - -\begin_layout Plain Layout - -elif [expression]: -\end_layout - -\begin_layout Plain Layout - - statement(s) -\end_layout - -\begin_layout Plain Layout - -else: -\end_layout - -\begin_layout Plain Layout - - statement(s) -\end_layout - -\end_inset - - -\end_layout - -\begin_layout Subsubsection -while -\end_layout - -\begin_layout Standard -Simple loops are created by using -\emph on -while -\emph default - syntax. - Loops can be broken using -\emph on -break -\emph default -, or continued using -\emph on -continue -\emph default -: -\end_layout - -\begin_layout Standard -\begin_inset listings -inline false -status open - -\begin_layout Plain Layout - -while [expression]: -\end_layout - -\begin_layout Plain Layout - - statement(s) -\end_layout - -\end_inset - - -\end_layout - -\begin_layout Subsubsection -for -\end_layout - -\begin_layout Standard -To iterate a range, array or table a -\emph on -for -\emph default - loop is used. - For loops store the index in the loop variable on each iteration. -\end_layout - -\begin_layout Standard -\begin_inset listings -inline false -status open - -\begin_layout Plain Layout - -for i in [0,1,2]: -\end_layout - -\begin_layout Plain Layout - - statement # loop iterates 3 times, i being 0,1 and 2 -\end_layout - -\begin_layout Plain Layout - -\end_layout - -\begin_layout Plain Layout - -var dict = {"a":0, "b":1, "c": 2} -\end_layout - -\begin_layout Plain Layout - -for i in dict: -\end_layout - -\begin_layout Plain Layout - - print(dict[i]) # loop iterates the keys, i being "a","b" and c". - It prints 0, 1 and 2. -\end_layout - -\begin_layout Plain Layout - -\end_layout - -\begin_layout Plain Layout - -for i in range(3): -\end_layout - -\begin_layout Plain Layout - - statement # similar to [0,1,2] but does not allocate an array -\end_layout - -\begin_layout Plain Layout - -\end_layout - -\begin_layout Plain Layout - -for i in range(1,3): -\end_layout - -\begin_layout Plain Layout - - statement # similar to [1,2] but does not allocate an array -\end_layout - -\begin_layout Plain Layout - -\end_layout - -\begin_layout Plain Layout - -for i in range(2,8,2): -\end_layout - -\begin_layout Plain Layout - - statement # similar to [2,4,6] but does not allocate an array -\end_layout - -\begin_layout Plain Layout - -\end_layout - -\end_inset - - -\end_layout - -\begin_layout Section -Classes -\end_layout - -\begin_layout Standard -By default, the body of a script file is an unnamed class, and it can only - be referenced externally as a resource or file. - Class syntax is meant to be very compact and can only contain member variables - or functions. - Static functions are allowed, but not static members (in the spirit of - thread safety, since scripts can be initialized in separate threads without - the user knowing). - In the same way, member variables (including arrays and dictionaries) are - initialized every time an instance is created. - -\end_layout - -\begin_layout Subsection -Class File Example -\end_layout - -\begin_layout Standard -Example of a class file, imagine it being stored in a file like myclass.gd. -\end_layout - -\begin_layout Standard -\begin_inset listings -inline false -status open - -\begin_layout Plain Layout - -\end_layout - -\begin_layout Plain Layout - -var a=5 -\end_layout - -\begin_layout Plain Layout - -\end_layout - -\begin_layout Plain Layout - -function print_value_of_a(): -\end_layout - -\begin_layout Plain Layout - - print(a) -\end_layout - -\begin_layout Plain Layout - -\end_layout - -\end_inset - - -\end_layout - -\begin_layout Subsection -Inheritance -\end_layout - -\begin_layout Standard -A class-file can inherit from a global class, another file or a subclass - inside another file. - Multiple inheritance is not allowed. - The -\begin_inset Quotes eld -\end_inset - -extends -\begin_inset Quotes erd -\end_inset - - syntax is used: -\end_layout - -\begin_layout Standard -\begin_inset listings -inline false -status open - -\begin_layout Plain Layout - -# extend from some class (global) -\end_layout - -\begin_layout Plain Layout - -extends SomeClass -\end_layout - -\begin_layout Plain Layout - -\end_layout - -\begin_layout Plain Layout - -# optionally, extend from another file -\end_layout - -\begin_layout Plain Layout - -extends "somefile.gd" -\end_layout - -\begin_layout Plain Layout - -\end_layout - -\begin_layout Plain Layout - -# extend from a subclass in another file -\end_layout - -\begin_layout Plain Layout - -extends "somefile.gd".Subclass -\end_layout - -\end_inset - - -\end_layout - -\begin_layout Subsection -Inheritance Testing -\end_layout - -\begin_layout Standard -It is possible to check if an instance inherits from a given class. - For this the -\begin_inset Quotes eld -\end_inset - -extends -\begin_inset Quotes erd -\end_inset - - keyword can be used as an operator instead: -\end_layout - -\begin_layout Standard -\begin_inset listings -inline false -status open - -\begin_layout Plain Layout - -static var enemy_class = preload("enemy.gd") # cache the enemy class -\end_layout - -\begin_layout Plain Layout - -\end_layout - -\begin_layout Plain Layout - -[..] -\end_layout - -\begin_layout Plain Layout - -\end_layout - -\begin_layout Plain Layout - -if ( entity extends enemy_class ): -\end_layout - -\begin_layout Plain Layout - - entity.apply_damage() -\end_layout - -\begin_layout Plain Layout - -\end_layout - -\begin_layout Plain Layout - -\end_layout - -\begin_layout Plain Layout - -\end_layout - -\end_inset - - -\end_layout - -\begin_layout Subsection -Constructor -\end_layout - -\begin_layout Standard -A class can have an optional constructor, a function named -\begin_inset Quotes eld -\end_inset - -_init -\begin_inset Quotes erd -\end_inset - - that is called when the class is instanced. -\end_layout - -\begin_layout Subsection -Sub Classes -\end_layout - -\begin_layout Standard -A class file can have subclasses. - Syntax should be straightforward: -\end_layout - -\begin_layout Standard -\begin_inset listings -inline false -status open - -\begin_layout Plain Layout - -class SomeSubClass: -\end_layout - -\begin_layout Plain Layout - - var a=5 -\end_layout - -\begin_layout Plain Layout - - function print_value_of_a(): -\end_layout - -\begin_layout Plain Layout - - print(a) -\end_layout - -\begin_layout Plain Layout - -\end_layout - -\begin_layout Plain Layout - -function _init(): -\end_layout - -\begin_layout Plain Layout - - var sc = SomeSubClass.new() #instance by calling built-in new -\end_layout - -\begin_layout Plain Layout - - sc.print_value_of_a() -\end_layout - -\end_inset - - -\end_layout - -\begin_layout Subsection -Classes as Objects -\end_layout - -\begin_layout Standard -It may be desired at some point to load a class from a file and then instance - it. - Since the global scope does not exist, classes must be loaded as a resource. - Instancing is done by calling the -\begin_inset Quotes eld -\end_inset - -new -\begin_inset Quotes erd -\end_inset - - function in a class object: -\end_layout - -\begin_layout Standard -\begin_inset listings -inline false -status open - -\begin_layout Plain Layout - -#load the class (loaded every time the script is instanced) -\end_layout - -\begin_layout Plain Layout - -var MyClass = load("myclass.gd") -\end_layout - -\begin_layout Plain Layout - -\end_layout - -\begin_layout Plain Layout - -#alternatively, using the preload() function preloads the class at compile - time -\end_layout - -\begin_layout Plain Layout - -var MyClass2 = preload("myclass.gd") -\end_layout - -\begin_layout Plain Layout - -\end_layout - -\begin_layout Plain Layout - -function _init(): -\end_layout - -\begin_layout Plain Layout - - var a = MyClass.new() -\end_layout - -\begin_layout Plain Layout - - a.somefunction() -\end_layout - -\end_inset - - -\end_layout - -\begin_layout Subsection -Exports -\end_layout - -\begin_layout Standard -Class members can be exported. - This means their value gets saved along with a scene. - If class members have initializers to constant expressions, they will be - available for editing in the property editor. - Exporting is done by using the export keyword: -\end_layout - -\begin_layout Standard -\begin_inset listings -inline false -status open - -\begin_layout Plain Layout - -extends Button -\end_layout - -\begin_layout Plain Layout - -\end_layout - -\begin_layout Plain Layout - -export var data # value will be saved -\end_layout - -\begin_layout Plain Layout - -export var number=5 # also available to the property editor -\end_layout - -\begin_layout Plain Layout - -\end_layout - -\end_inset - - -\end_layout - -\begin_layout Standard -One of the fundamental benefits of exporting member variables is to have - them visible in the property editor. - This way artists and game designers can modify values that later influence - how the program runs. - For this, a special export syntax is provided for more detail in the exported - variables: -\end_layout - -\begin_layout Standard -\begin_inset listings -inline false -status open - -\begin_layout Plain Layout - -#if the exported value assigns a constant or constant expression, the type - will be infered and used in the editor -\end_layout - -\begin_layout Plain Layout - -\end_layout - -\begin_layout Plain Layout - -export var number=5 -\end_layout - -\begin_layout Plain Layout - -\end_layout - -\begin_layout Plain Layout - -#export can take a basic datatype as argument, which will be used in the - editor -\end_layout - -\begin_layout Plain Layout - -\end_layout - -\begin_layout Plain Layout - -export(int) var number -\end_layout - -\begin_layout Plain Layout - -\end_layout - -\begin_layout Plain Layout - -#export can also take a resource type as hint -\end_layout - -\begin_layout Plain Layout - -\end_layout - -\begin_layout Plain Layout - -export(Texture) var character_face -\end_layout - -\begin_layout Plain Layout - -\end_layout - -\begin_layout Plain Layout - -#integers and strings hint enumerated values -\end_layout - -\begin_layout Plain Layout - -\end_layout - -\begin_layout Plain Layout - -export(int,"Warrior","Magician","Thief") var character_class # (editor will - set them as 0,1 and 2) -\end_layout - -\begin_layout Plain Layout - -export(String,"Rebecca","Mary","Leah") var character_name -\end_layout - -\begin_layout Plain Layout - -\end_layout - -\begin_layout Plain Layout - -#strings as paths -\end_layout - -\begin_layout Plain Layout - -\end_layout - -\begin_layout Plain Layout - -export(String,FILE) var f # string is a path to a file -\end_layout - -\begin_layout Plain Layout - -export(String,DIR) var f # string is a path to a directory -\end_layout - -\begin_layout Plain Layout - -export(String,FILE,"*.txt") var f # string is a path to a file, custom filter - provided as hint -\end_layout - -\begin_layout Plain Layout - -\end_layout - -\begin_layout Plain Layout - -#integers and floats hint ranges -\end_layout - -\begin_layout Plain Layout - -\end_layout - -\begin_layout Plain Layout - -export(int,20) var i # 0 to 20 allowed -\end_layout - -\begin_layout Plain Layout - -export(int,-10,20) var j # -10 to 20 allowed -\end_layout - -\begin_layout Plain Layout - -export(float,-10,20,0.2) var k # -10 to 20 allowed, with stepping of 0.2 -\end_layout - -\begin_layout Plain Layout - -\end_layout - -\begin_layout Plain Layout - -#color can hint availability of alpha -\end_layout - -\begin_layout Plain Layout - -\end_layout - -\begin_layout Plain Layout - -export(Color,RGB) var col # Color is RGB -\end_layout - -\begin_layout Plain Layout - -export(Color,RGBA) var col # Color is RGBA -\end_layout - -\begin_layout Plain Layout - -\end_layout - -\begin_layout Plain Layout - -\end_layout - -\end_inset - - -\end_layout - -\begin_layout Standard -It must be noted that even if the script is not being run while at the editor, - the exported properties are still editable (see below for -\begin_inset Quotes eld -\end_inset - -tool -\begin_inset Quotes erd -\end_inset - -). -\end_layout - -\begin_layout Subsection -Static Functions -\end_layout - -\begin_layout Standard -A function can be declared static. - When static, it has no access to the instance member variables or -\begin_inset Quotes eld -\end_inset - -self -\begin_inset Quotes erd -\end_inset - -. - This is mainly useful to make libraries of helper functions: -\end_layout - -\begin_layout Standard -\begin_inset listings -inline false -status open - -\begin_layout Plain Layout - -static func sum2(a,b): -\end_layout - -\begin_layout Plain Layout - - return a+b -\end_layout - -\end_inset - - -\end_layout - -\begin_layout Subsection -Asserting -\end_layout - -\begin_layout Standard -It is possible to assert a condition, which will cause a debugger break - if false. - Just use the built-in 'assert' function. -\end_layout - -\begin_layout Standard -\begin_inset listings -inline false -status open - -\begin_layout Plain Layout - -assert(a==2) -\end_layout - -\begin_layout Plain Layout - -# if a is not 2, it will generate a debugger break -\end_layout - -\end_inset - - -\end_layout - -\begin_layout Subsection -Tool Mode -\end_layout - -\begin_layout Standard -Scripts by default don't run inside the editor, and only the exported properties - can be changed. - In some cases it is desired that they do (as long as they don't execute - game code or manually avoid doing so). - For this, the -\begin_inset Quotes eld -\end_inset - -tool -\begin_inset Quotes erd -\end_inset - - keyword exists, and must be placed at the top of the file: -\end_layout - -\begin_layout Standard -\begin_inset listings -inline false -status open - -\begin_layout Plain Layout - -tool -\end_layout - -\begin_layout Plain Layout - -extends Button -\end_layout - -\begin_layout Plain Layout - -\end_layout - -\begin_layout Plain Layout - -func _init(): -\end_layout - -\begin_layout Plain Layout - - print("Hello") -\end_layout - -\end_inset - - -\end_layout - -\begin_layout Subsection -Memory Management -\end_layout - -\begin_layout Standard -If a class inherits from -\emph on -Reference -\emph default -, then instances will be freed when no longer in use. - No garbage collector exists, just simple reference counting. - By default, all classes that don't define inheritance extend -\emph on -Reference -\emph default -. - If this is not desired, then a class must inherit -\emph on -Object -\emph default - manually and must call instance.free(). - To avoid reference cycles that can't be freed, a weakref() function is - provided for creating weak references. - -\end_layout - -\begin_layout Subsection -Function References -\end_layout - -\begin_layout Standard -Functions can't be referenced because they are not treated as class members. - There are two alternatives to this, though. - The -\begin_inset Quotes eld -\end_inset - -call -\begin_inset Quotes erd -\end_inset - - function or the funcref() helper. -\end_layout - -\begin_layout Standard -\begin_inset listings -inline false -status open - -\begin_layout Plain Layout - -instance.call("funcname",args) # call a function by bane -\end_layout - -\begin_layout Plain Layout - -\end_layout - -\begin_layout Plain Layout - -var fr = funcref(instance,"funcname") #create a function ref -\end_layout - -\begin_layout Plain Layout - -fr.exec(args) -\end_layout - -\end_inset - - -\end_layout - -\end_body -\end_document diff --git a/doc/godot_splash.png b/doc/godot_splash.png Binary files differdeleted file mode 100644 index da56fa15cc..0000000000 --- a/doc/godot_splash.png +++ /dev/null diff --git a/doc/header.txt b/doc/header.txt deleted file mode 100644 index 359949cc3b..0000000000 --- a/doc/header.txt +++ /dev/null @@ -1,12 +0,0 @@ -/*************************************************/ -/* $filename */ -/*************************************************/ -/* This file is part of: */ -/* GODOT ENGINE */ -/*************************************************/ -/* Source code within this file is: */ -/* (c) 2007-2010 Juan Linietsky, Ariel Manzur */ -/* All Rights Reserved. */ -/*************************************************/ - - diff --git a/doc/html/@GDScript.html b/doc/html/@GDScript.html deleted file mode 100644 index 5d5d77ffbf..0000000000 --- a/doc/html/@GDScript.html +++ /dev/null @@ -1,93 +0,0 @@ -<html><link href="main.css" rel="stylesheet" type="text/css" /><body><table class="top_table"><tr><td class="top_table"><image src="images/logo.png" /></td><td class="top_table"><a href="index.html">Index</a></td><td class="top_table"><a href="alphabetical.html">Classes</a></td><td class="top_table"><a href="category.html">Categories</a></td><td><a href="inheritance.html">Inheritance</a></td></tr></table><hr /><div class="class"><a name="@GDScript"><h3 class="title class_title">@GDScript</h3></a><div class="description class_description"> - Built-in GDScript functions. - </div><br /><div class="category"><span class="category">Category: </span><a class="category_ref" href="category.html#CATEGORY_Core">Core</a></div><h4>Public Methods:</h4><table class="method_list"><tr class="method"><td align="right"><a class="datatype_existing" href="real.html">real </a></td><td><span class="identifier funcdef"><a href="#@GDScript_sin">sin</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>s</span><span class="symbol"> )</span></td></tr><tr class="method"><td align="right"><a class="datatype_existing" href="real.html">real </a></td><td><span class="identifier funcdef"><a href="#@GDScript_cos">cos</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>s</span><span class="symbol"> )</span></td></tr><tr class="method"><td align="right"><a class="datatype_existing" href="real.html">real </a></td><td><span class="identifier funcdef"><a href="#@GDScript_tan">tan</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>s</span><span class="symbol"> )</span></td></tr><tr class="method"><td align="right"><a class="datatype_existing" href="real.html">real </a></td><td><span class="identifier funcdef"><a href="#@GDScript_sinh">sinh</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>s</span><span class="symbol"> )</span></td></tr><tr class="method"><td align="right"><a class="datatype_existing" href="real.html">real </a></td><td><span class="identifier funcdef"><a href="#@GDScript_cosh">cosh</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>s</span><span class="symbol"> )</span></td></tr><tr class="method"><td align="right"><a class="datatype_existing" href="real.html">real </a></td><td><span class="identifier funcdef"><a href="#@GDScript_tanh">tanh</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>s</span><span class="symbol"> )</span></td></tr><tr class="method"><td align="right"><a class="datatype_existing" href="real.html">real </a></td><td><span class="identifier funcdef"><a href="#@GDScript_asin">asin</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>s</span><span class="symbol"> )</span></td></tr><tr class="method"><td align="right"><a class="datatype_existing" href="real.html">real </a></td><td><span class="identifier funcdef"><a href="#@GDScript_acos">acos</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>s</span><span class="symbol"> )</span></td></tr><tr class="method"><td align="right"><a class="datatype_existing" href="real.html">real </a></td><td><span class="identifier funcdef"><a href="#@GDScript_atan">atan</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>s</span><span class="symbol"> )</span></td></tr><tr class="method"><td align="right"><a class="datatype_existing" href="real.html">real </a></td><td><span class="identifier funcdef"><a href="#@GDScript_atan2">atan2</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>x</span><span>, </span><a class="datatype_existing" href="real.html">real </a><span>y</span><span class="symbol"> )</span></td></tr><tr class="method"><td align="right"><a class="datatype_existing" href="real.html">real </a></td><td><span class="identifier funcdef"><a href="#@GDScript_sqrt">sqrt</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>s</span><span class="symbol"> )</span></td></tr><tr class="method"><td align="right"><a class="datatype_existing" href="real.html">real </a></td><td><span class="identifier funcdef"><a href="#@GDScript_fmod">fmod</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>x</span><span>, </span><a class="datatype_existing" href="real.html">real </a><span>y</span><span class="symbol"> )</span></td></tr><tr class="method"><td align="right"><a class="datatype_existing" href="real.html">real </a></td><td><span class="identifier funcdef"><a href="#@GDScript_fposmod">fposmod</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>x</span><span>, </span><a class="datatype_existing" href="real.html">real </a><span>y</span><span class="symbol"> )</span></td></tr><tr class="method"><td align="right"><a class="datatype_existing" href="real.html">real </a></td><td><span class="identifier funcdef"><a href="#@GDScript_floor">floor</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>s</span><span class="symbol"> )</span></td></tr><tr class="method"><td align="right"><a class="datatype_existing" href="real.html">real </a></td><td><span class="identifier funcdef"><a href="#@GDScript_ceil">ceil</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>s</span><span class="symbol"> )</span></td></tr><tr class="method"><td align="right"><a class="datatype_existing" href="real.html">real </a></td><td><span class="identifier funcdef"><a href="#@GDScript_round">round</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>s</span><span class="symbol"> )</span></td></tr><tr class="method"><td align="right"><a class="datatype_existing" href="real.html">real </a></td><td><span class="identifier funcdef"><a href="#@GDScript_abs">abs</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>s</span><span class="symbol"> )</span></td></tr><tr class="method"><td align="right"><a class="datatype_existing" href="real.html">real </a></td><td><span class="identifier funcdef"><a href="#@GDScript_sign">sign</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>s</span><span class="symbol"> )</span></td></tr><tr class="method"><td align="right"><a class="datatype_existing" href="real.html">real </a></td><td><span class="identifier funcdef"><a href="#@GDScript_pow">pow</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>x</span><span>, </span><a class="datatype_existing" href="real.html">real </a><span>y</span><span class="symbol"> )</span></td></tr><tr class="method"><td align="right"><a class="datatype_existing" href="real.html">real </a></td><td><span class="identifier funcdef"><a href="#@GDScript_log">log</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>s</span><span class="symbol"> )</span></td></tr><tr class="method"><td align="right"><a class="datatype_existing" href="real.html">real </a></td><td><span class="identifier funcdef"><a href="#@GDScript_exp">exp</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>s</span><span class="symbol"> )</span></td></tr><tr class="method"><td align="right"><a class="datatype_existing" href="real.html">real </a></td><td><span class="identifier funcdef"><a href="#@GDScript_isnan">isnan</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>s</span><span class="symbol"> )</span></td></tr><tr class="method"><td align="right"><a class="datatype_existing" href="real.html">real </a></td><td><span class="identifier funcdef"><a href="#@GDScript_isinf">isinf</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>s</span><span class="symbol"> )</span></td></tr><tr class="method"><td align="right"><a class="datatype_existing" href="real.html">real </a></td><td><span class="identifier funcdef"><a href="#@GDScript_ease">ease</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>s</span><span>, </span><a class="datatype_existing" href="real.html">real </a><span>curve</span><span class="symbol"> )</span></td></tr><tr class="method"><td align="right"><a class="datatype_existing" href="real.html">real </a></td><td><span class="identifier funcdef"><a href="#@GDScript_decimals">decimals</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>step</span><span class="symbol"> )</span></td></tr><tr class="method"><td align="right"><a class="datatype_existing" href="real.html">real </a></td><td><span class="identifier funcdef"><a href="#@GDScript_stepify">stepify</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>s</span><span>, </span><a class="datatype_existing" href="real.html">real </a><span>step</span><span class="symbol"> )</span></td></tr><tr class="method"><td align="right"><a class="datatype_existing" href="int.html">int </a></td><td><span class="identifier funcdef"><a href="#@GDScript_rand">rand</a></span><span class="symbol"> (</span><span class="symbol">)</span></td></tr><tr class="method"><td align="right"><a class="datatype_existing" href="real.html">real </a></td><td><span class="identifier funcdef"><a href="#@GDScript_randf">randf</a></span><span class="symbol"> (</span><span class="symbol">)</span></td></tr><tr class="method"><td align="right"><a class="datatype_existing" href="real.html">real </a></td><td><span class="identifier funcdef"><a href="#@GDScript_rand_range">rand_range</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>from</span><span>, </span><a class="datatype_existing" href="real.html">real </a><span>to</span><span class="symbol"> )</span></td></tr><tr class="method"><td align="right"><a class="datatype_existing" href="Array.html">Array </a></td><td><span class="identifier funcdef"><a href="#@GDScript_rand_seed">rand_seed</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>seed</span><span class="symbol"> )</span></td></tr><tr class="method"><td align="right"><a class="datatype_existing" href="real.html">real </a></td><td><span class="identifier funcdef"><a href="#@GDScript_deg2rad">deg2rad</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>deg</span><span class="symbol"> )</span></td></tr><tr class="method"><td align="right"><a class="datatype_existing" href="real.html">real </a></td><td><span class="identifier funcdef"><a href="#@GDScript_rad2deg">rad2deg</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>rad</span><span class="symbol"> )</span></td></tr><tr class="method"><td align="right"><a class="datatype_existing" href="real.html">real </a></td><td><span class="identifier funcdef"><a href="#@GDScript_linear2db">linear2db</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>nrg</span><span class="symbol"> )</span></td></tr><tr class="method"><td align="right"><a class="datatype_existing" href="real.html">real </a></td><td><span class="identifier funcdef"><a href="#@GDScript_db2linear">db2linear</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>db</span><span class="symbol"> )</span></td></tr><tr class="method"><td align="right"><a class="datatype_existing" href="real.html">real </a></td><td><span class="identifier funcdef"><a href="#@GDScript_max">max</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>a</span><span>, </span><a class="datatype_existing" href="real.html">real </a><span>b</span><span class="symbol"> )</span></td></tr><tr class="method"><td align="right"><a class="datatype_existing" href="real.html">real </a></td><td><span class="identifier funcdef"><a href="#@GDScript_min">min</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>a</span><span>, </span><a class="datatype_existing" href="real.html">real </a><span>b</span><span class="symbol"> )</span></td></tr><tr class="method"><td align="right"><a class="datatype_existing" href="real.html">real </a></td><td><span class="identifier funcdef"><a href="#@GDScript_clamp">clamp</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>val</span><span>, </span><a class="datatype_existing" href="real.html">real </a><span>min</span><span>, </span><a class="datatype_existing" href="real.html">real </a><span>max</span><span class="symbol"> )</span></td></tr><tr class="method"><td align="right"><a class="datatype_existing" href="int.html">int </a></td><td><span class="identifier funcdef"><a href="#@GDScript_nearest_po2">nearest_po2</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="int.html">int </a><span>val</span><span class="symbol"> )</span></td></tr><tr class="method"><td align="right"><a class="datatype_existing" href="Object.html">Object </a></td><td><span class="identifier funcdef"><a href="#@GDScript_weakref">weakref</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="Object.html">Object </a><span>obj</span><span class="symbol"> )</span></td></tr><tr class="method"><td align="right"><a class="datatype_existing" href="Object.html">Object </a></td><td><span class="identifier funcdef"><a href="#@GDScript_convert">convert</a></span><span class="symbol"> (</span><span> </span><span class="datatype">var </span><span>what</span><span>, </span><a class="datatype_existing" href="int.html">int </a><span>type</span><span class="symbol"> )</span></td></tr><tr class="method"><td align="right"><a class="datatype_existing" href="String.html">String </a></td><td><span class="identifier funcdef"><a href="#@GDScript_str">str</a></span><span class="symbol"> (</span><span> </span><span class="datatype">var </span><span>what</span><span>, </span><span class="datatype">var </span><span>...</span><span class="symbol"> )</span></td></tr><tr class="method"><td align="right"><a class="datatype_existing" href="Nil.html">Nil </a></td><td><span class="identifier funcdef"><a href="#@GDScript_print">print</a></span><span class="symbol"> (</span><span> </span><span class="datatype">var </span><span>what</span><span>, </span><span class="datatype">var </span><span>...</span><span class="symbol"> )</span></td></tr><tr class="method"><td align="right"><a class="datatype_existing" href="Nil.html">Nil </a></td><td><span class="identifier funcdef"><a href="#@GDScript_printerr">printerr</a></span><span class="symbol"> (</span><span> </span><span class="datatype">var </span><span>what</span><span>, </span><span class="datatype">var </span><span>...</span><span class="symbol"> )</span></td></tr><tr class="method"><td align="right"><a class="datatype_existing" href="Nil.html">Nil </a></td><td><span class="identifier funcdef"><a href="#@GDScript_printraw">printraw</a></span><span class="symbol"> (</span><span> </span><span class="datatype">var </span><span>what</span><span>, </span><span class="datatype">var </span><span>...</span><span class="symbol"> )</span></td></tr><tr class="method"><td align="right"><a class="datatype_existing" href="Array.html">Array </a></td><td><span class="identifier funcdef"><a href="#@GDScript_range">range</a></span><span class="symbol"> (</span><span> </span><span class="datatype">var </span><span>...</span><span class="symbol"> )</span></td></tr></table><h4>Description:</h4><div class="description"> - This contains the list of built-in gdscript functions. Mostly math functions and other utilities. Everything else is expanded by objects. - </div><h4>Method Documentation:</h4><div class="method_doc"><div class="method"><a class="datatype_existing" href="real.html">real </a><span class="funcdecl"><a name="@GDScript_sin">@GDScript::sin</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>s</span><span class="symbol"> )</span></div><div class="description"> - Standard sine function. - </div></div><div class="method_doc"><div class="method"><a class="datatype_existing" href="real.html">real </a><span class="funcdecl"><a name="@GDScript_cos">@GDScript::cos</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>s</span><span class="symbol"> )</span></div><div class="description"> - Standard cosine function. - </div></div><div class="method_doc"><div class="method"><a class="datatype_existing" href="real.html">real </a><span class="funcdecl"><a name="@GDScript_tan">@GDScript::tan</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>s</span><span class="symbol"> )</span></div><div class="description"> - Standard tangent function. - </div></div><div class="method_doc"><div class="method"><a class="datatype_existing" href="real.html">real </a><span class="funcdecl"><a name="@GDScript_sinh">@GDScript::sinh</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>s</span><span class="symbol"> )</span></div><div class="description"> - Hyperbolic sine. - </div></div><div class="method_doc"><div class="method"><a class="datatype_existing" href="real.html">real </a><span class="funcdecl"><a name="@GDScript_tanh">@GDScript::tanh</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>s</span><span class="symbol"> )</span></div><div class="description"> - Hyperbolic tangent. - </div></div><div class="method_doc"><div class="method"><a class="datatype_existing" href="real.html">real </a><span class="funcdecl"><a name="@GDScript_asin">@GDScript::asin</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>s</span><span class="symbol"> )</span></div><div class="description"> - Arc-sine. - </div></div><div class="method_doc"><div class="method"><a class="datatype_existing" href="real.html">real </a><span class="funcdecl"><a name="@GDScript_acos">@GDScript::acos</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>s</span><span class="symbol"> )</span></div><div class="description"> - Arc-cosine. - </div></div><div class="method_doc"><div class="method"><a class="datatype_existing" href="real.html">real </a><span class="funcdecl"><a name="@GDScript_atan">@GDScript::atan</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>s</span><span class="symbol"> )</span></div><div class="description"> - Arc-tangent. - </div></div><div class="method_doc"><div class="method"><a class="datatype_existing" href="real.html">real </a><span class="funcdecl"><a name="@GDScript_atan2">@GDScript::atan2</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>x</span><span>, </span><a class="datatype_existing" href="real.html">real </a><span>y</span><span class="symbol"> )</span></div><div class="description"> - Arc-tangent that takes a 2D vector as argument, retuns the full -pi to +pi range. - </div></div><div class="method_doc"><div class="method"><a class="datatype_existing" href="real.html">real </a><span class="funcdecl"><a name="@GDScript_sqrt">@GDScript::sqrt</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>s</span><span class="symbol"> )</span></div><div class="description"> - Square root. - </div></div><div class="method_doc"><div class="method"><a class="datatype_existing" href="real.html">real </a><span class="funcdecl"><a name="@GDScript_fmod">@GDScript::fmod</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>x</span><span>, </span><a class="datatype_existing" href="real.html">real </a><span>y</span><span class="symbol"> )</span></div><div class="description"> - Module (remainder of x/y). - </div></div><div class="method_doc"><div class="method"><a class="datatype_existing" href="real.html">real </a><span class="funcdecl"><a name="@GDScript_fposmod">@GDScript::fposmod</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>x</span><span>, </span><a class="datatype_existing" href="real.html">real </a><span>y</span><span class="symbol"> )</span></div><div class="description"> - Module (remainder of x/y) that wraps equally in positive and negative. - </div></div><div class="method_doc"><div class="method"><a class="datatype_existing" href="real.html">real </a><span class="funcdecl"><a name="@GDScript_floor">@GDScript::floor</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>s</span><span class="symbol"> )</span></div><div class="description"> - Floor (rounds down to nearest integer). - </div></div><div class="method_doc"><div class="method"><a class="datatype_existing" href="real.html">real </a><span class="funcdecl"><a name="@GDScript_ceil">@GDScript::ceil</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>s</span><span class="symbol"> )</span></div><div class="description"> - Ceiling (rounds up to nearest integer). - </div></div><div class="method_doc"><div class="method"><a class="datatype_existing" href="real.html">real </a><span class="funcdecl"><a name="@GDScript_round">@GDScript::round</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>s</span><span class="symbol"> )</span></div><div class="description"> - Round to nearest integer. - </div></div><div class="method_doc"><div class="method"><a class="datatype_existing" href="real.html">real </a><span class="funcdecl"><a name="@GDScript_abs">@GDScript::abs</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>s</span><span class="symbol"> )</span></div><div class="description"> - Remove sign (works for integer and float). - </div></div><div class="method_doc"><div class="method"><a class="datatype_existing" href="real.html">real </a><span class="funcdecl"><a name="@GDScript_sign">@GDScript::sign</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>s</span><span class="symbol"> )</span></div><div class="description"> - Return sign (-1 or +1). - </div></div><div class="method_doc"><div class="method"><a class="datatype_existing" href="real.html">real </a><span class="funcdecl"><a name="@GDScript_pow">@GDScript::pow</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>x</span><span>, </span><a class="datatype_existing" href="real.html">real </a><span>y</span><span class="symbol"> )</span></div><div class="description"> - Power function, x elevate to y. - </div></div><div class="method_doc"><div class="method"><a class="datatype_existing" href="real.html">real </a><span class="funcdecl"><a name="@GDScript_log">@GDScript::log</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>s</span><span class="symbol"> )</span></div><div class="description"> - Natural logarithm. - </div></div><div class="method_doc"><div class="method"><a class="datatype_existing" href="real.html">real </a><span class="funcdecl"><a name="@GDScript_exp">@GDScript::exp</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>s</span><span class="symbol"> )</span></div><div class="description"> - Exponential logarithm. - </div></div><div class="method_doc"><div class="method"><a class="datatype_existing" href="real.html">real </a><span class="funcdecl"><a name="@GDScript_isnan">@GDScript::isnan</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>s</span><span class="symbol"> )</span></div><div class="description"> - Return true if the float is not a number. - </div></div><div class="method_doc"><div class="method"><a class="datatype_existing" href="real.html">real </a><span class="funcdecl"><a name="@GDScript_isinf">@GDScript::isinf</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>s</span><span class="symbol"> )</span></div><div class="description"> - Return true if the float is infinite. - </div></div><div class="method_doc"><div class="method"><a class="datatype_existing" href="real.html">real </a><span class="funcdecl"><a name="@GDScript_ease">@GDScript::ease</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>s</span><span>, </span><a class="datatype_existing" href="real.html">real </a><span>curve</span><span class="symbol"> )</span></div><div class="description"> - Easing function, based on exponent. 0 is constant, 1 is linear, 0 to 1 is ease-in, 1+ is ease out. Negative values are in-out/out in. - </div></div><div class="method_doc"><div class="method"><a class="datatype_existing" href="real.html">real </a><span class="funcdecl"><a name="@GDScript_decimals">@GDScript::decimals</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>step</span><span class="symbol"> )</span></div><div class="description"> - Return the amount of decimals in the floating point value. - </div></div><div class="method_doc"><div class="method"><a class="datatype_existing" href="real.html">real </a><span class="funcdecl"><a name="@GDScript_stepify">@GDScript::stepify</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>s</span><span>, </span><a class="datatype_existing" href="real.html">real </a><span>step</span><span class="symbol"> )</span></div><div class="description"> - Snap float value to a given step. - </div></div><div class="method_doc"><div class="method"><a class="datatype_existing" href="int.html">int </a><span class="funcdecl"><a name="@GDScript_rand">@GDScript::rand</a></span><span class="symbol"> (</span><span class="symbol">)</span></div><div class="description"> - Random value (integer). - </div></div><div class="method_doc"><div class="method"><a class="datatype_existing" href="real.html">real </a><span class="funcdecl"><a name="@GDScript_randf">@GDScript::randf</a></span><span class="symbol"> (</span><span class="symbol">)</span></div><div class="description"> - Random value (0 to 1 float). - </div></div><div class="method_doc"><div class="method"><a class="datatype_existing" href="real.html">real </a><span class="funcdecl"><a name="@GDScript_rand_range">@GDScript::rand_range</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>from</span><span>, </span><a class="datatype_existing" href="real.html">real </a><span>to</span><span class="symbol"> )</span></div><div class="description"> - Random range. - </div></div><div class="method_doc"><div class="method"><a class="datatype_existing" href="Array.html">Array </a><span class="funcdecl"><a name="@GDScript_rand_seed">@GDScript::rand_seed</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>seed</span><span class="symbol"> )</span></div><div class="description"> - random from seed, pass a seed and an array with both number and new seed is returned. - </div></div><div class="method_doc"><div class="method"><a class="datatype_existing" href="real.html">real </a><span class="funcdecl"><a name="@GDScript_deg2rad">@GDScript::deg2rad</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>deg</span><span class="symbol"> )</span></div><div class="description"> - Convert from degrees to radians. - </div></div><div class="method_doc"><div class="method"><a class="datatype_existing" href="real.html">real </a><span class="funcdecl"><a name="@GDScript_rad2deg">@GDScript::rad2deg</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>rad</span><span class="symbol"> )</span></div><div class="description"> - Convert from radias to degrees. - </div></div><div class="method_doc"><div class="method"><a class="datatype_existing" href="real.html">real </a><span class="funcdecl"><a name="@GDScript_linear2db">@GDScript::linear2db</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>nrg</span><span class="symbol"> )</span></div><div class="description"> - Convert from linear energy to decibels (audio). - </div></div><div class="method_doc"><div class="method"><a class="datatype_existing" href="real.html">real </a><span class="funcdecl"><a name="@GDScript_db2linear">@GDScript::db2linear</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>db</span><span class="symbol"> )</span></div><div class="description"> - Convert from decibels to linear energy (audio). - </div></div><div class="method_doc"><div class="method"><a class="datatype_existing" href="real.html">real </a><span class="funcdecl"><a name="@GDScript_max">@GDScript::max</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>a</span><span>, </span><a class="datatype_existing" href="real.html">real </a><span>b</span><span class="symbol"> )</span></div><div class="description"> - Return the maximum of two values. - </div></div><div class="method_doc"><div class="method"><a class="datatype_existing" href="real.html">real </a><span class="funcdecl"><a name="@GDScript_min">@GDScript::min</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>a</span><span>, </span><a class="datatype_existing" href="real.html">real </a><span>b</span><span class="symbol"> )</span></div><div class="description"> - Return the minimum of two values. - </div></div><div class="method_doc"><div class="method"><a class="datatype_existing" href="real.html">real </a><span class="funcdecl"><a name="@GDScript_clamp">@GDScript::clamp</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="real.html">real </a><span>val</span><span>, </span><a class="datatype_existing" href="real.html">real </a><span>min</span><span>, </span><a class="datatype_existing" href="real.html">real </a><span>max</span><span class="symbol"> )</span></div><div class="description"> - Clamp both values to a range. - </div></div><div class="method_doc"><div class="method"><a class="datatype_existing" href="int.html">int </a><span class="funcdecl"><a name="@GDScript_nearest_po2">@GDScript::nearest_po2</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="int.html">int </a><span>val</span><span class="symbol"> )</span></div><div class="description"> - Return the nearest larger power of 2 for an integer. - </div></div><div class="method_doc"><div class="method"><a class="datatype_existing" href="Object.html">Object </a><span class="funcdecl"><a name="@GDScript_weakref">@GDScript::weakref</a></span><span class="symbol"> (</span><span> </span><a class="datatype_existing" href="Object.html">Object </a><span>obj</span><span class="symbol"> )</span></div><div class="description"> - Return a weak reference to an object. - </div></div><div class="method_doc"><div class="method"><a class="datatype_existing" href="Object.html">Object </a><span class="funcdecl"><a name="@GDScript_convert">@GDScript::convert</a></span><span class="symbol"> (</span><span> </span><span class="datatype">var </span><span>what</span><span>, </span><a class="datatype_existing" href="int.html">int </a><span>type</span><span class="symbol"> )</span></div><div class="description"> - Convert from a type to another in the best way possible. The "type" parameter uses the enum TYPE_* in Global Scope. - </div></div><div class="method_doc"><div class="method"><a class="datatype_existing" href="String.html">String </a><span class="funcdecl"><a name="@GDScript_str">@GDScript::str</a></span><span class="symbol"> (</span><span> </span><span class="datatype">var </span><span>what</span><span>, </span><span class="datatype">var </span><span>...</span><span class="symbol"> )</span></div><div class="description"> - Convert one or more arguments to strings in the best way possible. - </div></div><div class="method_doc"><div class="method"><a class="datatype_existing" href="Nil.html">Nil </a><span class="funcdecl"><a name="@GDScript_print">@GDScript::print</a></span><span class="symbol"> (</span><span> </span><span class="datatype">var </span><span>what</span><span>, </span><span class="datatype">var </span><span>...</span><span class="symbol"> )</span></div><div class="description"> - Print one or more arguments to strings in the best way possible to a console line. - </div></div><div class="method_doc"><div class="method"><a class="datatype_existing" href="Nil.html">Nil </a><span class="funcdecl"><a name="@GDScript_printerr">@GDScript::printerr</a></span><span class="symbol"> (</span><span> </span><span class="datatype">var </span><span>what</span><span>, </span><span class="datatype">var </span><span>...</span><span class="symbol"> )</span></div><div class="description"> - Print one or more arguments to strings in the best way possible to standard error line. - </div></div><div class="method_doc"><div class="method"><a class="datatype_existing" href="Nil.html">Nil </a><span class="funcdecl"><a name="@GDScript_printraw">@GDScript::printraw</a></span><span class="symbol"> (</span><span> </span><span class="datatype">var </span><span>what</span><span>, </span><span class="datatype">var </span><span>...</span><span class="symbol"> )</span></div><div class="description"> - Print one or more arguments to strings in the best way possible to console. No newline is added at the end. - </div></div><div class="method_doc"><div class="method"><a class="datatype_existing" href="Array.html">Array </a><span class="funcdecl"><a name="@GDScript_range">@GDScript::range</a></span><span class="symbol"> (</span><span> </span><span class="datatype">var </span><span>...</span><span class="symbol"> )</span></div><div class="description"> - Return an array with the given range. Range can be 1 argument N (0 to N-1), two arguments (initial, final-1) or three arguments (initial,final-1,increment). - </div></div></div><hr /><span>Copyright 2008-2010 Codenix SRL</span></body></html>
\ No newline at end of file diff --git a/doc/html/@Global Scope.html b/doc/html/@Global Scope.html deleted file mode 100644 index 3324383c3d..0000000000 --- a/doc/html/@Global Scope.html +++ /dev/null @@ -1,459 +0,0 @@ -<html><link href="main.css" rel="stylesheet" type="text/css" /><body><table class="top_table"><tr><td class="top_table"><image src="images/logo.png" /></td><td class="top_table"><a href="index.html">Index</a></td><td class="top_table"><a href="alphabetical.html">Classes</a></td><td class="top_table"><a href="category.html">Categories</a></td><td><a href="inheritance.html">Inheritance</a></td></tr></table><hr /><div class="class"><a name="@Global Scope"><h3 class="title class_title">@Global Scope</h3></a><div class="description class_description"> - Global scope constants and variables. - </div><br /><div class="category"><span class="category">Category: </span><a class="category_ref" href="category.html#CATEGORY_Core">Core</a></div><h4>Public Variables:</h4><div class="member_list"><li><div class="member"><a class="datatype_existing" href="Globals.html">Globals </a><span class="identifier member_name"> Globals </span><span class="member_description"> - </span></div></li><li><div class="member"><a class="datatype_existing" href="IP.html">IP </a><span class="identifier member_name"> IP </span><span class="member_description"> - </span></div></li><li><div class="member"><a class="datatype_existing" href="Geometry.html">Geometry </a><span class="identifier member_name"> Geometry </span><span class="member_description"> - </span></div></li><li><div class="member"><a class="datatype_existing" href="ResourceLoader.html">ResourceLoader </a><span class="identifier member_name"> ResourceLoader </span><span class="member_description"> - </span></div></li><li><div class="member"><a class="datatype_existing" href="ResourceSaver.html">ResourceSaver </a><span class="identifier member_name"> ResourceSaver </span><span class="member_description"> - </span></div></li><li><div class="member"><a class="datatype_existing" href="PathRemap.html">PathRemap </a><span class="identifier member_name"> PathRemap </span><span class="member_description"> - </span></div></li><li><div class="member"><a class="datatype_existing" href="OS.html">OS </a><span class="identifier member_name"> OS </span><span class="member_description"> - </span></div></li><li><div class="member"><a class="datatype_existing" href="TranslationServer.html">TranslationServer </a><span class="identifier member_name"> TranslationServer </span><span class="member_description"> - </span></div></li><li><div class="member"><a class="datatype_existing" href="TranslationServer.html">TranslationServer </a><span class="identifier member_name"> TS </span><span class="member_description"> - </span></div></li><li><div class="member"><a class="datatype_existing" href="SceneIO.html">SceneIO </a><span class="identifier member_name"> SceneIO </span><span class="member_description"> - </span></div></li><li><div class="member"><a class="datatype_existing" href="VisualServer.html">VisualServer </a><span class="identifier member_name"> VisualServer </span><span class="member_description"> - </span></div></li><li><div class="member"><a class="datatype_existing" href="VisualServer.html">VisualServer </a><span class="identifier member_name"> VS </span><span class="member_description"> - </span></div></li><li><div class="member"><a class="datatype_existing" href="AudioServer.html">AudioServer </a><span class="identifier member_name"> AudioServer </span><span class="member_description"> - </span></div></li><li><div class="member"><a class="datatype_existing" href="AudioServer.html">AudioServer </a><span class="identifier member_name"> AS </span><span class="member_description"> - </span></div></li><li><div class="member"><a class="datatype_existing" href="PhysicsServer.html">PhysicsServer </a><span class="identifier member_name"> PhysicsServer </span><span class="member_description"> - </span></div></li><li><div class="member"><a class="datatype_existing" href="PhysicsServer.html">PhysicsServer </a><span class="identifier member_name"> PS </span><span class="member_description"> - </span></div></li><li><div class="member"><a class="datatype_existing" href="Physics2DServer.html">Physics2DServer </a><span class="identifier member_name"> Physics2DServer </span><span class="member_description"> - </span></div></li><li><div class="member"><a class="datatype_existing" href="Physics2DServer.html">Physics2DServer </a><span class="identifier member_name"> PS2D </span><span class="member_description"> - </span></div></li><li><div class="member"><a class="datatype_existing" href="SpatialSound2DServer.html">SpatialSound2DServer </a><span class="identifier member_name"> SpatialSoundServer </span><span class="member_description"> - </span></div></li><li><div class="member"><a class="datatype_existing" href="SpatialSound2DServer.html">SpatialSound2DServer </a><span class="identifier member_name"> SS </span><span class="member_description"> - </span></div></li><li><div class="member"><a class="datatype_existing" href="SpatialSound2DServer.html">SpatialSound2DServer </a><span class="identifier member_name"> SpatialSound2DServer </span><span class="member_description"> - </span></div></li><li><div class="member"><a class="datatype_existing" href="SpatialSound2DServer.html">SpatialSound2DServer </a><span class="identifier member_name"> SS2D </span><span class="member_description"> - </span></div></li></div><h4>Constants:</h4><div class="constant_list"><li><div class="constant"><span class="identifier constant_name">MARGIN_LEFT </span><span class="symbol">= </span><span class="constant_value">0 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">MARGIN_TOP </span><span class="symbol">= </span><span class="constant_value">1 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">MARGIN_RIGHT </span><span class="symbol">= </span><span class="constant_value">2 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">MARGIN_BOTTOM </span><span class="symbol">= </span><span class="constant_value">3 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">VERTICAL </span><span class="symbol">= </span><span class="constant_value">1 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">HORIZONTAL </span><span class="symbol">= </span><span class="constant_value">0 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">HALIGN_LEFT </span><span class="symbol">= </span><span class="constant_value">0 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">HALIGN_CENTER </span><span class="symbol">= </span><span class="constant_value">1 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">HALIGN_RIGHT </span><span class="symbol">= </span><span class="constant_value">2 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">VALIGN_TOP </span><span class="symbol">= </span><span class="constant_value">0 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">VALIGN_CENTER </span><span class="symbol">= </span><span class="constant_value">1 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">VALIGN_BOTTOM </span><span class="symbol">= </span><span class="constant_value">2 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">SPKEY </span><span class="symbol">= </span><span class="constant_value">16777216 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_ESCAPE </span><span class="symbol">= </span><span class="constant_value">16777217 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_TAB </span><span class="symbol">= </span><span class="constant_value">16777218 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_BACKTAB </span><span class="symbol">= </span><span class="constant_value">16777219 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_BACKSPACE </span><span class="symbol">= </span><span class="constant_value">16777220 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_RETURN </span><span class="symbol">= </span><span class="constant_value">16777221 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_ENTER </span><span class="symbol">= </span><span class="constant_value">16777222 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_INSERT </span><span class="symbol">= </span><span class="constant_value">16777223 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_DELETE </span><span class="symbol">= </span><span class="constant_value">16777224 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_PAUSE </span><span class="symbol">= </span><span class="constant_value">16777225 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_PRINT </span><span class="symbol">= </span><span class="constant_value">16777226 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_SYSREQ </span><span class="symbol">= </span><span class="constant_value">16777227 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_CLEAR </span><span class="symbol">= </span><span class="constant_value">16777228 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_HOME </span><span class="symbol">= </span><span class="constant_value">16777229 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_END </span><span class="symbol">= </span><span class="constant_value">16777230 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_LEFT </span><span class="symbol">= </span><span class="constant_value">16777231 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_UP </span><span class="symbol">= </span><span class="constant_value">16777232 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_RIGHT </span><span class="symbol">= </span><span class="constant_value">16777233 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_DOWN </span><span class="symbol">= </span><span class="constant_value">16777234 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_PAGEUP </span><span class="symbol">= </span><span class="constant_value">16777235 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_PAGEDOWN </span><span class="symbol">= </span><span class="constant_value">16777236 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_SHIFT </span><span class="symbol">= </span><span class="constant_value">16777237 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_CONTROL </span><span class="symbol">= </span><span class="constant_value">16777238 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_META </span><span class="symbol">= </span><span class="constant_value">16777239 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_ALT </span><span class="symbol">= </span><span class="constant_value">16777240 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_CAPSLOCK </span><span class="symbol">= </span><span class="constant_value">16777241 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_NUMLOCK </span><span class="symbol">= </span><span class="constant_value">16777242 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_SCROLLLOCK </span><span class="symbol">= </span><span class="constant_value">16777243 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_F1 </span><span class="symbol">= </span><span class="constant_value">16777244 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_F2 </span><span class="symbol">= </span><span class="constant_value">16777245 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_F3 </span><span class="symbol">= </span><span class="constant_value">16777246 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_F4 </span><span class="symbol">= </span><span class="constant_value">16777247 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_F5 </span><span class="symbol">= </span><span class="constant_value">16777248 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_F6 </span><span class="symbol">= </span><span class="constant_value">16777249 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_F7 </span><span class="symbol">= </span><span class="constant_value">16777250 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_F8 </span><span class="symbol">= </span><span class="constant_value">16777251 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_F9 </span><span class="symbol">= </span><span class="constant_value">16777252 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_F10 </span><span class="symbol">= </span><span class="constant_value">16777253 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_F11 </span><span class="symbol">= </span><span class="constant_value">16777254 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_F12 </span><span class="symbol">= </span><span class="constant_value">16777255 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_F13 </span><span class="symbol">= </span><span class="constant_value">16777256 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_F14 </span><span class="symbol">= </span><span class="constant_value">16777257 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_F15 </span><span class="symbol">= </span><span class="constant_value">16777258 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_F16 </span><span class="symbol">= </span><span class="constant_value">16777259 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_KP_ENTER </span><span class="symbol">= </span><span class="constant_value">16777344 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_KP_MULTIPLY </span><span class="symbol">= </span><span class="constant_value">16777345 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_KP_DIVIDE </span><span class="symbol">= </span><span class="constant_value">16777346 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_KP_SUBSTRACT </span><span class="symbol">= </span><span class="constant_value">16777347 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_KP_PERIOD </span><span class="symbol">= </span><span class="constant_value">16777348 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_KP_ADD </span><span class="symbol">= </span><span class="constant_value">16777349 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_KP_0 </span><span class="symbol">= </span><span class="constant_value">16777350 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_KP_1 </span><span class="symbol">= </span><span class="constant_value">16777351 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_KP_2 </span><span class="symbol">= </span><span class="constant_value">16777352 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_KP_3 </span><span class="symbol">= </span><span class="constant_value">16777353 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_KP_4 </span><span class="symbol">= </span><span class="constant_value">16777354 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_KP_5 </span><span class="symbol">= </span><span class="constant_value">16777355 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_KP_6 </span><span class="symbol">= </span><span class="constant_value">16777356 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_KP_7 </span><span class="symbol">= </span><span class="constant_value">16777357 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_KP_8 </span><span class="symbol">= </span><span class="constant_value">16777358 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_KP_9 </span><span class="symbol">= </span><span class="constant_value">16777359 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_SUPER_L </span><span class="symbol">= </span><span class="constant_value">16777260 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_SUPER_R </span><span class="symbol">= </span><span class="constant_value">16777261 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_MENU </span><span class="symbol">= </span><span class="constant_value">16777262 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_HYPER_L </span><span class="symbol">= </span><span class="constant_value">16777263 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_HYPER_R </span><span class="symbol">= </span><span class="constant_value">16777264 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_HELP </span><span class="symbol">= </span><span class="constant_value">16777265 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_DIRECTION_L </span><span class="symbol">= </span><span class="constant_value">16777266 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_DIRECTION_R </span><span class="symbol">= </span><span class="constant_value">16777267 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_BACK </span><span class="symbol">= </span><span class="constant_value">16777280 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_FORWARD </span><span class="symbol">= </span><span class="constant_value">16777281 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_STOP </span><span class="symbol">= </span><span class="constant_value">16777282 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_REFRESH </span><span class="symbol">= </span><span class="constant_value">16777283 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_VOLUMEDOWN </span><span class="symbol">= </span><span class="constant_value">16777284 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_VOLUMEMUTE </span><span class="symbol">= </span><span class="constant_value">16777285 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_VOLUMEUP </span><span class="symbol">= </span><span class="constant_value">16777286 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_BASSBOOST </span><span class="symbol">= </span><span class="constant_value">16777287 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_BASSUP </span><span class="symbol">= </span><span class="constant_value">16777288 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_BASSDOWN </span><span class="symbol">= </span><span class="constant_value">16777289 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_TREBLEUP </span><span class="symbol">= </span><span class="constant_value">16777290 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_TREBLEDOWN </span><span class="symbol">= </span><span class="constant_value">16777291 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_MEDIAPLAY </span><span class="symbol">= </span><span class="constant_value">16777292 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_MEDIASTOP </span><span class="symbol">= </span><span class="constant_value">16777293 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_MEDIAPREVIOUS </span><span class="symbol">= </span><span class="constant_value">16777294 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_MEDIANEXT </span><span class="symbol">= </span><span class="constant_value">16777295 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_MEDIARECORD </span><span class="symbol">= </span><span class="constant_value">16777296 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_HOMEPAGE </span><span class="symbol">= </span><span class="constant_value">16777297 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_FAVORITES </span><span class="symbol">= </span><span class="constant_value">16777298 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_SEARCH </span><span class="symbol">= </span><span class="constant_value">16777299 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_STANDBY </span><span class="symbol">= </span><span class="constant_value">16777300 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_OPENURL </span><span class="symbol">= </span><span class="constant_value">16777301 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_LAUNCHMAIL </span><span class="symbol">= </span><span class="constant_value">16777302 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_LAUNCHMEDIA </span><span class="symbol">= </span><span class="constant_value">16777303 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_LAUNCH0 </span><span class="symbol">= </span><span class="constant_value">16777304 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_LAUNCH1 </span><span class="symbol">= </span><span class="constant_value">16777305 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_LAUNCH2 </span><span class="symbol">= </span><span class="constant_value">16777306 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_LAUNCH3 </span><span class="symbol">= </span><span class="constant_value">16777307 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_LAUNCH4 </span><span class="symbol">= </span><span class="constant_value">16777308 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_LAUNCH5 </span><span class="symbol">= </span><span class="constant_value">16777309 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_LAUNCH6 </span><span class="symbol">= </span><span class="constant_value">16777310 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_LAUNCH7 </span><span class="symbol">= </span><span class="constant_value">16777311 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_LAUNCH8 </span><span class="symbol">= </span><span class="constant_value">16777312 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_LAUNCH9 </span><span class="symbol">= </span><span class="constant_value">16777313 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_LAUNCHA </span><span class="symbol">= </span><span class="constant_value">16777314 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_LAUNCHB </span><span class="symbol">= </span><span class="constant_value">16777315 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_LAUNCHC </span><span class="symbol">= </span><span class="constant_value">16777316 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_LAUNCHD </span><span class="symbol">= </span><span class="constant_value">16777317 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_LAUNCHE </span><span class="symbol">= </span><span class="constant_value">16777318 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_LAUNCHF </span><span class="symbol">= </span><span class="constant_value">16777319 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_UNKNOWN </span><span class="symbol">= </span><span class="constant_value">33554431 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_SPACE </span><span class="symbol">= </span><span class="constant_value">32 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_EXCLAM </span><span class="symbol">= </span><span class="constant_value">33 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_QUOTEDBL </span><span class="symbol">= </span><span class="constant_value">34 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_NUMBERSIGN </span><span class="symbol">= </span><span class="constant_value">35 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_DOLLAR </span><span class="symbol">= </span><span class="constant_value">36 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_PERCENT </span><span class="symbol">= </span><span class="constant_value">37 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_AMPERSAND </span><span class="symbol">= </span><span class="constant_value">38 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_APOSTROPHE </span><span class="symbol">= </span><span class="constant_value">39 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_PARENLEFT </span><span class="symbol">= </span><span class="constant_value">40 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_PARENRIGHT </span><span class="symbol">= </span><span class="constant_value">41 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_ASTERISK </span><span class="symbol">= </span><span class="constant_value">42 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_PLUS </span><span class="symbol">= </span><span class="constant_value">43 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_COMMA </span><span class="symbol">= </span><span class="constant_value">44 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_MINUS </span><span class="symbol">= </span><span class="constant_value">45 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_PERIOD </span><span class="symbol">= </span><span class="constant_value">46 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_SLASH </span><span class="symbol">= </span><span class="constant_value">47 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_0 </span><span class="symbol">= </span><span class="constant_value">48 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_1 </span><span class="symbol">= </span><span class="constant_value">49 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_2 </span><span class="symbol">= </span><span class="constant_value">50 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_3 </span><span class="symbol">= </span><span class="constant_value">51 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_4 </span><span class="symbol">= </span><span class="constant_value">52 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_5 </span><span class="symbol">= </span><span class="constant_value">53 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_6 </span><span class="symbol">= </span><span class="constant_value">54 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_7 </span><span class="symbol">= </span><span class="constant_value">55 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_8 </span><span class="symbol">= </span><span class="constant_value">56 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_9 </span><span class="symbol">= </span><span class="constant_value">57 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_COLON </span><span class="symbol">= </span><span class="constant_value">58 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_SEMICOLON </span><span class="symbol">= </span><span class="constant_value">59 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_LESS </span><span class="symbol">= </span><span class="constant_value">60 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_EQUAL </span><span class="symbol">= </span><span class="constant_value">61 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_GREATER </span><span class="symbol">= </span><span class="constant_value">62 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_QUESTION </span><span class="symbol">= </span><span class="constant_value">63 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_AT </span><span class="symbol">= </span><span class="constant_value">64 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_A </span><span class="symbol">= </span><span class="constant_value">65 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_B </span><span class="symbol">= </span><span class="constant_value">66 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_C </span><span class="symbol">= </span><span class="constant_value">67 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_D </span><span class="symbol">= </span><span class="constant_value">68 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_E </span><span class="symbol">= </span><span class="constant_value">69 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_F </span><span class="symbol">= </span><span class="constant_value">70 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_G </span><span class="symbol">= </span><span class="constant_value">71 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_H </span><span class="symbol">= </span><span class="constant_value">72 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_I </span><span class="symbol">= </span><span class="constant_value">73 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_J </span><span class="symbol">= </span><span class="constant_value">74 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_K </span><span class="symbol">= </span><span class="constant_value">75 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_L </span><span class="symbol">= </span><span class="constant_value">76 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_M </span><span class="symbol">= </span><span class="constant_value">77 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_N </span><span class="symbol">= </span><span class="constant_value">78 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_O </span><span class="symbol">= </span><span class="constant_value">79 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_P </span><span class="symbol">= </span><span class="constant_value">80 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_Q </span><span class="symbol">= </span><span class="constant_value">81 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_R </span><span class="symbol">= </span><span class="constant_value">82 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_S </span><span class="symbol">= </span><span class="constant_value">83 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_T </span><span class="symbol">= </span><span class="constant_value">84 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_U </span><span class="symbol">= </span><span class="constant_value">85 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_V </span><span class="symbol">= </span><span class="constant_value">86 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_W </span><span class="symbol">= </span><span class="constant_value">87 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_X </span><span class="symbol">= </span><span class="constant_value">88 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_Y </span><span class="symbol">= </span><span class="constant_value">89 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_Z </span><span class="symbol">= </span><span class="constant_value">90 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_BRACKETLEFT </span><span class="symbol">= </span><span class="constant_value">91 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_BACKSLASH </span><span class="symbol">= </span><span class="constant_value">92 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_BRACKETRIGHT </span><span class="symbol">= </span><span class="constant_value">93 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_ASCIICIRCUM </span><span class="symbol">= </span><span class="constant_value">94 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_UNDERSCORE </span><span class="symbol">= </span><span class="constant_value">95 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_QUOTELEFT </span><span class="symbol">= </span><span class="constant_value">96 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_BRACELEFT </span><span class="symbol">= </span><span class="constant_value">123 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_BAR </span><span class="symbol">= </span><span class="constant_value">124 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_BRACERIGHT </span><span class="symbol">= </span><span class="constant_value">125 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_ASCIITILDE </span><span class="symbol">= </span><span class="constant_value">126 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_NOBREAKSPACE </span><span class="symbol">= </span><span class="constant_value">160 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_EXCLAMDOWN </span><span class="symbol">= </span><span class="constant_value">161 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_CENT </span><span class="symbol">= </span><span class="constant_value">162 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_STERLING </span><span class="symbol">= </span><span class="constant_value">163 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_CURRENCY </span><span class="symbol">= </span><span class="constant_value">164 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_YEN </span><span class="symbol">= </span><span class="constant_value">165 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_BROKENBAR </span><span class="symbol">= </span><span class="constant_value">166 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_SECTION </span><span class="symbol">= </span><span class="constant_value">167 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_DIAERESIS </span><span class="symbol">= </span><span class="constant_value">168 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_COPYRIGHT </span><span class="symbol">= </span><span class="constant_value">169 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_ORDFEMININE </span><span class="symbol">= </span><span class="constant_value">170 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_GUILLEMOTLEFT </span><span class="symbol">= </span><span class="constant_value">171 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_NOTSIGN </span><span class="symbol">= </span><span class="constant_value">172 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_HYPHEN </span><span class="symbol">= </span><span class="constant_value">173 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_REGISTERED </span><span class="symbol">= </span><span class="constant_value">174 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_MACRON </span><span class="symbol">= </span><span class="constant_value">175 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_DEGREE </span><span class="symbol">= </span><span class="constant_value">176 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_PLUSMINUS </span><span class="symbol">= </span><span class="constant_value">177 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_TWOSUPERIOR </span><span class="symbol">= </span><span class="constant_value">178 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_THREESUPERIOR </span><span class="symbol">= </span><span class="constant_value">179 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_ACUTE </span><span class="symbol">= </span><span class="constant_value">180 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_MU </span><span class="symbol">= </span><span class="constant_value">181 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_PARAGRAPH </span><span class="symbol">= </span><span class="constant_value">182 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_PERIODCENTERED </span><span class="symbol">= </span><span class="constant_value">183 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_CEDILLA </span><span class="symbol">= </span><span class="constant_value">184 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_ONESUPERIOR </span><span class="symbol">= </span><span class="constant_value">185 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_MASCULINE </span><span class="symbol">= </span><span class="constant_value">186 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_GUILLEMOTRIGHT </span><span class="symbol">= </span><span class="constant_value">187 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_ONEQUARTER </span><span class="symbol">= </span><span class="constant_value">188 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_ONEHALF </span><span class="symbol">= </span><span class="constant_value">189 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_THREEQUARTERS </span><span class="symbol">= </span><span class="constant_value">190 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_QUESTIONDOWN </span><span class="symbol">= </span><span class="constant_value">191 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_AGRAVE </span><span class="symbol">= </span><span class="constant_value">192 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_AACUTE </span><span class="symbol">= </span><span class="constant_value">193 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_ACIRCUMFLEX </span><span class="symbol">= </span><span class="constant_value">194 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_ATILDE </span><span class="symbol">= </span><span class="constant_value">195 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_ADIAERESIS </span><span class="symbol">= </span><span class="constant_value">196 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_ARING </span><span class="symbol">= </span><span class="constant_value">197 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_AE </span><span class="symbol">= </span><span class="constant_value">198 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_CCEDILLA </span><span class="symbol">= </span><span class="constant_value">199 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_EGRAVE </span><span class="symbol">= </span><span class="constant_value">200 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_EACUTE </span><span class="symbol">= </span><span class="constant_value">201 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_ECIRCUMFLEX </span><span class="symbol">= </span><span class="constant_value">202 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_EDIAERESIS </span><span class="symbol">= </span><span class="constant_value">203 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_IGRAVE </span><span class="symbol">= </span><span class="constant_value">204 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_IACUTE </span><span class="symbol">= </span><span class="constant_value">205 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_ICIRCUMFLEX </span><span class="symbol">= </span><span class="constant_value">206 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_IDIAERESIS </span><span class="symbol">= </span><span class="constant_value">207 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_ETH </span><span class="symbol">= </span><span class="constant_value">208 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_NTILDE </span><span class="symbol">= </span><span class="constant_value">209 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_OGRAVE </span><span class="symbol">= </span><span class="constant_value">210 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_OACUTE </span><span class="symbol">= </span><span class="constant_value">211 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_OCIRCUMFLEX </span><span class="symbol">= </span><span class="constant_value">212 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_OTILDE </span><span class="symbol">= </span><span class="constant_value">213 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_ODIAERESIS </span><span class="symbol">= </span><span class="constant_value">214 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_MULTIPLY </span><span class="symbol">= </span><span class="constant_value">215 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_OOBLIQUE </span><span class="symbol">= </span><span class="constant_value">216 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_UGRAVE </span><span class="symbol">= </span><span class="constant_value">217 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_UACUTE </span><span class="symbol">= </span><span class="constant_value">218 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_UCIRCUMFLEX </span><span class="symbol">= </span><span class="constant_value">219 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_UDIAERESIS </span><span class="symbol">= </span><span class="constant_value">220 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_YACUTE </span><span class="symbol">= </span><span class="constant_value">221 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_THORN </span><span class="symbol">= </span><span class="constant_value">222 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_SSHARP </span><span class="symbol">= </span><span class="constant_value">223 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_DIVISION </span><span class="symbol">= </span><span class="constant_value">247 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_YDIAERESIS </span><span class="symbol">= </span><span class="constant_value">255 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_CODE_MASK </span><span class="symbol">= </span><span class="constant_value">33554431 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_MODIFIER_MASK </span><span class="symbol">= </span><span class="constant_value">-16777216 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_MASK_SHIFT </span><span class="symbol">= </span><span class="constant_value">33554432 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_MASK_ALT </span><span class="symbol">= </span><span class="constant_value">67108864 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_MASK_META </span><span class="symbol">= </span><span class="constant_value">134217728 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_MASK_CTRL </span><span class="symbol">= </span><span class="constant_value">268435456 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_MASK_KPAD </span><span class="symbol">= </span><span class="constant_value">536870912 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">KEY_MASK_GROUP_SWITCH </span><span class="symbol">= </span><span class="constant_value">1073741824 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">BUTTON_LEFT </span><span class="symbol">= </span><span class="constant_value">1 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">BUTTON_RIGHT </span><span class="symbol">= </span><span class="constant_value">2 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">BUTTON_MIDDLE </span><span class="symbol">= </span><span class="constant_value">3 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">BUTTON_WHEEL_UP </span><span class="symbol">= </span><span class="constant_value">4 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">BUTTON_WHEEL_DOWN </span><span class="symbol">= </span><span class="constant_value">5 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">BUTTON_MASK_LEFT </span><span class="symbol">= </span><span class="constant_value">1 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">BUTTON_MASK_RIGHT </span><span class="symbol">= </span><span class="constant_value">2 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">BUTTON_MASK_MIDDLE </span><span class="symbol">= </span><span class="constant_value">4 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">JOY_BUTTON_0 </span><span class="symbol">= </span><span class="constant_value">0 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">JOY_BUTTON_1 </span><span class="symbol">= </span><span class="constant_value">1 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">JOY_BUTTON_2 </span><span class="symbol">= </span><span class="constant_value">2 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">JOY_BUTTON_3 </span><span class="symbol">= </span><span class="constant_value">3 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">JOY_BUTTON_4 </span><span class="symbol">= </span><span class="constant_value">4 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">JOY_BUTTON_5 </span><span class="symbol">= </span><span class="constant_value">5 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">JOY_BUTTON_6 </span><span class="symbol">= </span><span class="constant_value">6 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">JOY_BUTTON_7 </span><span class="symbol">= </span><span class="constant_value">7 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">JOY_BUTTON_8 </span><span class="symbol">= </span><span class="constant_value">8 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">JOY_BUTTON_9 </span><span class="symbol">= </span><span class="constant_value">9 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">JOY_BUTTON_10 </span><span class="symbol">= </span><span class="constant_value">10 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">JOY_BUTTON_11 </span><span class="symbol">= </span><span class="constant_value">11 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">JOY_BUTTON_12 </span><span class="symbol">= </span><span class="constant_value">12 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">JOY_BUTTON_13 </span><span class="symbol">= </span><span class="constant_value">13 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">JOY_BUTTON_14 </span><span class="symbol">= </span><span class="constant_value">14 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">JOY_BUTTON_15 </span><span class="symbol">= </span><span class="constant_value">15 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">JOY_BUTTON_MAX </span><span class="symbol">= </span><span class="constant_value">16 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">JOY_SNES_A </span><span class="symbol">= </span><span class="constant_value">1 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">JOY_SNES_B </span><span class="symbol">= </span><span class="constant_value">0 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">JOY_SNES_X </span><span class="symbol">= </span><span class="constant_value">3 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">JOY_SNES_Y </span><span class="symbol">= </span><span class="constant_value">2 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">JOY_SONY_CIRCLE </span><span class="symbol">= </span><span class="constant_value">1 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">JOY_SONY_X </span><span class="symbol">= </span><span class="constant_value">0 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">JOY_SONY_SQUARE </span><span class="symbol">= </span><span class="constant_value">2 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">JOY_SONY_TRIANGLE </span><span class="symbol">= </span><span class="constant_value">3 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">JOY_SEGA_B </span><span class="symbol">= </span><span class="constant_value">1 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">JOY_SEGA_A </span><span class="symbol">= </span><span class="constant_value">0 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">JOY_SEGA_X </span><span class="symbol">= </span><span class="constant_value">2 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">JOY_SEGA_Y </span><span class="symbol">= </span><span class="constant_value">3 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">JOY_XBOX_B </span><span class="symbol">= </span><span class="constant_value">1 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">JOY_XBOX_A </span><span class="symbol">= </span><span class="constant_value">0 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">JOY_XBOX_X </span><span class="symbol">= </span><span class="constant_value">2 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">JOY_XBOX_Y </span><span class="symbol">= </span><span class="constant_value">3 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">JOY_DS_A </span><span class="symbol">= </span><span class="constant_value">1 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">JOY_DS_B </span><span class="symbol">= </span><span class="constant_value">0 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">JOY_DS_X </span><span class="symbol">= </span><span class="constant_value">3 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">JOY_DS_Y </span><span class="symbol">= </span><span class="constant_value">2 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">JOY_SELECT </span><span class="symbol">= </span><span class="constant_value">10 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">JOY_START </span><span class="symbol">= </span><span class="constant_value">11 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">JOY_DPAD_UP </span><span class="symbol">= </span><span class="constant_value">12 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">JOY_DPAD_DOWN </span><span class="symbol">= </span><span class="constant_value">13 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">JOY_DPAD_LEFT </span><span class="symbol">= </span><span class="constant_value">14 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">JOY_DPAD_RIGHT </span><span class="symbol">= </span><span class="constant_value">15 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">JOY_L </span><span class="symbol">= </span><span class="constant_value">4 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">JOY_L2 </span><span class="symbol">= </span><span class="constant_value">6 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">JOY_L3 </span><span class="symbol">= </span><span class="constant_value">8 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">JOY_R </span><span class="symbol">= </span><span class="constant_value">5 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">JOY_R2 </span><span class="symbol">= </span><span class="constant_value">7 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">JOY_R3 </span><span class="symbol">= </span><span class="constant_value">9 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">JOY_AXIS_0 </span><span class="symbol">= </span><span class="constant_value">0 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">JOY_AXIS_1 </span><span class="symbol">= </span><span class="constant_value">1 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">JOY_AXIS_2 </span><span class="symbol">= </span><span class="constant_value">2 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">JOY_AXIS_3 </span><span class="symbol">= </span><span class="constant_value">3 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">JOY_AXIS_4 </span><span class="symbol">= </span><span class="constant_value">4 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">JOY_AXIS_5 </span><span class="symbol">= </span><span class="constant_value">5 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">JOY_AXIS_6 </span><span class="symbol">= </span><span class="constant_value">6 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">JOY_AXIS_7 </span><span class="symbol">= </span><span class="constant_value">7 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">JOY_AXIS_MAX </span><span class="symbol">= </span><span class="constant_value">8 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">JOY_ANALOG_0_X </span><span class="symbol">= </span><span class="constant_value">0 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">JOY_ANALOG_0_Y </span><span class="symbol">= </span><span class="constant_value">1 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">JOY_ANALOG_1_X </span><span class="symbol">= </span><span class="constant_value">2 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">JOY_ANALOG_1_Y </span><span class="symbol">= </span><span class="constant_value">3 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">JOY_ANALOG_2_X </span><span class="symbol">= </span><span class="constant_value">4 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">JOY_ANALOG_2_Y </span><span class="symbol">= </span><span class="constant_value">5 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">OK </span><span class="symbol">= </span><span class="constant_value">0 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">FAILED </span><span class="symbol">= </span><span class="constant_value">1 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">ERR_UNAVAILABLE </span><span class="symbol">= </span><span class="constant_value">2 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">ERR_UNCONFIGURED </span><span class="symbol">= </span><span class="constant_value">3 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">ERR_UNAUTHORIZED </span><span class="symbol">= </span><span class="constant_value">4 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">ERR_PARAMETER_RANGE_ERROR </span><span class="symbol">= </span><span class="constant_value">5 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">ERR_OUT_OF_MEMORY </span><span class="symbol">= </span><span class="constant_value">6 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">ERR_FILE_NOT_FOUND </span><span class="symbol">= </span><span class="constant_value">7 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">ERR_FILE_BAD_DRIVE </span><span class="symbol">= </span><span class="constant_value">8 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">ERR_FILE_BAD_PATH </span><span class="symbol">= </span><span class="constant_value">9 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">ERR_FILE_NO_PERMISSION </span><span class="symbol">= </span><span class="constant_value">10 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">ERR_FILE_ALREADY_IN_USE </span><span class="symbol">= </span><span class="constant_value">11 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">ERR_FILE_CANT_OPEN </span><span class="symbol">= </span><span class="constant_value">12 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">ERR_FILE_CANT_WRITE </span><span class="symbol">= </span><span class="constant_value">13 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">ERR_FILE_CANT_READ </span><span class="symbol">= </span><span class="constant_value">14 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">ERR_FILE_UNRECOGNIZED </span><span class="symbol">= </span><span class="constant_value">15 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">ERR_FILE_CORRUPT </span><span class="symbol">= </span><span class="constant_value">16 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">ERR_FILE_EOF </span><span class="symbol">= </span><span class="constant_value">17 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">ERR_CANT_OPEN </span><span class="symbol">= </span><span class="constant_value">18 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">ERR_CANT_CREATE </span><span class="symbol">= </span><span class="constant_value">19 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">ERROR_QUERY_FAILED </span><span class="symbol">= </span><span class="constant_value">20 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">ERR_ALREADY_IN_USE </span><span class="symbol">= </span><span class="constant_value">21 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">ERR_LOCKED </span><span class="symbol">= </span><span class="constant_value">22 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">ERR_TIMEOUT </span><span class="symbol">= </span><span class="constant_value">23 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">ERR_CANT_AQUIRE_RESOURCE </span><span class="symbol">= </span><span class="constant_value">24 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">ERR_INVALID_DATA </span><span class="symbol">= </span><span class="constant_value">26 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">ERR_INVALID_PARAMETER </span><span class="symbol">= </span><span class="constant_value">27 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">ERR_ALREADY_EXISTS </span><span class="symbol">= </span><span class="constant_value">28 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">ERR_DOES_NOT_EXIST </span><span class="symbol">= </span><span class="constant_value">29 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">ERR_DATABASE_CANT_READ </span><span class="symbol">= </span><span class="constant_value">30 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">ERR_DATABASE_CANT_WRITE </span><span class="symbol">= </span><span class="constant_value">31 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">ERR_COMPILATION_FAILED </span><span class="symbol">= </span><span class="constant_value">32 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">ERR_METHOD_NOT_FOUND </span><span class="symbol">= </span><span class="constant_value">33 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">ERR_LINK_FAILED </span><span class="symbol">= </span><span class="constant_value">34 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">ERR_SCRIPT_FAILED </span><span class="symbol">= </span><span class="constant_value">35 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">ERR_CYCLIC_LINK </span><span class="symbol">= </span><span class="constant_value">36 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">ERR_BUSY </span><span class="symbol">= </span><span class="constant_value">40 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">ERR_HELP </span><span class="symbol">= </span><span class="constant_value">42 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">ERR_BUG </span><span class="symbol">= </span><span class="constant_value">43 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">ERR_WTF </span><span class="symbol">= </span><span class="constant_value">45 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">PROPERTY_HINT_NONE </span><span class="symbol">= </span><span class="constant_value">0 </span><span class="constant_description"> - No hint for edited property. - </span></div></li><li><div class="constant"><span class="identifier constant_name">PROPERTY_HINT_RANGE </span><span class="symbol">= </span><span class="constant_value">1 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">PROPERTY_HINT_EXP_RANGE </span><span class="symbol">= </span><span class="constant_value">2 </span><span class="constant_description"> - Hint string is an exponential range, defined as "min,max" or "min,max,step". This is valid for integers and floats. - </span></div></li><li><div class="constant"><span class="identifier constant_name">PROPERTY_HINT_ENUM </span><span class="symbol">= </span><span class="constant_value">3 </span><span class="constant_description"> - Property hint is an enumerated value, like "Hello,Something,Else". This is valid for integers, floats and strings properties. - </span></div></li><li><div class="constant"><span class="identifier constant_name">PROPERTY_HINT_LENGTH </span><span class="symbol">= </span><span class="constant_value">5 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">PROPERTY_HINT_FLAGS </span><span class="symbol">= </span><span class="constant_value">7 </span><span class="constant_description"> - Property hint is a bitmask description, for bits 0,1,2,3 abd 5 the hint would be like "Bit0,Bit1,Bit2,Bit3,,Bit5". Valid only for integers. - </span></div></li><li><div class="constant"><span class="identifier constant_name">PROPERTY_HINT_FILE </span><span class="symbol">= </span><span class="constant_value">8 </span><span class="constant_description"> - String property is a file (so pop up a file dialog when edited). Hint string can be a set of wildcards like "*.doc". - </span></div></li><li><div class="constant"><span class="identifier constant_name">PROPERTY_HINT_DIR </span><span class="symbol">= </span><span class="constant_value">9 </span><span class="constant_description"> - String property is a directory (so pop up a file dialog when edited). - </span></div></li><li><div class="constant"><span class="identifier constant_name">PROPERTY_HINT_RESOURCE_TYPE </span><span class="symbol">= </span><span class="constant_value">10 </span><span class="constant_description"> - String property is a resource, so open the resource popup menu when edited. - </span></div></li><li><div class="constant"><span class="identifier constant_name">PROPERTY_USAGE_STORAGE </span><span class="symbol">= </span><span class="constant_value">1 </span><span class="constant_description"> - Property will be used as storage (default). - </span></div></li><li><div class="constant"><span class="identifier constant_name">PROPERTY_USAGE_STORAGE </span><span class="symbol">= </span><span class="constant_value">1 </span><span class="constant_description"> - Property will be used as storage (default). - </span></div></li><li><div class="constant"><span class="identifier constant_name">PROPERTY_USAGE_EDITOR </span><span class="symbol">= </span><span class="constant_value">2 </span><span class="constant_description"> - Property will be visible in editor (default). - </span></div></li><li><div class="constant"><span class="identifier constant_name">PROPERTY_USAGE_NETWORK </span><span class="symbol">= </span><span class="constant_value">4 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">PROPERTY_USAGE_DEFAULT </span><span class="symbol">= </span><span class="constant_value">7 </span><span class="constant_description"> - Default usage (storage and editor). - </span></div></li><li><div class="constant"><span class="identifier constant_name">TYPE_NIL </span><span class="symbol">= </span><span class="constant_value">0 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">TYPE_BOOL </span><span class="symbol">= </span><span class="constant_value">1 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">TYPE_INT </span><span class="symbol">= </span><span class="constant_value">2 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">TYPE_REAL </span><span class="symbol">= </span><span class="constant_value">3 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">TYPE_STRING </span><span class="symbol">= </span><span class="constant_value">4 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">TYPE_VECTOR2 </span><span class="symbol">= </span><span class="constant_value">5 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">TYPE_RECT2 </span><span class="symbol">= </span><span class="constant_value">6 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">TYPE_VECTOR3 </span><span class="symbol">= </span><span class="constant_value">7 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">TYPE_MATRIX32 </span><span class="symbol">= </span><span class="constant_value">8 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">TYPE_PLANE </span><span class="symbol">= </span><span class="constant_value">9 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">TYPE_QUAT </span><span class="symbol">= </span><span class="constant_value">10 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">TYPE_AABB </span><span class="symbol">= </span><span class="constant_value">11 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">TYPE_MATRIX3 </span><span class="symbol">= </span><span class="constant_value">12 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">TYPE_TRANSFORM </span><span class="symbol">= </span><span class="constant_value">13 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">TYPE_COLOR </span><span class="symbol">= </span><span class="constant_value">14 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">TYPE_IMAGE </span><span class="symbol">= </span><span class="constant_value">15 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">TYPE_NODE_PATH </span><span class="symbol">= </span><span class="constant_value">16 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">TYPE_RID </span><span class="symbol">= </span><span class="constant_value">17 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">TYPE_OBJECT </span><span class="symbol">= </span><span class="constant_value">18 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">TYPE_INPUT_EVENT </span><span class="symbol">= </span><span class="constant_value">19 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">TYPE_DICTIONARY </span><span class="symbol">= </span><span class="constant_value">20 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">TYPE_ARRAY </span><span class="symbol">= </span><span class="constant_value">21 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">TYPE_RAW_ARRAY </span><span class="symbol">= </span><span class="constant_value">22 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">TYPE_INT_ARRAY </span><span class="symbol">= </span><span class="constant_value">23 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">TYPE_REAL_ARRAY </span><span class="symbol">= </span><span class="constant_value">24 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">TYPE_STRING_ARRAY </span><span class="symbol">= </span><span class="constant_value">25 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">TYPE_VECTOR2_ARRAY </span><span class="symbol">= </span><span class="constant_value">26 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">TYPE_VECTOR3_ARRAY </span><span class="symbol">= </span><span class="constant_value">27 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">TYPE_COLOR_ARRAY </span><span class="symbol">= </span><span class="constant_value">28 </span><span class="constant_description"> - </span></div></li><li><div class="constant"><span class="identifier constant_name">TYPE_MAX </span><span class="symbol">= </span><span class="constant_value">29 </span><span class="constant_description"> - </span></div></li></div><h4>Description:</h4><div class="description"> - Global scope constants and variables. This is all that resides in the globals, constants regarding error codes, scancodes, property hints, etc. It's not much. - Singletons are also documented here, since they can be accessed from anywhere. - </div><h4>Method Documentation:</h4></div><hr /><span>Copyright 2008-2010 Codenix SRL</span></body></html>
\ No newline at end of file diff --git a/doc/html/@Squirrel.html b/doc/html/@Squirrel.html deleted file mode 100644 index ad4aaa49d8..0000000000 --- a/doc/html/@Squirrel.html +++ /dev/null @@ -1,2 +0,0 @@ -<html><link href="main.css" rel="stylesheet" type="text/css" /><body><table class="top_table"><tr><td class="top_table"><image src="images/logo.png" /></td><td class="top_table"><a href="index.html">Index</a></td><td class="top_table"><a href="alphabetical.html">Classes</a></td><td class="top_table"><a href="category.html">Categories</a></td><td><a href="inheritance.html">Inheritance</a></td></tr></table><hr /><div class="class"><a name="@Squirrel"><h3 class="title class_title">@Squirrel</h3></a><div class="description class_description"> - </div><br /><div class="category"><span class="category">Category: </span><a class="category_ref" href="category.html#CATEGORY_Core">Core</a></div><h4>Method Documentation:</h4></div><hr /><span>Copyright 2008-2010 Codenix SRL</span></body></html>
\ No newline at end of file diff --git a/doc/html/tutorial01/0_home_red_coding_godot_doc_math_position.png b/doc/html/tutorial01/0_home_red_coding_godot_doc_math_position.png Binary files differdeleted file mode 100644 index df52c05462..0000000000 --- a/doc/html/tutorial01/0_home_red_coding_godot_doc_math_position.png +++ /dev/null diff --git a/doc/html/tutorial01/1_home_red_coding_godot_doc_math_direction.png b/doc/html/tutorial01/1_home_red_coding_godot_doc_math_direction.png Binary files differdeleted file mode 100644 index 5b58274bcb..0000000000 --- a/doc/html/tutorial01/1_home_red_coding_godot_doc_math_direction.png +++ /dev/null diff --git a/doc/html/tutorial01/2_home_red_coding_godot_doc_math_normals.png b/doc/html/tutorial01/2_home_red_coding_godot_doc_math_normals.png Binary files differdeleted file mode 100644 index 73681a58ce..0000000000 --- a/doc/html/tutorial01/2_home_red_coding_godot_doc_math_normals.png +++ /dev/null diff --git a/doc/html/tutorial01/tutorial.css b/doc/html/tutorial01/tutorial.css deleted file mode 100644 index a518c6dff7..0000000000 --- a/doc/html/tutorial01/tutorial.css +++ /dev/null @@ -1,128 +0,0 @@ - -/* start css.sty */ -.cmr-7{font-size:70%;} -.cmmi-7{font-size:70%;font-style: italic;} -.cmmi-10{font-style: italic;} -.ectt-1000{ font-family: monospace;} -.ectt-1000{ font-family: monospace;} -.ectt-1000{ font-family: monospace;} -.ectt-1000{ font-family: monospace;} -.ectt-1000{ font-family: monospace;} -.ecti-1000{ font-style: italic;} -.ecti-1000{ font-style: italic;} -.ecti-1000{ font-style: italic;} -.ecti-1000{ font-style: italic;} -.ecti-1000{ font-style: italic;} -.ecti-0700{font-size:70%; font-style: italic;} -.ecti-0700{ font-style: italic;} -.ecti-0700{ font-style: italic;} -.ecti-0700{ font-style: italic;} -.ecti-0700{ font-style: italic;} -.ecrm-0700{font-size:70%;} -p.noindent { text-indent: 0em } -td p.noindent { text-indent: 0em; margin-top:0em; } -p.nopar { text-indent: 0em; } -p.indent{ text-indent: 1.5em } -@media print {div.crosslinks {visibility:hidden;}} -a img { border-top: 0; border-left: 0; border-right: 0; } -center { margin-top:1em; margin-bottom:1em; } -td center { margin-top:0em; margin-bottom:0em; } -.Canvas { position:relative; } -img.math{vertical-align:middle;} -li p.indent { text-indent: 0em } -.enumerate1 {list-style-type:decimal;} -.enumerate2 {list-style-type:lower-alpha;} -.enumerate3 {list-style-type:lower-roman;} -.enumerate4 {list-style-type:upper-alpha;} -div.newtheorem { margin-bottom: 2em; margin-top: 2em;} -.obeylines-h,.obeylines-v {white-space: nowrap; } -div.obeylines-v p { margin-top:0; margin-bottom:0; } -.overline{ text-decoration:overline; } -.overline img{ border-top: 1px solid black; } -td.displaylines {text-align:center; white-space:nowrap;} -.centerline {text-align:center;} -.rightline {text-align:right;} -div.verbatim {font-family: monospace; white-space: nowrap; text-align:left; clear:both; } -.fbox {padding-left:3.0pt; padding-right:3.0pt; text-indent:0pt; border:solid black 0.4pt; } -div.fbox {display:table} -div.center div.fbox {text-align:center; clear:both; padding-left:3.0pt; padding-right:3.0pt; text-indent:0pt; border:solid black 0.4pt; } -table.minipage{width:100%;} -div.center, div.center div.center {text-align: center; margin-left:1em; margin-right:1em;} -div.center div {text-align: left;} -div.flushright, div.flushright div.flushright {text-align: right;} -div.flushright div {text-align: left;} -div.flushleft {text-align: left;} -.underline{ text-decoration:underline; } -.underline img{ border-bottom: 1px solid black; margin-bottom:1pt; } -.framebox-c, .framebox-l, .framebox-r { padding-left:3.0pt; padding-right:3.0pt; text-indent:0pt; border:solid black 0.4pt; } -.framebox-c {text-align:center;} -.framebox-l {text-align:left;} -.framebox-r {text-align:right;} -span.thank-mark{ vertical-align: super } -span.footnote-mark sup.textsuperscript, span.footnote-mark a sup.textsuperscript{ font-size:80%; } -div.tabular, div.center div.tabular {text-align: center; margin-top:0.5em; margin-bottom:0.5em; } -table.tabular td p{margin-top:0em;} -table.tabular {margin-left: auto; margin-right: auto;} -div.td00{ margin-left:0pt; margin-right:0pt; } -div.td01{ margin-left:0pt; margin-right:5pt; } -div.td10{ margin-left:5pt; margin-right:0pt; } -div.td11{ margin-left:5pt; margin-right:5pt; } -table[rules] {border-left:solid black 0.4pt; border-right:solid black 0.4pt; } -td.td00{ padding-left:0pt; padding-right:0pt; } -td.td01{ padding-left:0pt; padding-right:5pt; } -td.td10{ padding-left:5pt; padding-right:0pt; } -td.td11{ padding-left:5pt; padding-right:5pt; } -table[rules] {border-left:solid black 0.4pt; border-right:solid black 0.4pt; } -.hline hr, .cline hr{ height : 1px; margin:0px; } -.tabbing-right {text-align:right;} -span.TEX {letter-spacing: -0.125em; } -span.TEX span.E{ position:relative;top:0.5ex;left:-0.0417em;} -a span.TEX span.E {text-decoration: none; } -span.LATEX span.A{ position:relative; top:-0.5ex; left:-0.4em; font-size:85%;} -span.LATEX span.TEX{ position:relative; left: -0.4em; } -div.float img, div.float .caption {text-align:center;} -div.figure img, div.figure .caption {text-align:center;} -.marginpar {width:20%; float:right; text-align:left; margin-left:auto; margin-top:0.5em; font-size:85%; text-decoration:underline;} -.marginpar p{margin-top:0.4em; margin-bottom:0.4em;} -table.equation {width:100%;} -.equation td{text-align:center; } -td.equation { margin-top:1em; margin-bottom:1em; } -td.equation-label { width:5%; text-align:center; } -td.eqnarray4 { width:5%; white-space: normal; } -td.eqnarray2 { width:5%; } -table.eqnarray-star, table.eqnarray {width:100%;} -div.eqnarray{text-align:center;} -div.array {text-align:center;} -div.pmatrix {text-align:center;} -table.pmatrix {width:100%;} -span.pmatrix img{vertical-align:middle;} -div.pmatrix {text-align:center;} -table.pmatrix {width:100%;} -img.cdots{vertical-align:middle;} -.partToc a, .partToc, .likepartToc a, .likepartToc {line-height: 200%; font-weight:bold; font-size:110%;} -.index-item, .index-subitem, .index-subsubitem {display:block} -.caption td.id{font-weight: bold; white-space: nowrap; } -table.caption {text-align:center;} -h1.partHead{text-align: center} -p.bibitem { text-indent: -2em; margin-left: 2em; margin-top:0.6em; margin-bottom:0.6em; } -p.bibitem-p { text-indent: 0em; margin-left: 2em; margin-top:0.6em; margin-bottom:0.6em; } -.paragraphHead, .likeparagraphHead { margin-top:2em; font-weight: bold;} -.subparagraphHead, .likesubparagraphHead { font-weight: bold;} -.quote {margin-bottom:0.25em; margin-top:0.25em; margin-left:1em; margin-right:1em; text-align:justify;} -.verse{white-space:nowrap; margin-left:2em} -div.maketitle {text-align:center;} -h2.titleHead{text-align:center;} -div.maketitle{ margin-bottom: 2em; } -div.author, div.date {text-align:center;} -div.thanks{text-align:left; margin-left:10%; font-size:85%; font-style:italic; } -div.author{white-space: nowrap;} -.quotation {margin-bottom:0.25em; margin-top:0.25em; margin-left:1em; } -.abstract p {margin-left:5%; margin-right:5%;} -table.abstract {width:100%;} -.lstlisting .label{margin-right:0.5em; } -div.lstlisting{font-family: monospace; white-space: nowrap; margin-top:0.5em; margin-bottom:0.5em; } -div.lstinputlisting{ font-family: monospace; white-space: nowrap; } -.lstinputlisting .label{margin-right:0.5em;} -.figure img.graphics {margin-left:10%;} -/* end css.sty */ - diff --git a/doc/html/tutorial01/tutorial.html b/doc/html/tutorial01/tutorial.html deleted file mode 100644 index 45c0258709..0000000000 --- a/doc/html/tutorial01/tutorial.html +++ /dev/null @@ -1,902 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" - "http://www.w3.org/TR/html4/loose.dtd"> -<html > -<head><title></title> -<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> -<meta name="generator" content="TeX4ht (http://www.cse.ohio-state.edu/~gurari/TeX4ht/)"> -<meta name="originator" content="TeX4ht (http://www.cse.ohio-state.edu/~gurari/TeX4ht/)"> -<!-- html --> -<meta name="src" content="tutorial.tex"> -<meta name="date" content="2009-10-07 00:28:00"> -<link rel="stylesheet" type="text/css" href="tutorial.css"> -</head><body -> - <h3 class="sectionHead"><span class="titlemark">1 </span> <a - id="x1-10001"></a>Introduction to 3D Math</h3> -<!--l. 27--><p class="noindent" > - <h4 class="subsectionHead"><span class="titlemark">1.1 </span> <a - id="x1-20001.1"></a>Introduction</h4> -<!--l. 29--><p class="noindent" >There are many approaches to understanding the type of 3D math used in video -games, modelling, ray-tracing, etc. The usual is through vector algebra, matrices, and -linear transformations and, while they are not completely necesary to understand -most of the aspects of 3D game programming (from the theorical point of view), they -provide a common language to communicate with other programmers or -engineers. -<!--l. 36--><p class="indent" > This tutorial will focus on explaining all the basic concepts needed for a -programmer to understand how to develop 3D games without getting too deep into -algebra. Instead of a math-oriented language, code examples will be given instead -when possible. The reason for this is that. while programmers may have -different backgrounds or experience (be it scientific, engineering or self taught), -code is the most familiar language and the lowest common denominator for -understanding. -<!--l. 45--><p class="noindent" > - <h4 class="subsectionHead"><span class="titlemark">1.2 </span> <a - id="x1-30001.2"></a>Vectors</h4> -<!--l. 48--><p class="noindent" > - <h5 class="subsubsectionHead"><span class="titlemark">1.2.1 </span> <a - id="x1-40001.2.1"></a>Brief Introduction</h5> -<!--l. 50--><p class="noindent" >When writing 2D games, interfaces and other applications, the typical convention is -to define coordinates as an <span -class="ecti-1000">x,y </span>pair, <span -class="ecti-1000">x </span>representing the horizontal offset and <span -class="ecti-1000">y </span>the -vertical one. In most cases, the unit for both is <span -class="ecti-1000">pixels</span>. This makes sense given the -screen is just a rectangle in two dimensions. -<!--l. 56--><p class="indent" > An <span -class="ecti-1000">x,y </span>pair can be used for two purposes. It can be an absolute position (screen -cordinate in the previous case), or a relative direction, if we trace an arrow from the -origin (0,0 coordinates) to it’s position. -<div class="center" -> -<!--l. 60--><p class="noindent" > - -<div class="tabular"> - <table id="TBL-1" class="tabular" -cellspacing="0" cellpadding="0" -><colgroup id="TBL-1-1g"><col -id="TBL-1-1"><col -id="TBL-1-2"><col -id="TBL-1-3"></colgroup><tr - style="vertical-align:baseline;" id="TBL-1-1-"><td style="white-space:nowrap; text-align:center;" id="TBL-1-1-1" -class="td11"><img -src="tutorial0x.png" alt="PIC" class="graphics" width="100.375pt" height="100.375pt" ><!--tex4ht:graphics -name="tutorial0x.png" src="0_home_red_coding_godot_doc_math_position.eps" ---></td><td style="white-space:nowrap; text-align:center;" id="TBL-1-1-2" -class="td11"></td><td style="white-space:nowrap; text-align:center;" id="TBL-1-1-3" -class="td11"><img -src="tutorial1x.png" alt="PIC" class="graphics" width="100.375pt" height="100.375pt" ><!--tex4ht:graphics -name="tutorial1x.png" src="1_home_red_coding_godot_doc_math_direction.eps" ---></td> -</tr><tr - style="vertical-align:baseline;" id="TBL-1-2-"><td style="white-space:nowrap; text-align:center;" id="TBL-1-2-1" -class="td11"> <span -class="ecti-0700">Position </span></td><td style="white-space:nowrap; text-align:center;" id="TBL-1-2-2" -class="td11"></td><td style="white-space:nowrap; text-align:center;" id="TBL-1-2-3" -class="td11"> <span -class="ecti-0700">Direction </span></td> -</tr><tr - style="vertical-align:baseline;" id="TBL-1-3-"><td style="white-space:nowrap; text-align:center;" id="TBL-1-3-1" -class="td11"> </td> -</tr></table></div> -</div> -<!--l. 67--><p class="indent" > When used as a direction, this pair is called a <span -class="ecti-1000">vector</span>, and two properties can be -observed: The first is the <span -class="ecti-1000">magnitude </span>or <span -class="ecti-1000">length </span>, and the second is the direction. In -two dimensions, direction can be an angle. The <span -class="ecti-1000">magnitude </span>or <span -class="ecti-1000">length </span>can be computed -by simply using Pithagoras theorem: -<div class="center" -> -<!--l. 73--><p class="noindent" > -<div class="tabular"> <table id="TBL-2" class="tabular" -cellspacing="0" cellpadding="0" -><colgroup id="TBL-2-1g"><col -id="TBL-2-1"><col -id="TBL-2-2"></colgroup><tr - style="vertical-align:baseline;" id="TBL-2-1-"><td style="white-space:nowrap; text-align:center;" id="TBL-2-1-1" -class="td11"><img -src="tutorial2x.png" alt="∘x2-+-y2-" class="sqrt" ></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-1-2" -class="td11"><img -src="tutorial3x.png" alt="∘x2-+-y2 +-z2" class="sqrt" ></td> -</tr><tr - style="vertical-align:baseline;" id="TBL-2-2-"><td style="white-space:nowrap; text-align:center;" id="TBL-2-2-1" -class="td11"> <span -class="ecti-0700">2D </span></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-2-2" -class="td11"> <span -class="ecti-0700">3D </span></td> -</tr><tr - style="vertical-align:baseline;" id="TBL-2-3-"><td style="white-space:nowrap; text-align:center;" id="TBL-2-3-1" -class="td11"> </td> -</tr></table></div> -</div> -<!--l. 80--><p class="indent" > The direction can be an arbitrary angle from either the <span -class="ecti-1000">x </span>or <span -class="ecti-1000">y </span>axis, and could be -computed by using trigonometry, or just using the usual <span -class="ecti-1000">atan2 </span>function present in -most math libraries. However, when dealing with 3D, the direction can’t be described -as an angle. To separate magnitude and direction, 3D uses the concept of <span -class="ecti-1000">normal</span> -<span -class="ecti-1000">vectors.</span> -<!--l. 88--><p class="noindent" > - <h5 class="subsubsectionHead"><span class="titlemark">1.2.2 </span> <a - id="x1-50001.2.2"></a>Implementation</h5> -<!--l. 90--><p class="noindent" >Vectors are implemented in Godot Engine as a class named <span -class="ecti-1000">Vector3 </span>for 3D, and as -both <span -class="ecti-1000">Vector2</span>, <span -class="ecti-1000">Point2 </span>or <span -class="ecti-1000">Size2 </span>in 2D (they are all aliases). They are used for any -purpose where a pair of 2D or 3D values (described as <span -class="ecti-1000">x,y </span>or <span -class="ecti-1000">x,y,z) </span>is needed. This is -somewhat a standard in most libraries or engines. In the script API, they can be -instanced like this: - <!--l. 98--> - <div class="lstlisting"><span class="label"><a - id="x1-5001r1"></a></span>a = Vector3() <br /><span class="label"><a - id="x1-5002r2"></a></span>a = Vector2( 2.0, 3.4 ) - </div> - -<!--l. 104--><p class="indent" > Vectors also support the common operators <span -class="ecti-1000">+, -, / and * </span>for addition, -substraction, multiplication and division. - <!--l. 108--> - <div class="lstlisting"><span class="label"><a - id="x1-5003r1"></a></span>a = Vector3(1,2,3) <br /><span class="label"><a - id="x1-5004r2"></a></span>b = Vector3(4,5,6) <br /><span class="label"><a - id="x1-5005r3"></a></span>c = Vector3() <br /><span class="label"><a - id="x1-5006r4"></a></span> <br /><span class="label"><a - id="x1-5007r5"></a></span>// writing <br /><span class="label"><a - id="x1-5008r6"></a></span> <br /><span class="label"><a - id="x1-5009r7"></a></span>c = a + b <br /><span class="label"><a - id="x1-5010r8"></a></span> <br /><span class="label"><a - id="x1-5011r9"></a></span>// is the same as writing <br /><span class="label"><a - id="x1-5012r10"></a></span> <br /><span class="label"><a - id="x1-5013r11"></a></span>c.x = a.x + b.x <br /><span class="label"><a - id="x1-5014r12"></a></span>c.y = a.y + b.y <br /><span class="label"><a - id="x1-5015r13"></a></span>c.z = a.z + b.z <br /><span class="label"><a - id="x1-5016r14"></a></span> <br /><span class="label"><a - id="x1-5017r15"></a></span>// both will result in a vector containing (5,7,9). <br /><span class="label"><a - id="x1-5018r16"></a></span>// the same happens for the rest of the operators. - </div> -<!--l. 128--><p class="indent" > Vectors also can perform a wide variety of built-in functions, their most common -usages will be explored next. -<!--l. 132--><p class="noindent" > - <h5 class="subsubsectionHead"><span class="titlemark">1.2.3 </span> <a - id="x1-60001.2.3"></a>Normal Vectors</h5> -<!--l. 134--><p class="noindent" >Two points ago, it was mentioned that 3D vectors can’t describe their direction as an -agle (as 2D vectors can). Because of this, <span -class="ecti-1000">normal vectors </span>become important for -separating a vector between <span -class="ecti-1000">direction </span>and <span -class="ecti-1000">magnitude.</span> -<!--l. 139--><p class="indent" > A <span -class="ecti-1000">normal vector </span>is a vector with a <span -class="ecti-1000">magnitude </span>of <span -class="ecti-1000">1. </span>This means, no matter where -the vector is pointing to, it’s length is always <span -class="ecti-1000">1</span>. - <div class="tabular"> - <table id="TBL-3" class="tabular" -cellspacing="0" cellpadding="0" -><colgroup id="TBL-3-1g"><col -id="TBL-3-1"></colgroup><tr - style="vertical-align:baseline;" id="TBL-3-1-"><td style="white-space:nowrap; text-align:center;" id="TBL-3-1-1" -class="td11"><img -src="tutorial4x.png" alt="PIC" class="graphics" width="100.375pt" height="100.375pt" ><!--tex4ht:graphics -name="tutorial4x.png" src="2_home_red_coding_godot_doc_math_normals.eps" ---></td> -</tr><tr - style="vertical-align:baseline;" id="TBL-3-2-"><td style="white-space:nowrap; text-align:center;" id="TBL-3-2-1" -class="td11"> <span -class="ecrm-0700">Normal vectors aroud the origin. </span></td> -</tr><tr - style="vertical-align:baseline;" id="TBL-3-3-"><td style="white-space:nowrap; text-align:center;" id="TBL-3-3-1" -class="td11"> </td> </tr></table> -</div> -<!--l. 148--><p class="indent" > Normal vectors have endless uses in 3D graphics programming, so it’s -recommended to get familiar with them as much as possible. -<!--l. 152--><p class="noindent" > - <h5 class="subsubsectionHead"><span class="titlemark">1.2.4 </span> <a - id="x1-70001.2.4"></a>Normalization</h5> -<!--l. 154--><p class="noindent" >Normalization is the process through which normal vectors are obtained -from regular vectors. In other words, normalization is used to reduce the -<span -class="ecti-1000">magnitude </span>of any vector to <span -class="ecti-1000">1</span>. (except of course, unless the vector is (0,0,0) -). -<!--l. 159--><p class="indent" > To normalize a vector, it must be divided by its magnitude (which should be -greater than zero): - <!--l. 163--> - <div class="lstlisting"><span class="label"><a - id="x1-7001r1"></a></span><span -class="ecti-1000">//</span><span -class="ecti-1000"> </span><span -class="ecti-1000">a</span><span -class="ecti-1000"> </span><span -class="ecti-1000">custom</span><span -class="ecti-1000"> </span><span -class="ecti-1000">vector</span><span -class="ecti-1000"> </span><span -class="ecti-1000">is</span><span -class="ecti-1000"> </span><span -class="ecti-1000">created</span> <br /><span class="label"><a - id="x1-7002r2"></a></span>a = Vector3(4,5,6) <br /><span class="label"><a - id="x1-7003r3"></a></span><span -class="ecti-1000">//</span><span -class="ecti-1000"> </span><span -class="ecti-1000">’</span><span -class="ecti-1000">l</span><span -class="ecti-1000">’</span><span -class="ecti-1000"> </span><span -class="ecti-1000">is</span><span -class="ecti-1000"> </span><span -class="ecti-1000">a</span><span -class="ecti-1000"> </span><span -class="ecti-1000">single</span><span -class="ecti-1000"> </span><span -class="ecti-1000">real</span><span -class="ecti-1000"> </span><span -class="ecti-1000">number</span><span -class="ecti-1000"> </span><span -class="ecti-1000">(</span><span -class="ecti-1000">or</span><span -class="ecti-1000"> </span><span -class="ecti-1000">scalar</span><span -class="ecti-1000">)</span><span -class="ecti-1000"> </span><span -class="ecti-1000">containight</span><span -class="ecti-1000"> </span><span -class="ecti-1000">the</span><span -class="ecti-1000"> </span><span -class="ecti-1000">length</span> <br /><span class="label"><a - id="x1-7004r4"></a></span>l = Math.sqrt( a.x<span -class="cmsy-10">*</span>a.x + a.y<span -class="cmsy-10">*</span>a.y + a.z<span -class="cmsy-10">*</span>a.z ) <br /><span class="label"><a - id="x1-7005r5"></a></span><span -class="ecti-1000">//</span><span -class="ecti-1000"> </span><span -class="ecti-1000">the</span><span -class="ecti-1000"> </span><span -class="ecti-1000">vector</span><span -class="ecti-1000"> </span><span -class="ecti-1000">’</span><span -class="ecti-1000">a</span><span -class="ecti-1000">’</span><span -class="ecti-1000"> </span><span -class="ecti-1000">is</span><span -class="ecti-1000"> </span><span -class="ecti-1000">divided</span><span -class="ecti-1000"> </span><span -class="ecti-1000">by</span><span -class="ecti-1000"> </span><span -class="ecti-1000">its</span><span -class="ecti-1000"> </span><span -class="ecti-1000">length</span><span -class="ecti-1000">,</span><span -class="ecti-1000"> </span><span -class="ecti-1000">by</span><span -class="ecti-1000"> </span><span -class="ecti-1000">performing</span><span -class="ecti-1000"> </span><span -class="ecti-1000">scalar</span><span -class="ecti-1000"> </span><span -class="ecti-1000">divide</span> <br /><span class="label"><a - id="x1-7006r6"></a></span>a = a / l <br /><span class="label"><a - id="x1-7007r7"></a></span><span -class="ecti-1000">//</span><span -class="ecti-1000"> </span><span -class="ecti-1000">which</span><span -class="ecti-1000"> </span><span -class="ecti-1000">is</span><span -class="ecti-1000"> </span><span -class="ecti-1000">the</span><span -class="ecti-1000"> </span><span -class="ecti-1000">same</span><span -class="ecti-1000"> </span><span -class="ecti-1000">as</span> <br /><span class="label"><a - id="x1-7008r8"></a></span>a.x = a.x / l <br /><span class="label"><a - id="x1-7009r9"></a></span>a.y = a.y / l <br /><span class="label"><a - id="x1-7010r10"></a></span>a.z = a.z / l - - </div> -<!--l. 177--><p class="indent" > Vector3 contains two built in functions for normalization: - <!--l. 180--> - <div class="lstlisting"><span class="label"><a - id="x1-7011r1"></a></span>a = Vector3(4,5,6) <br /><span class="label"><a - id="x1-7012r2"></a></span>a.normalize() <span -class="ecti-1000">//</span><span -class="ecti-1000"> </span><span -class="ecti-1000">in</span><span -class="cmsy-10">-</span><span -class="ecti-1000">place</span><span -class="ecti-1000"> </span><span -class="ecti-1000">normalization</span> <br /><span class="label"><a - id="x1-7013r3"></a></span>b = a.normalized() <span -class="ecti-1000">//</span><span -class="ecti-1000"> </span><span -class="ecti-1000">returns</span><span -class="ecti-1000"> </span><span -class="ecti-1000">a</span><span -class="ecti-1000"> </span><span -class="ecti-1000">copy</span><span -class="ecti-1000"> </span><span -class="ecti-1000">of</span><span -class="ecti-1000"> </span><span -class="ecti-1000">a</span><span -class="ecti-1000">,</span><span -class="ecti-1000"> </span><span -class="ecti-1000">normalized</span> - </div> -<!--l. 188--><p class="noindent" > - <h5 class="subsubsectionHead"><span class="titlemark">1.2.5 </span> <a - id="x1-80001.2.5"></a>Dot Product</h5> -<!--l. 190--><p class="noindent" >The dot product is, pheraps, the most useful operation that can be applied to 3D -vectors. In the surface, it’s multiple usages are not very obvious, but in depth it can -provide very useful information between two vectors (be it direction or just points in -space). -<!--l. 195--><p class="indent" > The dot product takes two vectors (<span -class="ecti-1000">a </span>and <span -class="ecti-1000">b </span>in the example) and returns a scalar -(single real number): -<div class="center" -> -<!--l. 198--><p class="noindent" > -<!--l. 199--><p class="noindent" ><span -class="cmmi-10">a</span><sub><span -class="cmmi-7">x</span></sub><span -class="cmmi-10">b</span><sub><span -class="cmmi-7">x</span></sub> <span -class="cmr-10">+ </span><span -class="cmmi-10">a</span><sub><span -class="cmmi-7">y</span></sub><span -class="cmmi-10">b</span><sub><span -class="cmmi-7">y</span></sub> <span -class="cmr-10">+ </span><span -class="cmmi-10">a</span><sub><span -class="cmmi-7">z</span></sub><span -class="cmmi-10">b</span><sub><span -class="cmmi-7">z</span></sub> -</div> -<!--l. 202--><p class="indent" > The same expressed in code: - <!--l. 205--> - <div class="lstlisting"><span class="label"><a - id="x1-8001r1"></a></span>a = Vector3(...) <br /><span class="label"><a - id="x1-8002r2"></a></span>b = Vector3(...) <br /><span class="label"><a - id="x1-8003r3"></a></span> <br /><span class="label"><a - id="x1-8004r4"></a></span>c = a.x<span -class="cmsy-10">*</span>b.x + a.y<span -class="cmsy-10">*</span>b.y + a.z<span -class="cmsy-10">*</span>b.z <br /><span class="label"><a - id="x1-8005r5"></a></span> <br /><span class="label"><a - id="x1-8006r6"></a></span><span -class="ecti-1000">//</span><span -class="ecti-1000"> </span><span -class="ecti-1000">using</span><span -class="ecti-1000"> </span><span -class="ecti-1000">built</span><span -class="cmsy-10">-</span><span -class="ecti-1000">in</span><span -class="ecti-1000"> </span><span -class="ecti-1000">dot</span><span -class="ecti-1000">()</span><span -class="ecti-1000"> </span><span -class="ecti-1000">function</span> <br /><span class="label"><a - id="x1-8007r7"></a></span> <br /><span class="label"><a - id="x1-8008r8"></a></span>c = a.dot(b) - </div> -<!--l. 218--><p class="indent" > The dot product presents several useful properties: - <ul class="itemize1"> - <li class="itemize">If both <span -class="ecti-1000">a </span>and <span -class="ecti-1000">b </span>parameters to a <span -class="ecti-1000">dot product </span>are direction vectors, dot - product will return positive if both point towards the same direction, - negative if both point towards opposite directions, and zero if they are - orthogonal (one is perpendicular to the other). - </li> - <li class="itemize">If both <span -class="ecti-1000">a </span>and <span -class="ecti-1000">b </span>parameters to a <span -class="ecti-1000">dot product </span>are <span -class="ecti-1000">normalized </span>direction - vectors, then the dot product will return the cosine of the angle between - them (ranging from 1 if they are equal, 0 if they are orthogonal, and -1 if - they are opposed (a == -b)). - </li> - <li class="itemize">If <span -class="ecti-1000">a </span>is a <span -class="ecti-1000">normalized </span>direction vector and <span -class="ecti-1000">b </span>is a point, the dot product will - return the distance from <span -class="ecti-1000">b </span>to the plane passing through the origin, with - normal <span -class="ecti-1000">a (see item about planes)</span> - - </li> - <li class="itemize">More uses will be presented later in this tutorial.</li></ul> -<!--l. 236--><p class="noindent" > - <h5 class="subsubsectionHead"><span class="titlemark">1.2.6 </span> <a - id="x1-90001.2.6"></a>Cross Product</h5> -<!--l. 238--><p class="noindent" >The <span -class="ecti-1000">cross product </span>also takes two vectors <span -class="ecti-1000">a </span>and <span -class="ecti-1000">b</span>, but returns another vector <span -class="ecti-1000">c </span>that is -orthogonal to the two previous ones. -<div class="center" -> -<!--l. 242--><p class="noindent" > -<!--l. 243--><p class="noindent" ><span -class="cmmi-10">c</span><sub><span -class="cmmi-7">x</span></sub> <span -class="cmr-10">= </span><span -class="cmmi-10">a</span><sub><span -class="cmmi-7">x</span></sub><span -class="cmmi-10">b</span><sub><span -class="cmmi-7">z</span></sub> <span -class="cmsy-10">- </span><span -class="cmmi-10">a</span><sub><span -class="cmmi-7">z</span></sub><span -class="cmmi-10">b</span><sub><span -class="cmmi-7">y</span></sub> -</div> -<div class="center" -> -<!--l. 246--><p class="noindent" > -<!--l. 247--><p class="noindent" ><span -class="cmmi-10">c</span><sub><span -class="cmmi-7">y</span></sub> <span -class="cmr-10">= </span><span -class="cmmi-10">a</span><sub><span -class="cmmi-7">z</span></sub><span -class="cmmi-10">b</span><sub><span -class="cmmi-7">x</span></sub> <span -class="cmsy-10">- </span><span -class="cmmi-10">a</span><sub><span -class="cmmi-7">x</span></sub><span -class="cmmi-10">b</span><sub><span -class="cmmi-7">z</span></sub> -</div> -<div class="center" -> -<!--l. 250--><p class="noindent" > -<!--l. 251--><p class="noindent" ><span -class="cmmi-10">c</span><sub><span -class="cmmi-7">z</span></sub> <span -class="cmr-10">= </span><span -class="cmmi-10">a</span><sub><span -class="cmmi-7">x</span></sub><span -class="cmmi-10">b</span><sub><span -class="cmmi-7">y</span></sub> <span -class="cmsy-10">- </span><span -class="cmmi-10">a</span><sub><span -class="cmmi-7">y</span></sub><span -class="cmmi-10">b</span><sub><span -class="cmmi-7">x</span></sub> -</div> -<!--l. 254--><p class="indent" > The same in code: - <!--l. 257--> - <div class="lstlisting"><span class="label"><a - id="x1-9001r1"></a></span>a = Vector3(...) <br /><span class="label"><a - id="x1-9002r2"></a></span>b = Vector3(...) <br /><span class="label"><a - id="x1-9003r3"></a></span>c = Vector3(...) <br /><span class="label"><a - id="x1-9004r4"></a></span> <br /><span class="label"><a - id="x1-9005r5"></a></span>c.x = a.x<span -class="cmsy-10">*</span>b.z <span -class="cmsy-10">-</span> a.z<span -class="cmsy-10">*</span>b.y <br /><span class="label"><a - id="x1-9006r6"></a></span>c.y = a.z<span -class="cmsy-10">*</span>b.x <span -class="cmsy-10">-</span> a.x<span -class="cmsy-10">*</span>b.z <br /><span class="label"><a - id="x1-9007r7"></a></span>c.z = a.x<span -class="cmsy-10">*</span>b.y <span -class="cmsy-10">-</span> a.y<span -class="cmsy-10">*</span>b.x <br /><span class="label"><a - id="x1-9008r8"></a></span> <br /><span class="label"><a - id="x1-9009r9"></a></span>// or using the built<span -class="cmsy-10">-</span>in function <br /><span class="label"><a - id="x1-9010r10"></a></span> <br /><span class="label"><a - id="x1-9011r11"></a></span>c = a.cross(b) - </div> -<!--l. 273--><p class="indent" > The <span -class="ecti-1000">cross product </span>also presents several useful properties: - <ul class="itemize1"> - <li class="itemize">As mentioned, the resulting vector <span -class="ecti-1000">c </span>is orthogonal to the input vectors <span -class="ecti-1000">a</span> - and <span -class="ecti-1000">b.</span> - </li> - <li class="itemize">Since the <span -class="ecti-1000">cross product </span>is anticommutative, swapping <span -class="ecti-1000">a </span>and <span -class="ecti-1000">b </span>will result - in a negated vector <span -class="ecti-1000">c.</span> - - </li> - <li class="itemize">if <span -class="ecti-1000">a </span>and <span -class="ecti-1000">b </span>are taken from two of the segmets <span -class="ecti-1000">AB</span>, <span -class="ecti-1000">BC </span>or <span -class="ecti-1000">CA </span>that form a - 3D triangle, the magnitude of the resulting vector divided by 2 is the area - of that triangle. - </li> - <li class="itemize">The direction of the resulting vector <span -class="ecti-1000">c </span>in the previous triangle example - determines wether the points A,B and C are arranged in clocwise or - counter-clockwise order.</li></ul> -<!--l. 287--><p class="noindent" > - <h4 class="subsectionHead"><span class="titlemark">1.3 </span> <a - id="x1-100001.3"></a>Plane</h4> -<!--l. 290--><p class="noindent" > - <h5 class="subsubsectionHead"><span class="titlemark">1.3.1 </span> <a - id="x1-110001.3.1"></a>Theory</h5> -<!--l. 292--><p class="noindent" >A plane can be considered as an infinite, flat surface that splits space in two halves, -usually one named positive and one named negative. In regular mathematics, a plane -formula is described as: -<div class="center" -> -<!--l. 296--><p class="noindent" > -<!--l. 297--><p class="noindent" ><span -class="cmmi-10">ax </span><span -class="cmr-10">+ </span><span -class="cmmi-10">by </span><span -class="cmr-10">+ </span><span -class="cmmi-10">cz </span><span -class="cmr-10">+ </span><span -class="cmmi-10">d</span> -</div> -<!--l. 300--><p class="indent" > However, in 3D programming, this form alone is often of little use. For planes to -become useful, they must be in normalized form. -<!--l. 303--><p class="indent" > A normalized plane consists of a <span -class="ecti-1000">normal vector n </span>and a <span -class="ecti-1000">distance d. </span>To normalize -a plane, a vector <span -class="ecti-1000">n </span>and distance <span -class="ecti-1000">d’ </span>are created this way: -<!--l. 307--><p class="indent" > <span -class="cmmi-10">n</span><sub><span -class="cmmi-7">x</span></sub> <span -class="cmr-10">= </span><span -class="cmmi-10">a</span> -<!--l. 309--><p class="indent" > <span -class="cmmi-10">n</span><sub><span -class="cmmi-7">y</span></sub> <span -class="cmr-10">= </span><span -class="cmmi-10">b</span> -<!--l. 311--><p class="indent" > <span -class="cmmi-10">n</span><sub><span -class="cmmi-7">z</span></sub> <span -class="cmr-10">= </span><span -class="cmmi-10">c</span> -<!--l. 313--><p class="indent" > <span -class="cmmi-10">d</span><span -class="cmsy-10">′ </span><span -class="cmr-10">= </span><span -class="cmmi-10">d</span> -<!--l. 315--><p class="indent" > Finally, both <span -class="ecti-1000">n </span>and <span -class="ecti-1000">d’ </span>are both divided by the magnitude of n. -<!--l. 318--><p class="indent" > In any case, normalizing planes is not often needed (this was mostly for -explanation purposes), and normalized planes are useful because they can be created -and used easily. -<!--l. 322--><p class="indent" > A normalized plane could be visualized as a plane pointing towards normal <span -class="ecti-1000">n,</span> -offseted by <span -class="ecti-1000">d </span>in the direction of <span -class="ecti-1000">n</span>. -<!--l. 325--><p class="indent" > In other words, take <span -class="ecti-1000">n</span>, multiply it by scalar <span -class="ecti-1000">d </span>and the resulting point will be part -of the plane. This may need some thinking, so an example with a 2D normal vector -(z is 0, so plane is orthogonal to it) is provided: -<!--l. 330--><p class="indent" > Some operations can be done with normalized planes: - - <ul class="itemize1"> - <li class="itemize">Given any point <span -class="ecti-1000">p</span>, the distance from it to a plane can be computed by - doing: n.dot(p) - d - </li> - <li class="itemize">If the resulting distance in the previous point is negative, the point is - below the plane. - </li> - <li class="itemize">Convex polygonal shapes can be defined by enclosing them in planes (the - physics engine uses this property)</li></ul> -<!--l. 340--><p class="noindent" > - <h5 class="subsubsectionHead"><span class="titlemark">1.3.2 </span> <a - id="x1-120001.3.2"></a>Implementation</h5> -<!--l. 342--><p class="noindent" >Godot Engine implements normalized planes by using the <span -class="ecti-1000">Plane </span>class. - <!--l. 346--> - <div class="lstlisting"><span class="label"><a - id="x1-12001r1"></a></span>//creates a plane with normal (0,1,0) and distance 5 <br /><span class="label"><a - id="x1-12002r2"></a></span>p = Plane( Vector3(0,1,0), 5 ) <br /><span class="label"><a - id="x1-12003r3"></a></span>// get the distance to a point <br /><span class="label"><a - id="x1-12004r4"></a></span>d = p.distance( Vector3(4,5,6) ) - </div> -<!--l. 355--><p class="noindent" > - <h4 class="subsectionHead"><span class="titlemark">1.4 </span> <a - id="x1-130001.4"></a>Matrices, Quaternions and Coordinate Systems</h4> -<!--l. 357--><p class="noindent" >It is very often needed to store the location/rotation of something. In 2D, it is often -enough to store an <span -class="ecti-1000">x,y </span>location and maybe an angle as the rotation, as that should -be enough to represent any posible position. -<!--l. 362--><p class="indent" > In 3D this becomes a little more difficult, as there is nothing as simple as an angle -to store a 3-axis rotation. -<!--l. 365--><p class="indent" > The first think that may come to mind is to use 3 angles, one for x, one for y and -one for z. However this suffers from the problem that it becomes very cumbersome to -use, as the individual rotations in each axis need to be performed one after another -(they can’t be performed at the same time), leading to a problem called “gimbal -lock”. Also, it becomes impossible to accumulate rotations (add a rotation to an -existing one). -<!--l. 373--><p class="indent" > To solve this, there are two known diferent approaches that aid in solving -rotation, <span -class="ecti-1000">Quaternions </span>and <span -class="ecti-1000">Oriented Coordinate Systems.</span> -<!--l. 378--><p class="noindent" > - <h5 class="subsubsectionHead"><span class="titlemark">1.4.1 </span> <a - id="x1-140001.4.1"></a>Oriented Coordinate Systems</h5> -<!--l. 380--><p class="noindent" ><span -class="ecti-1000">Oriented Coordinate Systems </span>(<span -class="ecti-1000">OCS</span>) are a way of representing a coordinate system -inside the cartesian coordinate system. They are mainly composed of 3 Vectors, one -for each axis. The first vector is the <span -class="ecti-1000">x </span>axis, the second the <span -class="ecti-1000">y </span>axis, and the third is the - -<span -class="ecti-1000">z </span>axis. The OCS vectors can be rotated around freely as long as they are kept the -same length (as changing the length of an axis changes its cale), and as long as they -remain orthogonal to eachother (as in, the same as the default cartesian system, -with <span -class="ecti-1000">y </span>pointing up, <span -class="ecti-1000">x </span>pointing left and <span -class="ecti-1000">z </span>pointing front, but all rotated -together). -<!--l. 391--><p class="indent" > <span -class="ecti-1000">Oriented Coordinate Systems </span>are represented in 3D programming as a 3x3 matrix, -where each row (or column, depending on the implementation) contains one of the -axis vectors. Transforming a Vector by a rotated OCS Matrix results in the rotation -being applied to the resulting vector. OCS Matrices can also be multiplied to -accumulate their transformations. -<!--l. 397--><p class="indent" > Godot Engine implements OCS Matrices in the <span -class="ecti-1000">Matrix3 </span>class: - <!--l. 400--> - <div class="lstlisting"><span class="label"><a - id="x1-14001r1"></a></span><span -class="ecti-1000">//</span><span -class="ecti-1000">create</span><span -class="ecti-1000"> </span><span -class="ecti-1000">a</span><span -class="ecti-1000"> </span><span -class="ecti-1000">3</span><span -class="ecti-1000">x3</span><span -class="ecti-1000"> </span><span -class="ecti-1000">matrix</span> <br /><span class="label"><a - id="x1-14002r2"></a></span>m = Matrix3() <br /><span class="label"><a - id="x1-14003r3"></a></span><span -class="ecti-1000">//</span><span -class="ecti-1000">rotate</span><span -class="ecti-1000"> </span><span -class="ecti-1000">the</span><span -class="ecti-1000"> </span><span -class="ecti-1000">matrix</span><span -class="ecti-1000"> </span><span -class="ecti-1000">in</span><span -class="ecti-1000"> </span><span -class="ecti-1000">the</span><span -class="ecti-1000"> </span><span -class="ecti-1000">y</span><span -class="ecti-1000"> </span><span -class="ecti-1000">axis</span><span -class="ecti-1000">,</span><span -class="ecti-1000"> </span><span -class="ecti-1000">by</span><span -class="ecti-1000"> </span><span -class="ecti-1000">45</span><span -class="ecti-1000"> </span><span -class="ecti-1000">degrees</span> <br /><span class="label"><a - id="x1-14004r4"></a></span>m.rotate( Vector3(0,1,0), Math.deg2rad(45) ) <br /><span class="label"><a - id="x1-14005r5"></a></span><span -class="ecti-1000">//</span><span -class="ecti-1000">transform</span><span -class="ecti-1000"> </span><span -class="ecti-1000">a</span><span -class="ecti-1000"> </span><span -class="ecti-1000">vector</span><span -class="ecti-1000"> </span><span -class="ecti-1000">v</span><span -class="ecti-1000"> </span><span -class="ecti-1000">(</span><span -class="ecti-1000">xform</span><span -class="ecti-1000"> </span><span -class="ecti-1000">method</span><span -class="ecti-1000"> </span><span -class="ecti-1000">is</span><span -class="ecti-1000"> </span><span -class="ecti-1000">used</span><span -class="ecti-1000">)</span> <br /><span class="label"><a - id="x1-14006r6"></a></span>v = Vector3(...) <br /><span class="label"><a - id="x1-14007r7"></a></span>result = m.xform( v ) - </div> -<!--l. 412--><p class="indent" > However, in most usage cases, one wants to store a translation together with the -rotation. For this, an <span -class="ecti-1000">origin </span>vector must be added to the OCS, thus transforming it -into a 3x4 (or 4x3, depending on preference) matrix. Godot engine implements this -functionality in the <span -class="ecti-1000">Transform </span>class: - <!--l. 419--> - <div class="lstlisting"><span class="label"><a - id="x1-14010r1"></a></span>t = Transform() <br /><span class="label"><a - id="x1-14011r2"></a></span>//rotate the transform in the y axis, by 45 degrees <br /><span class="label"><a - id="x1-14012r3"></a></span>t.rotate( Vector3(0,1,0), Math.deg2rad(45) ) <br /><span class="label"><a - id="x1-14013r4"></a></span>//translate the transform by 5 in the z axis <br /><span class="label"><a - id="x1-14014r5"></a></span>t.translate( Vector3( 0,0,5 ) ) <br /><span class="label"><a - id="x1-14015r6"></a></span>//transform a vector v (xform method is used) <br /><span class="label"><a - id="x1-14016r7"></a></span>v = Vector3(...) <br /><span class="label"><a - id="x1-14017r8"></a></span>result = t.xform( v ) - </div> -<!--l. 431--><p class="indent" > Transform contains internally a Matrix3 “basis” and a Vector3 “origin” (which can -be modified individually). -<!--l. 435--><p class="noindent" > - <h5 class="subsubsectionHead"><span class="titlemark">1.4.2 </span> <a - id="x1-150001.4.2"></a>Transform Internals</h5> -<!--l. 437--><p class="noindent" >Internally, the xform() process is quite simple, to apply a 3x3 transform to a vector, -the transposed axis vectors are used (as using the regular axis vectors will result on -an inverse of the desired transform): - <!--l. 442--> - <div class="lstlisting"><span class="label"><a - id="x1-15001r1"></a></span>m = Matrix3(...) <br /><span class="label"><a - id="x1-15002r2"></a></span>v = Vector3(..) <br /><span class="label"><a - id="x1-15003r3"></a></span>result = Vector3(...) <br /><span class="label"><a - id="x1-15004r4"></a></span> <br /><span class="label"><a - id="x1-15005r5"></a></span>x_axis = m.get_axis(0) <br /><span class="label"><a - id="x1-15006r6"></a></span>y_axis = m.get_axis(1) <br /><span class="label"><a - id="x1-15007r7"></a></span>z_axis = m.get_axis(2) <br /><span class="label"><a - id="x1-15008r8"></a></span> <br /><span class="label"><a - id="x1-15009r9"></a></span>result.x = Vector3(x_axis.x, y_axis.x, z_axis.x).dot(v) <br /><span class="label"><a - id="x1-15010r10"></a></span>result.y = Vector3(x_axis.y, y_axis.y, z_axis.y).dot(v) <br /><span class="label"><a - id="x1-15011r11"></a></span>result.z = Vector3(x_axis.z, y_axis.z, z_axis.z).dot(v) <br /><span class="label"><a - id="x1-15012r12"></a></span> <br /><span class="label"><a - id="x1-15013r13"></a></span>// is the same as doing <br /><span class="label"><a - id="x1-15014r14"></a></span> <br /><span class="label"><a - id="x1-15015r15"></a></span>result = m.xform(v) <br /><span class="label"><a - id="x1-15016r16"></a></span> <br /><span class="label"><a - id="x1-15017r17"></a></span>// if m this was a Transform(), the origin would be added <br /><span class="label"><a - id="x1-15018r18"></a></span>// like this: <br /><span class="label"><a - id="x1-15019r19"></a></span> <br /><span class="label"><a - id="x1-15020r20"></a></span>result = result + t.get_origin() - </div> -<!--l. 468--><p class="noindent" > - <h5 class="subsubsectionHead"><span class="titlemark">1.4.3 </span> <a - id="x1-160001.4.3"></a>Using The Transform</h5> -<!--l. 470--><p class="noindent" >So, it is often desired apply sucessive operations to a transformation. For example, -let’s a assume that there is a turtle sitting at the origin (the turtle is a logo reference, - -for those familiar with it). The <span -class="ecti-1000">y </span>axis is up, and the the turtle’s nose is pointing -towards the <span -class="ecti-1000">z </span>axis. -<!--l. 476--><p class="indent" > The turtle (like many other animals, or vehicles!) can only walk towards the -direction it’s looking at. So, moving the turtle around a little should be something -like this: - <!--l. 481--> - <div class="lstlisting"><span class="label"><a - id="x1-16001r1"></a></span><span -class="ecti-1000">//</span><span -class="ecti-1000"> </span><span -class="ecti-1000">turtle</span><span -class="ecti-1000"> </span><span -class="ecti-1000">at</span><span -class="ecti-1000"> </span><span -class="ecti-1000">the</span><span -class="ecti-1000"> </span><span -class="ecti-1000">origin</span> <br /><span class="label"><a - id="x1-16002r2"></a></span>turtle = Transform() <br /><span class="label"><a - id="x1-16003r3"></a></span><span -class="ecti-1000">//</span><span -class="ecti-1000"> </span><span -class="ecti-1000">turtle</span><span -class="ecti-1000"> </span><span -class="ecti-1000">will</span><span -class="ecti-1000"> </span><span -class="ecti-1000">walk</span><span -class="ecti-1000"> </span><span -class="ecti-1000">5</span><span -class="ecti-1000"> </span><span -class="ecti-1000">units</span><span -class="ecti-1000"> </span><span -class="ecti-1000">in</span><span -class="ecti-1000"> </span><span -class="ecti-1000">z</span><span -class="ecti-1000"> </span><span -class="ecti-1000">axis</span> <br /><span class="label"><a - id="x1-16004r4"></a></span>turtle.translate( Vector3(0,0,5) ) <br /><span class="label"><a - id="x1-16005r5"></a></span><span -class="ecti-1000">//</span><span -class="ecti-1000"> </span><span -class="ecti-1000">turtle</span><span -class="ecti-1000"> </span><span -class="ecti-1000">eyes</span><span -class="ecti-1000"> </span><span -class="ecti-1000">a</span><span -class="ecti-1000"> </span><span -class="ecti-1000">lettuce</span><span -class="ecti-1000"> </span><span -class="ecti-1000">3</span><span -class="ecti-1000"> </span><span -class="ecti-1000">units</span><span -class="ecti-1000"> </span><span -class="ecti-1000">away</span><span -class="ecti-1000">,</span><span -class="ecti-1000"> </span><span -class="ecti-1000">will</span><span -class="ecti-1000"> </span><span -class="ecti-1000">rotate</span><span -class="ecti-1000"> </span><span -class="ecti-1000">45</span><span -class="ecti-1000"> </span><span -class="ecti-1000">degrees</span><span -class="ecti-1000"> </span><span -class="ecti-1000">right</span> <br /><span class="label"><a - id="x1-16006r6"></a></span>turtle.rotate( Vector3(0,1,0), Math.deg2rad(45) ) <br /><span class="label"><a - id="x1-16007r7"></a></span><span -class="ecti-1000">//</span><span -class="ecti-1000"> </span><span -class="ecti-1000">turtle</span><span -class="ecti-1000"> </span><span -class="ecti-1000">approaches</span><span -class="ecti-1000"> </span><span -class="ecti-1000">the</span><span -class="ecti-1000"> </span><span -class="ecti-1000">lettuce</span> <br /><span class="label"><a - id="x1-16008r8"></a></span>turtle.translate( Vector3(0,0,5) ) <br /><span class="label"><a - id="x1-16009r9"></a></span><span -class="ecti-1000">//</span><span -class="ecti-1000"> </span><span -class="ecti-1000">happy</span><span -class="ecti-1000"> </span><span -class="ecti-1000">turtle</span><span -class="ecti-1000"> </span><span -class="ecti-1000">over</span><span -class="ecti-1000"> </span><span -class="ecti-1000">lettuce</span><span -class="ecti-1000"> </span><span -class="ecti-1000">is</span><span -class="ecti-1000"> </span><span -class="ecti-1000">at</span> <br /><span class="label"><a - id="x1-16010r10"></a></span>print(turtle.get_origin()) - </div> -<!--l. 496--><p class="indent" > As can be seen, every new action the turtle takes is based on the previous one it -took. Had the order of actions been different and the turtle would have never reached -the lettuce. -<!--l. 500--><p class="indent" > Transforms are just that, a mean of “accumulating” rotation, translation, scale, -etc. -<!--l. 504--><p class="noindent" > - <h5 class="subsubsectionHead"><span class="titlemark">1.4.4 </span> <a - id="x1-170001.4.4"></a>A Warning about Numerical Precision</h5> -<!--l. 506--><p class="noindent" >Performing several actions over a transform will slowly and gradually lead to -precision loss (objects that draw according to a transform may get jittery, bigger, -smaller, skewed, etc). This happens due to the nature of floating point numbers. if -transforms/matrices are created from other kind of values (like a position and -some angular rotation) this is not needed, but if has been accumulating -transformations and was never recreated, it can be normalized by calling the -.orthonormalize() built-in function. This function has little cost and calling it every -now and then will avoid the effects from precision loss to become visible. - -</body></html> - - - diff --git a/doc/html/tutorial01/tutorial0x.png b/doc/html/tutorial01/tutorial0x.png Binary files differdeleted file mode 100644 index a0ed4f53ff..0000000000 --- a/doc/html/tutorial01/tutorial0x.png +++ /dev/null diff --git a/doc/html/tutorial01/tutorial1x.png b/doc/html/tutorial01/tutorial1x.png Binary files differdeleted file mode 100644 index 80f0d099f7..0000000000 --- a/doc/html/tutorial01/tutorial1x.png +++ /dev/null diff --git a/doc/html/tutorial01/tutorial2x.png b/doc/html/tutorial01/tutorial2x.png Binary files differdeleted file mode 100644 index 76c502b6da..0000000000 --- a/doc/html/tutorial01/tutorial2x.png +++ /dev/null diff --git a/doc/html/tutorial01/tutorial3x.png b/doc/html/tutorial01/tutorial3x.png Binary files differdeleted file mode 100644 index 8431e9d15c..0000000000 --- a/doc/html/tutorial01/tutorial3x.png +++ /dev/null diff --git a/doc/html/tutorial01/tutorial4x.png b/doc/html/tutorial01/tutorial4x.png Binary files differdeleted file mode 100644 index 1ce7a2bb45..0000000000 --- a/doc/html/tutorial01/tutorial4x.png +++ /dev/null diff --git a/doc/make_doc.sh b/doc/make_doc.sh deleted file mode 100644 index a76f568bfc..0000000000 --- a/doc/make_doc.sh +++ /dev/null @@ -1,17 +0,0 @@ -#! /bin/bash -here="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )" -godotHome=$(dirname "$here") -docTarget=${here}/html/class_list -toolsRoot=${godotHome}/tools - -throw() { - echo "$@" >&2 - exit 1 -} - -[ -d "$docTarget" ] || mkdir -p "$docTarget" || throw "Could not create doc target $docTarget" - -cd "$docTarget" -python ${toolsRoot}/docdump/makehtml.py -multipage ${here}/base/classes.xml -cd "$here" - diff --git a/doc/notes.txt b/doc/notes.txt deleted file mode 100644 index 39c03ca4c5..0000000000 --- a/doc/notes.txt +++ /dev/null @@ -1,20 +0,0 @@ -
-in FileDialog file_selected -> file_activated
-focus script/shader editor when gaining focus
-detect if errors in editor and don't allow play
-
-
--tree of files (all recognized extensions)
-
-*export: *keep|export|bundle
-*options: [make binary for xnl], then options for each filetype (texture compress method, etc)
-
-
-config.h deberia teber varias cosas de plataforma
-
-_FORCE_INLINE_
-copymem
-ftoi
-defines de funciones matematicas
-
-
diff --git a/doc/phys_engine.png b/doc/phys_engine.png Binary files differdeleted file mode 100644 index 15539d47d7..0000000000 --- a/doc/phys_engine.png +++ /dev/null diff --git a/doc/squirrel.lyx b/doc/squirrel.lyx deleted file mode 100644 index 05270c1b8f..0000000000 --- a/doc/squirrel.lyx +++ /dev/null @@ -1,984 +0,0 @@ -#LyX 2.0 created this file. For more info see http://www.lyx.org/ -\lyxformat 413 -\begin_document -\begin_header -\textclass article -\use_default_options true -\maintain_unincluded_children false -\language english -\language_package default -\inputencoding auto -\fontencoding global -\font_roman default -\font_sans default -\font_typewriter default -\font_default_family default -\use_non_tex_fonts false -\font_sc false -\font_osf false -\font_sf_scale 100 -\font_tt_scale 100 - -\graphics default -\default_output_format default -\output_sync 0 -\bibtex_command default -\index_command default -\paperfontsize default -\use_hyperref false -\papersize default -\use_geometry false -\use_amsmath 1 -\use_esint 1 -\use_mhchem 1 -\use_mathdots 1 -\cite_engine basic -\use_bibtopic false -\use_indices false -\paperorientation portrait -\suppress_date false -\use_refstyle 1 -\index Index -\shortcut idx -\color #008000 -\end_index -\secnumdepth 3 -\tocdepth 3 -\paragraph_separation indent -\paragraph_indentation default -\quotes_language english -\papercolumns 1 -\papersides 1 -\paperpagestyle default -\tracking_changes false -\output_changes false -\html_math_output 0 -\html_css_as_file 0 -\html_be_strict false -\end_header - -\begin_body - -\begin_layout Title -Squirrel Usage in Godot -\end_layout - -\begin_layout Section -Introduction -\end_layout - -\begin_layout Standard -Squirrel is a nice scripting language. - It's sort of a mix between Lua, Java and JavaScript and ends up being easy - to learn for most programmers. - It has more language features than GDScript but it's also slower, more - limited and not as well integrated. - This guide will explain how Squirrel is integrated to Godot and all the - quirks that are needed to know in order to use it properly. -\end_layout - -\begin_layout Section -Enabling Squirrel -\end_layout - -\begin_layout Standard -Squirrel may not be enabled by default in a Godot build. - To enable it, execute SCons with the following parameters: -\end_layout - -\begin_layout Standard -\begin_inset listings -inline false -status open - -\begin_layout Plain Layout - -shell$ scons squirrel=yes <target_binary> -\end_layout - -\end_inset - - -\end_layout - -\begin_layout Section -Documentation -\end_layout - -\begin_layout Standard -Godot utilizes Squirrel 2.2. - Documentation can be found at: -\begin_inset CommandInset href -LatexCommand href -target "http://squirrel-lang.org/#documentation" - -\end_inset - - -\end_layout - -\begin_layout Section -Class Files -\end_layout - -\begin_layout Standard -Unless writing a library, Godot expects a class for scripting an object. - Since a Squirrel source file can contain many classes, the main class must - be returned. - The following is an example of extending a button: -\end_layout - -\begin_layout Standard -\begin_inset listings -inline false -status open - -\begin_layout Plain Layout - -class MyButton extends Button { -\end_layout - -\begin_layout Plain Layout - -\end_layout - -\begin_layout Plain Layout - -\end_layout - -\begin_layout Plain Layout - - constructor() { -\end_layout - -\begin_layout Plain Layout - - // ALWAYS call parent constructor -\end_layout - -\begin_layout Plain Layout - - Button.constructor() -\end_layout - -\begin_layout Plain Layout - - } -\end_layout - -\begin_layout Plain Layout - -} -\end_layout - -\begin_layout Plain Layout - -\end_layout - -\begin_layout Plain Layout - -return MyButton // main class returned -\end_layout - -\end_inset - - -\end_layout - -\begin_layout Standard -Additionally, classes are all copied to the root table, so all class names - in scripts must be different if they are attempted to be loaded simultaneously. - The same can be said for any other globals declared in the script. - -\end_layout - -\begin_layout Standard -Finally, squirrel scripts must be saved with the .nut or .sq extensions (both - are recognized). -\end_layout - -\begin_layout Section -Including Other Scripts -\end_layout - -\begin_layout Standard -Other scripts can be included with the include() directive. - Full and relative paths are supported. - When included, the classes and globals are moved to the root table, so - they become immediately available. - Constants, however, are only inlined in the current class on load, so Squirrel - does not make them available. - Example of including scripts: -\end_layout - -\begin_layout Standard -\begin_inset listings -inline false -status open - -\begin_layout Plain Layout - -include("my_button.nut") # // relative to current script, expected to be - in the same path -\end_layout - -\begin_layout Plain Layout - -include("res://buttons/my_button.nut") // using resource path -\end_layout - -\end_inset - - -\end_layout - -\begin_layout Section -Built-In Types -\end_layout - -\begin_layout Standard -There are some small differences between the Built-In types in Godot and - the ones in Squirrel, so the documentation will not match. - The differences are documented here. -\end_layout - -\begin_layout Standard -An attempt will be made to document everything here,but if in doubt about - bindings on built-in types, you can always take a loot at the bindings - source file in script/squirrel/sq_bind_types.cpp. -\end_layout - -\begin_layout Standard -Built-In Types in Squirrel are passed by reference (unlike by value like - in GD). - They also don't need to be freed. -\end_layout - -\begin_layout Subsection -AABB -\end_layout - -\begin_layout Standard -\begin_inset Quotes eld -\end_inset - -pos -\begin_inset Quotes erd -\end_inset - -, -\begin_inset Quotes eld -\end_inset - -size -\begin_inset Quotes erd -\end_inset - - and -\begin_inset Quotes eld -\end_inset - -end -\begin_inset Quotes erd -\end_inset - - are not available Use get_pos()/set_pos and get_size()/set_size(). -\end_layout - -\begin_layout Subsection -InputEvent -\end_layout - -\begin_layout Standard -InputEvent is a single datatype and contains everything. - Use only the fields meant for the event type: -\end_layout - -\begin_layout Standard -\begin_inset listings -inline false -status open - -\begin_layout Plain Layout - -//for mouse motion and button -\end_layout - -\begin_layout Plain Layout - -int mouse_x -\end_layout - -\begin_layout Plain Layout - -int mouse_y -\end_layout - -\begin_layout Plain Layout - -int mouse_button_mask -\end_layout - -\begin_layout Plain Layout - -int mouse_global_x -\end_layout - -\begin_layout Plain Layout - -int mouse_global_y -\end_layout - -\begin_layout Plain Layout - -\end_layout - -\begin_layout Plain Layout - -//for mouse button -\end_layout - -\begin_layout Plain Layout - -\end_layout - -\begin_layout Plain Layout - -int mouse_button_index -\end_layout - -\begin_layout Plain Layout - -bool mouse_button_pressed -\end_layout - -\begin_layout Plain Layout - -bool mouse_button_doubleclick -\end_layout - -\begin_layout Plain Layout - -\end_layout - -\begin_layout Plain Layout - -//for mouse motion -\end_layout - -\begin_layout Plain Layout - -\end_layout - -\begin_layout Plain Layout - -int mouse_motion_x -\end_layout - -\begin_layout Plain Layout - -int mouse_motion_y -\end_layout - -\begin_layout Plain Layout - -\end_layout - -\begin_layout Plain Layout - -//for keyboard -\end_layout - -\begin_layout Plain Layout - -\end_layout - -\begin_layout Plain Layout - -int key_scancode -\end_layout - -\begin_layout Plain Layout - -int key_unicode -\end_layout - -\begin_layout Plain Layout - -bool key_pressed -\end_layout - -\begin_layout Plain Layout - -bool key_echo -\end_layout - -\begin_layout Plain Layout - -\end_layout - -\begin_layout Plain Layout - -//for keyboard and mouse -\end_layout - -\begin_layout Plain Layout - -\end_layout - -\begin_layout Plain Layout - -bool mod_alt -\end_layout - -\begin_layout Plain Layout - -bool mod_shift -\end_layout - -\begin_layout Plain Layout - -bool mod_meta -\end_layout - -\begin_layout Plain Layout - -bool mod_control -\end_layout - -\begin_layout Plain Layout - -\end_layout - -\begin_layout Plain Layout - -//joy button -\end_layout - -\begin_layout Plain Layout - -\end_layout - -\begin_layout Plain Layout - -int joy_button_index -\end_layout - -\begin_layout Plain Layout - -bool joy_button_pressed -\end_layout - -\begin_layout Plain Layout - -\end_layout - -\begin_layout Plain Layout - -//joy axis -\end_layout - -\begin_layout Plain Layout - -\end_layout - -\begin_layout Plain Layout - -int joy_axis -\end_layout - -\begin_layout Plain Layout - -float joy_axis_value -\end_layout - -\begin_layout Plain Layout - -\end_layout - -\begin_layout Plain Layout - -//screen drag and touch -\end_layout - -\begin_layout Plain Layout - -\end_layout - -\begin_layout Plain Layout - -int screen_index -\end_layout - -\begin_layout Plain Layout - -int screen_x -\end_layout - -\begin_layout Plain Layout - -int screen_y -\end_layout - -\begin_layout Plain Layout - -\end_layout - -\begin_layout Plain Layout - -//screen touch -\end_layout - -\begin_layout Plain Layout - -\end_layout - -\begin_layout Plain Layout - -int screen_index -\end_layout - -\begin_layout Plain Layout - -\end_layout - -\begin_layout Plain Layout - -//action -\end_layout - -\begin_layout Plain Layout - -\end_layout - -\begin_layout Plain Layout - -int action_id -\end_layout - -\begin_layout Plain Layout - -bool action_pressed -\end_layout - -\begin_layout Plain Layout - -\end_layout - -\end_inset - - -\end_layout - -\begin_layout Subsection -Matrix3 -\end_layout - -\begin_layout Standard -x,y,z member vectors are not available. - Use get_row() and set_row() instead. - Individual float values of the matrix are available as swizzle masks such - as xxy, xyz, zzx, etc. -\end_layout - -\begin_layout Standard -Additional in-place versions of some functions are available: transpose(), - invert(), rotate(), scale(), orthonormalize(). -\end_layout - -\begin_layout Subsection -Transform -\end_layout - -\begin_layout Standard -\begin_inset Quotes eld -\end_inset - -basis -\begin_inset Quotes erd -\end_inset - - and -\begin_inset Quotes eld -\end_inset - -origin -\begin_inset Quotes erd -\end_inset - - members are not available. - Use get_basis()/set_basis() and get_origin()/set_origin() instead. - Additional in-place versions of some functions are available: invert(), - affine_invert(), orthonormalize(), rotate(), translate(), scale(). -\end_layout - -\begin_layout Standard -Vector2 -\end_layout - -\begin_layout Subsection -Plane -\end_layout - -\begin_layout Standard -\begin_inset Quotes eld -\end_inset - -normal -\begin_inset Quotes erd -\end_inset - - member vector is not available. - Use get_normal(), set_normal() instead. -\end_layout - -\begin_layout Subsection -Rect2 -\end_layout - -\begin_layout Standard -\begin_inset Quotes eld -\end_inset - -pos -\begin_inset Quotes erd -\end_inset - -, -\begin_inset Quotes eld -\end_inset - -size -\begin_inset Quotes erd -\end_inset - - and -\begin_inset Quotes eld -\end_inset - -end -\begin_inset Quotes erd -\end_inset - - are not available Use get_pos()/set_pos and get_size()/set_size(). -\end_layout - -\begin_layout Subsection -Native Arrays -\end_layout - -\begin_layout Standard -Native arrays such as RawArray, IntArray,StringArray, etc are not supported. - Use regular squirrel arrays instead, since conversion to/from them will - happen automatically. -\end_layout - -\begin_layout Subsection -Math Functions -\end_layout - -\begin_layout Standard -Math functions are inside the Math namespace in Squirrel. - For example Math.sin , Math.PI, Math.atan2(). -\end_layout - -\begin_layout Subsection -Native Types -\end_layout - -\begin_layout Standard -Array, Dictionary and NodePath are not available. - Use a native array, table and string respectively. -\end_layout - -\begin_layout Section -_get , _set -\end_layout - -\begin_layout Standard -_get and _set are reserved in Squirrel, for overriding Godot Object property - getter/setter, use _get_property and _set_property. -\end_layout - -\begin_layout Section -Member Export -\end_layout - -\begin_layout Standard -Simple exporting of members (so far only integer, floating point and string - are supported) is supported by the @export extension. - It is used like this: -\end_layout - -\begin_layout Standard -\begin_inset listings -inline false -status open - -\begin_layout Plain Layout - -class MyButton extends Button { -\end_layout - -\begin_layout Plain Layout - -\end_layout - -\begin_layout Plain Layout - - aprop=1 // @export -\end_layout - -\begin_layout Plain Layout - - bprop=2.0 // @export -\end_layout - -\begin_layout Plain Layout - - cprop="3" // @export -\end_layout - -\begin_layout Plain Layout - -\end_layout - -\begin_layout Plain Layout - - //these will be available to the property editor, and will be loaded/saved - with the scene. -\end_layout - -\begin_layout Plain Layout - -} -\end_layout - -\end_inset - - -\end_layout - -\begin_layout Section -Always Enabled Scripts -\end_layout - -\begin_layout Standard -Scripts are not enabled in the editor by default. - To enable a script always, add an @always_enabled comment. - Example: -\end_layout - -\begin_layout Standard -\begin_inset listings -inline false -status open - -\begin_layout Plain Layout - -//@always_enabled -\end_layout - -\begin_layout Plain Layout - -\end_layout - -\begin_layout Plain Layout - -class MyButton extends Button { -\end_layout - -\begin_layout Plain Layout - -\end_layout - -\begin_layout Plain Layout - -... -\end_layout - -\end_inset - - -\end_layout - -\begin_layout Section -Threads -\end_layout - -\begin_layout Standard -Thread support in Squirrel is very poor. - This is because of the stack-based nature of the language implementation. - Since godot can run in multiple threads, it will forcibily lock the whole - VM when accessed from multiple threads, which will result in degraded performan -ce. - Creating user threads in Squirrel is definitely not recomended, as it may - completely lock the main thread. -\end_layout - -\begin_layout Section -References -\end_layout - -\begin_layout Standard -Godot has a built-in reference counted type used in conjunction with a template - (objects that inherit the -\begin_inset Quotes eld -\end_inset - -Reference -\begin_inset Quotes erd -\end_inset - - class). - Since Squirrel also uses reference counting, it becomes impossible for - such types in godot to contain a script, because it would result in an - un-breakable reference cycle. - To avoid this, a Ref() class was created in Squirrel. - -\end_layout - -\begin_layout Standard -When calling Godot API functions, returned references are wrapped inside - Ref() transparently, but the problem arises when creating a Reference-derived - object from the code. - In such cases, the reference must be wrapped manually like this: -\end_layout - -\begin_layout Standard -\begin_inset listings -inline false -status open - -\begin_layout Plain Layout - -local f = Ref( File() ) -\end_layout - -\begin_layout Plain Layout - -local err = f.open("hello.txt",File.READ) -\end_layout - -\end_inset - - -\end_layout - -\begin_layout Standard -Anything not a reference that inherits from Object can be freed manually - by calling .free(), just like in GDScript. - Object classes are in itself weak references to engine objects, and their - validity can be checked by calling the -\begin_inset Quotes eld -\end_inset - -has_instance() -\begin_inset Quotes erd -\end_inset - - built-in method. -\end_layout - -\begin_layout Section -Unicode -\end_layout - -\begin_layout Standard -Squirrel source code is supposed to support Unicode, but the implementation - is very broken (Squirrel attempts to use 16 bit chars no matter what, making - it incompatible when the host OS is 32 bit, like Linux). - Squirrel source code is parsed as UTF-8, and strings also contain UTF-8. - Wide char access in strings is not supported. -\end_layout - -\begin_layout Section -Debugging -\end_layout - -\begin_layout Standard -Squirrel is well integrated into the Godot debugger. - To run the project in debug mode, execute the godot binary with the -debug - argument. - Godot will break on squirrel errors and allow the programmer to debug. -\end_layout - -\begin_layout Section -Utility Functions -\end_layout - -\begin_layout Standard -There are a few squirrel-only utility functions available: -\end_layout - -\begin_layout Subsection -print(value[,value]) -\end_layout - -\begin_layout Standard -Print stuff to stdout. -\end_layout - -\begin_layout Subsection -dofile(path) -\end_layout - -\begin_layout Standard -Execute a squirrel script file and return whatever the file returns. - Not recommended to use in production because it can't be optimized. -\end_layout - -\begin_layout Subsection -nativeref(var) -\end_layout - -\begin_layout Standard -Convert any squirrel type to an engine type. - When this type returns to squirrel, it's converted back. - This is useful to add to Godot callbacks to ensure that the datatype is - not converted. -\end_layout - -\begin_layout Subsection -unicode_split(string) -\end_layout - -\begin_layout Standard -Split an unicode string (utf8) into an array of widechars. - Useful since there is no wide char access from Squirrel. -\end_layout - -\begin_layout Subsection -breakpoint() -\end_layout - -\begin_layout Standard -Stop the debugger when reaches here (when run inside the debugger). -\end_layout - -\begin_layout Subsection -backtrace() -\end_layout - -\begin_layout Standard -Print a backtrace of the call stack. -\end_layout - -\begin_layout Subsection -tr(text) -\end_layout - -\begin_layout Standard -Translate text (use string lookup in Godot translation system). -\end_layout - -\begin_layout Subsection -printerr(text) -\end_layout - -\begin_layout Standard -Print a string to stderr. -\end_layout - -\end_body -\end_document diff --git a/doc/todo.txt b/doc/todo.txt deleted file mode 100644 index 511b5dbbe2..0000000000 --- a/doc/todo.txt +++ /dev/null @@ -1,39 +0,0 @@ --Fisica 2D - *terminar constraints - *terminar queries - *desactivar on suspend - -bugs supongo? - --Fisica 3D - -portar engine 2D a 3D mayoritariamente (si puedo esperar, mejor) - -hacer que skeletons se vuelvan ragdolls de alguna forma - -hacer bien lo de enganchar cosas a huesos de esqueleto - --GUI - - Tree necesita resizear desde los headers - --Escena 3D - -Deshabilitar 3D (Opcional en compilacion) - -Particulas 3D - -Heightmaps - -Arreglar fixed pipeline - -arreglar glow y ssao - --Editor codigo - -Editor de codigo (esta, pero esta lleno de bugs) - -Debugger (esta, pero hay que integrar bien) - --UI General - -Cambiar lugar el tema de resources porque es MUY poco intuitivo - -Tal vez arreglar un poquito el theme y la estetica (para release, low priority) - -Run deberia correr la escena main - -new script deberia dar opcion de crear en disco - -los scripts de deberian mantener abiertos al abrir otra escena - - - --Settings - -Hacer pantalla de optimizacion general del proyecto - --A futuro: - -Scripting Propio - -Portar a DX9/GL3
\ No newline at end of file diff --git a/doc/tools/doc_merge.py b/doc/tools/doc_merge.py new file mode 100644 index 0000000000..6cc7019324 --- /dev/null +++ b/doc/tools/doc_merge.py @@ -0,0 +1,211 @@ +#!/usr/bin/python +# -*- coding: utf-8 -*- + +import sys +import xml.etree.ElementTree as ET + + +tree = ET.parse(sys.argv[1]) +old_doc=tree.getroot() + +tree = ET.parse(sys.argv[2]) +new_doc=tree.getroot() + +f = file(sys.argv[3],"wb") +tab=0 + +old_classes={} + +def write_string(_f, text,newline=True): + for t in range(tab): + _f.write("\t") + _f.write(text) + if (newline): + _f.write("\n") + +def escape(ret): + ret=ret.replace("&","&"); + ret=ret.replace("<",">"); + ret=ret.replace(">","<"); + ret=ret.replace("'","'"); + ret=ret.replace("\"","""); + return ret + + +def inc_tab(): + global tab + tab+=1 + +def dec_tab(): + global tab + tab-=1 + +write_string(f,'<?xml version="1.0" encoding="UTF-8" ?>') +write_string(f,'<doc version="'+new_doc.attrib["version"]+'">') + +def get_tag(node,name): + tag="" + if (name in node.attrib): + tag=' '+name+'="'+escape(node.attrib[name])+'" ' + return tag + +def find_method_descr(old_class,name): + + methods = old_class.find("methods") + if(methods!=None and len(list(methods))>0): + for m in list(methods): + if (m.attrib["name"]==name): + description=m.find("description") + if (description!=None and description.text.strip()!=""): + return description.text + + return None + +def find_signal_descr(old_class,name): + + signals = old_class.find("signals") + if(signals!=None and len(list(signals))>0): + for m in list(signals): + if (m.attrib["name"]==name): + description=m.find("description") + if (description!=None and description.text.strip()!=""): + return description.text + + return None + +def find_constant_descr(old_class,name): + + if (old_class==None): + return None + constants = old_class.find("constants") + if(constants!=None and len(list(constants))>0): + for m in list(constants): + if (m.attrib["name"]==name): + if (m.text.strip()!=""): + return m.text + return None + +def write_class(c): + class_name = c.attrib["name"] + print("Parsing Class: "+class_name) + if (class_name in old_classes): + old_class=old_classes[class_name] + else: + old_class=None + + + category=get_tag(c,"category") + inherits=get_tag(c,"inherits") + write_string(f,'<class name="'+class_name+'" '+category+inherits+'>') + inc_tab() + + write_string(f,"<brief_description>") + + if (old_class!=None): + old_brief_descr=old_class.find("brief_description") + if (old_brief_descr!=None): + write_string(f,escape(old_brief_descr.text.strip())) + + + write_string(f,"</brief_description>") + + write_string(f,"<description>") + if (old_class!=None): + old_descr=old_class.find("description") + if (old_descr!=None): + write_string(f,escape(old_descr.text.strip())) + + write_string(f,"</description>") + + methods = c.find("methods") + if(methods!=None and len(list(methods))>0): + + write_string(f,"<methods>") + inc_tab() + + for m in list(methods): + qualifiers=get_tag(m,"qualifiers") + + write_string(f,'<method name="'+escape(m.attrib["name"])+'" ' +qualifiers+'>') + inc_tab() + + for a in list(m): + if (a.tag=="return"): + typ=get_tag(a,"type") + write_string(f,'<return'+typ+'>'); + write_string(f,'</return>'); + elif (a.tag=="argument"): + + default=get_tag(a,"default") + + write_string(f,'<argument index="'+a.attrib["index"]+'" name="'+escape(a.attrib["name"])+'" type="'+a.attrib["type"]+'"' +default+'>'); + write_string(f,'</argument>'); + + write_string(f,'<description>'); + if (old_class!=None): + old_method_descr=find_method_descr(old_class,m.attrib["name"]) + if (old_method_descr): + write_string(f,escape(escape(old_method_descr.strip()))) + + write_string(f,'</description>'); + dec_tab() + write_string(f,"</method>") + dec_tab() + write_string(f,"</methods>") + + signals = c.find("signals") + if(signals!=None and len(list(signals))>0): + + write_string(f,"<signals>") + inc_tab() + + for m in list(signals): + + write_string(f,'<signal name="'+escape(m.attrib["name"])+'">') + inc_tab() + + for a in list(m): + if (a.tag=="argument"): + + write_string(f,'<argument index="'+a.attrib["index"]+'" name="'+escape(a.attrib["name"])+'" type="'+a.attrib["type"]+'">'); + write_string(f,'</argument>'); + + write_string(f,'<description>'); + if (old_class!=None): + old_signal_descr=find_signal_descr(old_class,m.attrib["name"]) + if (old_signal_descr): + write_string(f,escape(old_signal_descr.strip())) + write_string(f,'</description>'); + dec_tab() + write_string(f,"</signal>") + dec_tab() + write_string(f,"</signals>") + + constants = c.find("constants") + if(constants!=None and len(list(constants))>0): + + write_string(f,"<constants>") + inc_tab() + + for m in list(constants): + + write_string(f,'<constant name="'+escape(m.attrib["name"])+'" value="'+m.attrib["value"]+'">') + old_constant_descr=find_constant_descr(old_class,m.attrib["name"]) + if (old_constant_descr): + write_string(f,escape(old_constant_descr.strip())) + write_string(f,"</constant>") + + dec_tab() + write_string(f,"</constants>") + + dec_tab() + write_string(f,"</class>") + +for c in list(old_doc): + old_classes[c.attrib["name"]]=c + +for c in list(new_doc): + write_class(c) +write_string(f,'</doc>\n') + + diff --git a/doc/tools/locales/es/LC_MESSAGES/makedocs.mo b/doc/tools/locales/es/LC_MESSAGES/makedocs.mo Binary files differnew file mode 100644 index 0000000000..8d7ea2689e --- /dev/null +++ b/doc/tools/locales/es/LC_MESSAGES/makedocs.mo diff --git a/doc/tools/locales/es/LC_MESSAGES/makedocs.po b/doc/tools/locales/es/LC_MESSAGES/makedocs.po new file mode 100644 index 0000000000..82115dd897 --- /dev/null +++ b/doc/tools/locales/es/LC_MESSAGES/makedocs.po @@ -0,0 +1,142 @@ +# Translations template for PROJECT. +# Copyright (C) 2015 ORGANIZATION +# This file is distributed under the same license as the PROJECT project. +# FIRST AUTHOR <EMAIL@ADDRESS>, 2015. +# +msgid "" +msgstr "" +"Project-Id-Version: makedocs\n" +"Report-Msgid-Bugs-To: EMAIL@ADDRESS\n" +"POT-Creation-Date: 2015-10-07 11:47-0600\n" +"PO-Revision-Date: 2015-10-07 13:10-0600\n" +"Last-Translator: Jorge Araya Navarro <elcorreo@deshackra.com>\n" +"Language-Team: \n" +"Language: es\n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: 8bit\n" +"Generated-By: Babel 2.0\n" +"X-Generator: Poedit 1.8.4\n" +"Plural-Forms: nplurals=2; plural=(n != 1);\n" + +#: makedocs.py:74 +msgid "" +"\"<code>{gclass}</code>(Go to page of class {gclass})\":/class_{lkclass}" +msgstr "" +"\"<code>{gclass}</code>(Ir a la pagina de la clase {gclass})\":/" +"class_{lkclass}" + +#: makedocs.py:76 +msgid "" +"\"<code>{gclass}.{method}</code>(Go to page {gclass}, section {method})\":/" +"class_{lkclass}#{lkmethod}" +msgstr "" +"\"<code>{gclass}.{method}</code>(Ir a la pagina {gclass}, sección " +"{method})\":/class_{lkclass}#{lkmethod}" + +#: makedocs.py:79 +msgid "\"<code>{method}</code>(Jump to method {method})\":#{lkmethod}" +msgstr "\"<code>{method}</code>(Saltar al método {method})\":#{lkmethod}" + +#: makedocs.py:81 +msgid " \"{rtype}(Go to page of class {rtype})\":/class_{link} " +msgstr " \"{rtype}(Ir a la pagina de la clase {rtype})\":/class_{link} " + +#: makedocs.py:82 +msgid "" +"\"*{funcname}*(Jump to description for node {funcname})\":#{link} <b>(</b> " +msgstr "" +"\"*{funcname}*(Saltar a la descripción para el nodo {funcname})\":#{link} " +"<b>(</b> " + +#: makedocs.py:87 +msgid "h4. Inherits: " +msgstr "h4. Hereda de: " + +#: makedocs.py:232 +msgid "<doc>'s version attribute missing" +msgstr "El atributo version de <doc> no existe" + +#: makedocs.py:246 +msgid "|_. Index symbol |_. Class name |_. Index symbol |_. Class name |\n" +msgstr "" +"|_. Índice de símbolo |_. Nombre de la clase |_. Índice de símbolo |_. " +"Nombre de la clase |\n" + +#: makedocs.py:305 +msgid "" +"h4. Category: {}\n" +"\n" +msgstr "" +"h4. Categoría: {}\n" +"\n" + +#: makedocs.py:310 +msgid "" +"h2. Brief Description\n" +"\n" +msgstr "" +"h2. Descripción breve\n" +"\n" + +#: makedocs.py:312 +msgid "" +"\"read more\":#more\n" +"\n" +msgstr "" +"\"Leer más\":#more\n" +"\n" + +#: makedocs.py:317 +msgid "" +"\n" +"h3. Member Functions\n" +"\n" +msgstr "" +"\n" +"h3. Funciones miembro\n" +"\n" + +#: makedocs.py:323 +msgid "" +"\n" +"h3. Signals\n" +"\n" +msgstr "" +"\n" +"h3. Señales\n" +"\n" + +#: makedocs.py:331 +msgid "" +"\n" +"h3. Numeric Constants\n" +"\n" +msgstr "" +"\n" +"h3. Constantes numéricas\n" +"\n" + +#: makedocs.py:347 +msgid "" +"\n" +"h3(#more). Description\n" +"\n" +msgstr "" +"\n" +"h3(#more). Descripción\n" +"\n" + +#: makedocs.py:351 +msgid "_Nothing here, yet..._\n" +msgstr "_Aún nada por aquí..._\n" + +#: makedocs.py:355 +msgid "" +"\n" +"h3. Member Function Description\n" +"\n" +msgstr "" +"\n" +"h3. Descripción de las funciones miembro\n" +"\n" diff --git a/doc/html/main.css b/doc/tools/main.css index a76e6bbed8..a76e6bbed8 100644 --- a/doc/html/main.css +++ b/doc/tools/main.css diff --git a/doc/tools/makedocs.pot b/doc/tools/makedocs.pot new file mode 100644 index 0000000000..be3220f686 --- /dev/null +++ b/doc/tools/makedocs.pot @@ -0,0 +1,108 @@ +# Translations template for PROJECT. +# Copyright (C) 2015 ORGANIZATION +# This file is distributed under the same license as the PROJECT project. +# FIRST AUTHOR <EMAIL@ADDRESS>, 2015. +# +#, fuzzy +msgid "" +msgstr "" +"Project-Id-Version: makedocs 0.1\n" +"Report-Msgid-Bugs-To: EMAIL@ADDRESS\n" +"POT-Creation-Date: 2015-10-07 11:47-0600\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n" +"Language-Team: \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: 8bit\n" +"Generated-By: Babel 2.0\n" +"X-Generator: Poedit 1.8.4\n" + +#: makedocs.py:74 +msgid "\"<code>{gclass}</code>(Go to page of class {gclass})\":/class_{lkclass}" +msgstr "" + +#: makedocs.py:76 +msgid "\"<code>{gclass}.{method}</code>(Go to page {gclass}, section {method})\":/class_{lkclass}#{lkmethod}" +msgstr "" + +#: makedocs.py:79 +msgid "\"<code>{method}</code>(Jump to method {method})\":#{lkmethod}" +msgstr "" + +#: makedocs.py:81 +msgid " \"{rtype}(Go to page of class {rtype})\":/class_{link} " +msgstr "" + +#: makedocs.py:82 +msgid "\"*{funcname}*(Jump to description for node {funcname})\":#{link} <b>(</b> " +msgstr "" + +#: makedocs.py:87 +msgid "h4. Inherits: " +msgstr "" + +#: makedocs.py:232 +msgid "<doc>'s version attribute missing" +msgstr "" + +#: makedocs.py:246 +msgid "|_. Index symbol |_. Class name |_. Index symbol |_. Class name |\n" +msgstr "" + +#: makedocs.py:305 +msgid "" +"h4. Category: {}\n" +"\n" +msgstr "" + +#: makedocs.py:310 +msgid "" +"h2. Brief Description\n" +"\n" +msgstr "" + +#: makedocs.py:312 +msgid "" +"\"read more\":#more\n" +"\n" +msgstr "" + +#: makedocs.py:317 +msgid "" +"\n" +"h3. Member Functions\n" +"\n" +msgstr "" + +#: makedocs.py:323 +msgid "" +"\n" +"h3. Signals\n" +"\n" +msgstr "" + +#: makedocs.py:331 +msgid "" +"\n" +"h3. Numeric Constants\n" +"\n" +msgstr "" + +#: makedocs.py:347 +msgid "" +"\n" +"h3(#more). Description\n" +"\n" +msgstr "" + +#: makedocs.py:351 +msgid "_Nothing here, yet..._\n" +msgstr "" + +#: makedocs.py:355 +msgid "" +"\n" +"h3. Member Function Description\n" +"\n" +msgstr "" diff --git a/doc/tools/makedocs.py b/doc/tools/makedocs.py new file mode 100644 index 0000000000..063ee29002 --- /dev/null +++ b/doc/tools/makedocs.py @@ -0,0 +1,382 @@ +#!/usr/bin/python3 +# -*- coding: utf-8 -*- + +# +# makedocs.py: Generate documentation for Open Project Wiki +# Copyright (c) 2007-2016 Juan Linietsky, Ariel Manzur. +# Contributor: Jorge Araya Navarro <elcorreo@deshackra.com> +# + +# IMPORTANT NOTICE: +# If you are going to modify anything from this file, please be sure to follow +# the Style Guide for Python Code or often called "PEP8". To do this +# automagically just install autopep8: +# +# $ sudo pip3 install autopep8 +# +# and run: +# +# $ autopep8 makedocs.py +# +# Before committing your changes. Also be sure to delete any trailing +# whitespace you may left. +# +# TODO: +# * Refactor code. +# * Adapt this script for generating content in other markup formats like +# reStructuredText, Markdown, DokuWiki, etc. +# +# Also check other TODO entries in this script for more information on what is +# left to do. +import argparse +import gettext +import logging +import re +from itertools import zip_longest +from os import path, listdir +from xml.etree import ElementTree + + +# add an option to change the verbosity +logging.basicConfig(level=logging.INFO) + + +def getxmlfloc(): + """ Returns the supposed location of the XML file + """ + filepath = path.dirname(path.abspath(__file__)) + return path.join(filepath, "class_list.xml") + + +def langavailable(): + """ Return a list of languages available for translation + """ + filepath = path.join( + path.dirname(path.abspath(__file__)), "locales") + files = listdir(filepath) + choices = [x for x in files] + choices.insert(0, "none") + return choices + + +desc = "Generates documentation from a XML file to different markup languages" + +parser = argparse.ArgumentParser(description=desc) +parser.add_argument("--input", dest="xmlfp", default=getxmlfloc(), + help="Input XML file, default: {}".format(getxmlfloc())) +parser.add_argument("--output-dir", dest="outputdir", required=True, + help="Output directory for generated files") +parser.add_argument("--language", choices=langavailable(), default="none", + help=("Choose the language of translation" + " for the output files. Default is English (none). " + "Note: This is NOT for the documentation itself!")) +# TODO: add an option for outputting different markup formats + +args = parser.parse_args() +# Let's check if the file and output directory exists +if not path.isfile(args.xmlfp): + logging.critical("File not found: {}".format(args.xmlfp)) + exit(1) +elif not path.isdir(args.outputdir): + logging.critical("Path does not exist: {}".format(args.outputdir)) + exit(1) + +_ = gettext.gettext +if args.language != "none": + lang = gettext.translation(domain="makedocs", + localedir="locales", + languages=[args.language]) + lang.install() + + _ = lang.gettext + +# Strings +C_LINK = _("\"<code>{gclass}</code>(Go to page of class" + " {gclass})\":/class_{lkclass}") +MC_LINK = _("\"<code>{gclass}.{method}</code>(Go " + "to page {gclass}, section {method})\"" + ":/class_{lkclass}#{lkmethod}") +TM_JUMP = _("\"<code>{method}</code>(Jump to method" + " {method})\":#{lkmethod}") +GTC_LINK = _(" \"{rtype}(Go to page of class {rtype})\":/class_{link} ") +DFN_JUMP = _("\"*{funcname}*(Jump to description for" + " node {funcname})\":#{link} <b>(</b> ") +M_ARG_DEFAULT = C_LINK + " {name}={default}" +M_ARG = C_LINK + " {name}" + +OPENPROJ_INH = _("h4. Inherits: ") + C_LINK + "\n\n" + + +def tb(string): + """ Return a byte representation of a string + """ + return bytes(string, "UTF-8") + + +def sortkey(c): + """ Symbols are first, letters second + """ + if "_" == c.attrib["name"][0]: + return "A" + else: + return c.attrib["name"] + + +def toOP(text): + """ Convert commands in text to Open Project commands + """ + # TODO: Make this capture content between [command] ... [/command] + groups = re.finditer((r'\[html (?P<command>/?\w+/?)(\]| |=)?(\]| |=)?(?P<a' + 'rg>\w+)?(\]| |=)?(?P<value>"[^"]+")?/?\]'), text) + alignstr = "" + for group in groups: + gd = group.groupdict() + if gd["command"] == "br/": + text = text.replace(group.group(0), "\n\n", 1) + elif gd["command"] == "div": + if gd["value"] == '"center"': + alignstr = ("{display:block; margin-left:auto;" + " margin-right:auto;}") + elif gd["value"] == '"left"': + alignstr = "<" + elif gd["value"] == '"right"': + alignstr = ">" + text = text.replace(group.group(0), "\n\n", 1) + elif gd["command"] == "/div": + alignstr = "" + text = text.replace(group.group(0), "\n\n", 1) + elif gd["command"] == "img": + text = text.replace(group.group(0), "!{align}{src}!".format( + align=alignstr, src=gd["value"].strip('"')), 1) + elif gd["command"] == "b" or gd["command"] == "/b": + text = text.replace(group.group(0), "*", 1) + elif gd["command"] == "i" or gd["command"] == "/i": + text = text.replace(group.group(0), "_", 1) + elif gd["command"] == "u" or gd["command"] == "/u": + text = text.replace(group.group(0), "+", 1) + # Process other non-html commands + groups = re.finditer((r'\[method ((?P<class>[aA0-zZ9_]+)(?:\.))' + r'?(?P<method>[aA0-zZ9_]+)\]'), text) + for group in groups: + gd = group.groupdict() + if gd["class"]: + replacewith = (MC_LINK.format(gclass=gd["class"], + method=gd["method"], + lkclass=gd["class"].lower(), + lkmethod=gd["method"].lower())) + else: + # The method is located in the same wiki page + replacewith = (TM_JUMP.format(method=gd["method"], + lkmethod=gd["method"].lower())) + + text = text.replace(group.group(0), replacewith, 1) + # Finally, [Classes] are around brackets, make them direct links + groups = re.finditer(r'\[(?P<class>[az0-AZ0_]+)\]', text) + for group in groups: + gd = group.groupdict() + replacewith = (C_LINK. + format(gclass=gd["class"], + lkclass=gd["class"].lower())) + text = text.replace(group.group(0), replacewith, 1) + + return text + "\n\n" + + +def mkfn(node, is_signal=False): + """ Return a string containing a unsorted item for a function + """ + finalstr = "" + name = node.attrib["name"] + rtype = node.find("return") + if rtype: + rtype = rtype.attrib["type"] + else: + rtype = "void" + # write the return type and the function name first + finalstr += "* " + # return type + if not is_signal: + if rtype != "void": + finalstr += GTC_LINK.format( + rtype=rtype, + link=rtype.lower()) + else: + finalstr += " void " + + # function name + if not is_signal: + finalstr += DFN_JUMP.format( + funcname=name, + link=name.lower()) + else: + # Signals have no description + finalstr += "*{funcname}* <b>(</b>".format(funcname=name) + # loop for the arguments of the function, if any + args = [] + for arg in sorted( + node.iter(tag="argument"), + key=lambda a: int(a.attrib["index"])): + + ntype = arg.attrib["type"] + nname = arg.attrib["name"] + + if "default" in arg.attrib: + args.insert(-1, M_ARG_DEFAULT.format( + gclass=ntype, + lkclass=ntype.lower(), + name=nname, + default=arg.attrib["default"])) + else: + # No default value present + args.insert(-1, M_ARG.format(gclass=ntype, + lkclass=ntype.lower(), name=nname)) + # join the arguments together + finalstr += ", ".join(args) + # and, close the function with a ) + finalstr += " <b>)</b>" + # write the qualifier, if any + if "qualifiers" in node.attrib: + qualifier = node.attrib["qualifiers"] + finalstr += " " + qualifier + + finalstr += "\n" + + return finalstr + +# Let's begin +tree = ElementTree.parse(args.xmlfp) +root = tree.getroot() + +# Check version attribute exists in <doc> +if "version" not in root.attrib: + logging.critical(_("<doc>'s version attribute missing")) + exit(1) + +version = root.attrib["version"] +classes = sorted(root, key=sortkey) +# first column is always longer, second column of classes should be shorter +zclasses = zip_longest(classes[:int(len(classes) / 2 + 1)], + classes[int(len(classes) / 2 + 1):], + fillvalue="") + +# We write the class_list file and also each class file at once +with open(path.join(args.outputdir, "class_list.txt"), "wb") as fcl: + # Write header of table + fcl.write(tb("|^.\n")) + fcl.write(tb(_("|_. Index symbol |_. Class name " + "|_. Index symbol |_. Class name |\n"))) + fcl.write(tb("|-.\n")) + + indexletterl = "" + indexletterr = "" + for gdclassl, gdclassr in zclasses: + # write a row # + # write the index symbol column, left + if indexletterl != gdclassl.attrib["name"][0]: + indexletterl = gdclassl.attrib["name"][0] + fcl.write(tb("| *{}* |".format(indexletterl.upper()))) + else: + # empty cell + fcl.write(tb("| |")) + # write the class name column, left + fcl.write(tb(C_LINK.format( + gclass=gdclassl.attrib["name"], + lkclass=gdclassl.attrib["name"].lower()))) + + # write the index symbol column, right + if isinstance(gdclassr, ElementTree.Element): + if indexletterr != gdclassr.attrib["name"][0]: + indexletterr = gdclassr.attrib["name"][0] + fcl.write(tb("| *{}* |".format(indexletterr.upper()))) + else: + # empty cell + fcl.write(tb("| |")) + # We are dealing with an empty string + else: + # two empty cell + fcl.write(tb("| | |\n")) + # We won't get the name of the class since there is no ElementTree + # object for the right side of the tuple, so we iterate the next + # tuple instead + continue + + # write the class name column (if any), right + fcl.write(tb(C_LINK.format( + gclass=gdclassl.attrib["name"], + lkclass=gdclassl.attrib["name"].lower()) + "|\n")) + + # row written # + # now, let's write each class page for each class + for gdclass in [gdclassl, gdclassr]: + if not isinstance(gdclass, ElementTree.Element): + continue + + classname = gdclass.attrib["name"] + with open(path.join(args.outputdir, "{}.txt".format( + classname.lower())), "wb") as clsf: + # First level header with the name of the class + clsf.write(tb("h1. {}\n\n".format(classname))) + # lay the attributes + if "inherits" in gdclass.attrib: + inh = gdclass.attrib["inherits"].strip() + clsf.write(tb(OPENPROJ_INH.format(gclass=inh, + lkclass=inh.lower()))) + if "category" in gdclass.attrib: + clsf.write(tb(_("h4. Category: {}\n\n"). + format(gdclass.attrib["category"].strip()))) + # lay child nodes + briefd = gdclass.find("brief_description") + if briefd.text.strip(): + clsf.write(tb(_("h2. Brief Description\n\n"))) + clsf.write(tb(toOP(briefd.text.strip()) + + _("\"read more\":#more\n\n"))) + + # Write the list of member functions of this class + methods = gdclass.find("methods") + if methods and len(methods) > 0: + clsf.write(tb(_("\nh3. Member Functions\n\n"))) + for method in methods.iter(tag='method'): + clsf.write(tb(mkfn(method))) + + signals = gdclass.find("signals") + if signals and len(signals) > 0: + clsf.write(tb(_("\nh3. Signals\n\n"))) + for signal in signals.iter(tag='signal'): + clsf.write(tb(mkfn(signal, True))) + # TODO: <members> tag is necessary to process? it does not + # exists in class_list.xml file. + + consts = gdclass.find("constants") + if consts and len(consts) > 0: + clsf.write(tb(_("\nh3. Numeric Constants\n\n"))) + for const in sorted(consts, key=lambda k: + k.attrib["name"]): + if const.text.strip(): + clsf.write(tb("* *{name}* = *{value}* - {desc}\n". + format( + name=const.attrib["name"], + value=const.attrib["value"], + desc=const.text.strip()))) + else: + # Constant have no description + clsf.write(tb("* *{name}* = *{value}*\n". + format( + name=const.attrib["name"], + value=const.attrib["value"]))) + descrip = gdclass.find("description") + clsf.write(tb(_("\nh3(#more). Description\n\n"))) + if descrip.text: + clsf.write(tb(descrip.text.strip() + "\n")) + else: + clsf.write(tb(_("_Nothing here, yet..._\n"))) + + # and finally, the description for each method + if methods and len(methods) > 0: + clsf.write(tb(_("\nh3. Member Function Description\n\n"))) + for method in methods.iter(tag='method'): + clsf.write(tb("h4(#{n}). {name}\n\n".format( + n=method.attrib["name"].lower(), + name=method.attrib["name"]))) + clsf.write(tb(mkfn(method) + "\n")) + clsf.write(tb(toOP(method.find( + "description").text.strip()))) diff --git a/doc/tools/makedoku.py b/doc/tools/makedoku.py new file mode 100644 index 0000000000..1ab16841b1 --- /dev/null +++ b/doc/tools/makedoku.py @@ -0,0 +1,514 @@ +#!/usr/bin/python +# -*- coding: utf-8 -*- + +import sys +import xml.etree.ElementTree as ET + +input_list = [] + + +for arg in sys.argv[1:]: + input_list.append(arg) + +if len(input_list) < 1: + print("usage: makedoku.py <classes.xml>") + sys.exit(0) + + +def validate_tag(elem,tag): + if (elem.tag != tag): + print("Tag mismatch, expected '"+tag+"', got "+elem.tag); + sys.exit(255) + + +class_names=[] +classes={} + + +def make_class_list(class_list,columns): + + f=open("class_list.txt","wb") + prev=0 + col_max = len(class_list) / columns + 1 + print("col max is ", col_max) + col_count = 0 + row_count = 0 + last_initial = "" + fit_columns=[] + + for n in range(0,columns): + fit_columns+=[[]] + + indexers=[] + last_initial="" + + idx=0 + for n in class_list: + col = idx/col_max + if (col>=columns): + col=columns-1 + fit_columns[col]+=[n] + idx+=1 + if (n[:1]!=last_initial): + indexers+=[n] + last_initial=n[:1] + + + row_max=0 + + for n in range(0,columns): + if (len(fit_columns[n])>row_max): + row_max=len(fit_columns[n]) + + + for r in range(0,row_max): + s="|" + for c in range(0,columns): + if (r>=len(fit_columns[c])): + continue + + classname = fit_columns[c][r] + initial=classname[0] + if (classname in indexers): + s+="**"+initial+"**|" + else: + s+=" |" + + s+="[["+classname.lower()+"|"+classname+"]]|" + + s+="\n" + f.write(s) + + +def dokuize_text(txt): + + return txt + + +def dokuize_text(text): + pos=0 + while(True): + pos = text.find("[",pos) + if (pos==-1): + break + + endq_pos=text.find("]",pos+1) + if (endq_pos==-1): + break + + pre_text=text[:pos] + post_text=text[endq_pos+1:] + tag_text=text[pos+1:endq_pos] + + if (tag_text in class_names): + tag_text="[["+tag_text.lower()+"|"+tag_text+"]]" + else: #command + cmd=tag_text + space_pos=tag_text.find(" ") + if (cmd.find("html")==0): + cmd=tag_text[:space_pos] + param=tag_text[space_pos+1:] + tag_text="<"+param+">" + elif(cmd.find("method")==0): + cmd=tag_text[:space_pos] + param=tag_text[space_pos+1:] + + if (param.find(".")!=-1): + class_param,method_param=param.split(".") + tag_text="[["+class_param.lower()+"#"+method_param+"|"+class_param+'.'+method_param+"]]" + else: + tag_text="[[#"+param+"|"+param+"]]" + elif (cmd.find("image=")==0): + tag_text="{{"+cmd[6:]+"}}" + elif (cmd.find("url=")==0): + tag_text="[["+cmd[4:]+"|" + elif (cmd=="/url"): + tag_text="]]>" + elif (cmd=="center"): + tag_text="" + elif (cmd=="/center"): + tag_text="" + elif (cmd=="br"): + tag_text="\\\\\n" + elif (cmd=="i" or cmd=="/i"): + tag_text="//" + elif (cmd=="b" or cmd=="/b"): + tag_text="**" + elif (cmd=="u" or cmd=="/u"): + tag_text="__" + else: + tag_text="["+tag_text+"]" + + + text=pre_text+tag_text+post_text + pos=len(pre_text)+len(tag_text) + + #tnode = ET.SubElement(parent,"div") + #tnode.text=text + return text + + +def make_type(t): + global class_names + if (t in class_names): + return "[["+t.lower()+"|"+t+"]]" + return t + + +def make_method(f,name,m,declare,event=False): + + s=" * " + ret_type="void" + args=list(m) + mdata={} + mdata["argidx"]=[] + for a in args: + if (a.tag=="return"): + idx=-1 + elif (a.tag=="argument"): + idx=int(a.attrib["index"]) + else: + continue + + mdata["argidx"].append(idx) + mdata[idx]=a + + + + if (not event): + if (-1 in mdata["argidx"]): + s+=make_type(mdata[-1].attrib["type"]) + else: + s+="void" + s+=" " + + if (declare): + + #span.attrib["class"]="funcdecl" + #a=ET.SubElement(span,"a") + #a.attrib["name"]=name+"_"+m.attrib["name"] + #a.text=name+"::"+m.attrib["name"] + s+="**"+m.attrib["name"]+"**" + else: + s+="[[#"+m.attrib["name"]+"|"+m.attrib["name"]+"]]" + + s+="**(**" + argfound=False + for a in mdata["argidx"]: + arg=mdata[a] + if (a<0): + continue + if (a>0): + s+=", " + else: + s+=" " + + s+=make_type(arg.attrib["type"]) + if ("name" in arg.attrib): + s+=" "+arg.attrib["name"] + else: + s+=" arg"+str(a) + + if ("default" in arg.attrib): + s+="="+arg.attrib["default"] + + + argfound=True + + if (argfound): + s+=" " + s+="**)**" + + if ("qualifiers" in m.attrib): + s+=" "+m.attrib["qualifiers"] + + f.write(s+"\n") + + +def make_doku_class(node): + + name = node.attrib["name"] + + f=open(name.lower()+".txt","wb") + + f.write("====== "+name+" ======\n") + + if ("inherits" in node.attrib): + inh=node.attrib["inherits"].strip() + f.write("**Inherits:** [["+inh.lower()+"|"+inh+"]]\\\\\n") + if ("category" in node.attrib): + f.write("**Category:** "+node.attrib["category"].strip()+"\\\\\n") + + briefd = node.find("brief_description") + if (briefd!=None): + f.write("===== Brief Description ======\n") + f.write( dokuize_text(briefd.text.strip())+"\n" ) + + methods = node.find("methods") + + if(methods!=None and len(list(methods))>0): + f.write("===== Member Functions ======\n") + for m in list(methods): + make_method(f,node.attrib["name"],m,False) + + events = node.find("signals") + if(events!=None and len(list(events))>0): + f.write("===== Signals ======\n") + for m in list(events): + make_method(f,node.attrib["name"],m,True,True) + + members = node.find("members") + + if(members!=None and len(list(members))>0): + f.write("===== Member Variables ======\n") + + for c in list(members): + s = " * " + s+=make_type(c.attrib["type"])+" " + s+="**"+c.attrib["name"]+"**" + if (c.text.strip()!=""): + s+=" - "+c.text.strip() + f.write(s+"\n") + + + + constants = node.find("constants") + if(constants!=None and len(list(constants))>0): + f.write("===== Numeric Constants ======\n") + for c in list(constants): + s = " * " + s+="**"+c.attrib["name"]+"**" + if ("value" in c.attrib): + s+=" = **"+c.attrib["value"]+"**" + if (c.text.strip()!=""): + s+=" - "+c.text.strip() + f.write(s+"\n") + + + descr=node.find("description") + if (descr!=None and descr.text.strip()!=""): + f.write("===== Description ======\n") + f.write(dokuize_text(descr.text.strip())+"\n") + + methods = node.find("methods") + + if(methods!=None and len(list(methods))>0): + f.write("===== Member Function Description ======\n") + for m in list(methods): + + d=m.find("description") + if (d==None or d.text.strip()==""): + continue + f.write("== "+m.attrib["name"]+" ==\n") + make_method(f,node.attrib["name"],m,False) + f.write("\\\\\n") + f.write(dokuize_text(d.text.strip())) + f.write("\n") + + + + + + """ + div=ET.Element("div") + div.attrib["class"]="class"; + + a=ET.SubElement(div,"a") + a.attrib["name"]=node.attrib["name"] + + h3=ET.SubElement(a,"h3") + h3.attrib["class"]="title class_title" + h3.text=node.attrib["name"] + + briefd = node.find("brief_description") + if (briefd!=None): + div2=ET.SubElement(div,"div") + div2.attrib["class"]="description class_description" + div2.text=briefd.text + + if ("inherits" in node.attrib): + ET.SubElement(div,"br") + + div2=ET.SubElement(div,"div") + div2.attrib["class"]="inheritance"; + + span=ET.SubElement(div2,"span") + span.text="Inherits: " + + make_type(node.attrib["inherits"],div2) + + if ("category" in node.attrib): + ET.SubElement(div,"br") + + div3=ET.SubElement(div,"div") + div3.attrib["class"]="category"; + + span=ET.SubElement(div3,"span") + span.attrib["class"]="category" + span.text="Category: " + + a = ET.SubElement(div3,"a") + a.attrib["class"]="category_ref" + a.text=node.attrib["category"] + catname=a.text + if (catname.rfind("/")!=-1): + catname=catname[catname.rfind("/"):] + catname="CATEGORY_"+catname + + if (single_page): + a.attrib["href"]="#"+catname + else: + a.attrib["href"]="category.html#"+catname + + + methods = node.find("methods") + + if(methods!=None and len(list(methods))>0): + + h4=ET.SubElement(div,"h4") + h4.text="Public Methods:" + + method_table=ET.SubElement(div,"table") + method_table.attrib["class"]="method_list"; + + for m in list(methods): +# li = ET.SubElement(div2, "li") + method_table.append( make_method_def(node.attrib["name"],m,False) ) + + events = node.find("signals") + + if(events!=None and len(list(events))>0): + h4=ET.SubElement(div,"h4") + h4.text="Events:" + + event_table=ET.SubElement(div,"table") + event_table.attrib["class"]="method_list"; + + for m in list(events): +# li = ET.SubElement(div2, "li") + event_table.append( make_method_def(node.attrib["name"],m,False,True) ) + + + members = node.find("members") + if(members!=None and len(list(members))>0): + + h4=ET.SubElement(div,"h4") + h4.text="Public Variables:" + div2=ET.SubElement(div,"div") + div2.attrib["class"]="member_list"; + + for c in list(members): + + li = ET.SubElement(div2, "li") + div3=ET.SubElement(li,"div") + div3.attrib["class"]="member"; + make_type(c.attrib["type"],div3) + span=ET.SubElement(div3,"span") + span.attrib["class"]="identifier member_name" + span.text=" "+c.attrib["name"]+" " + span=ET.SubElement(div3,"span") + span.attrib["class"]="member_description" + span.text=c.text + + + constants = node.find("constants") + if(constants!=None and len(list(constants))>0): + + h4=ET.SubElement(div,"h4") + h4.text="Constants:" + div2=ET.SubElement(div,"div") + div2.attrib["class"]="constant_list"; + + for c in list(constants): + li = ET.SubElement(div2, "li") + div3=ET.SubElement(li,"div") + div3.attrib["class"]="constant"; + + span=ET.SubElement(div3,"span") + span.attrib["class"]="identifier constant_name" + span.text=c.attrib["name"]+" " + if ("value" in c.attrib): + span=ET.SubElement(div3,"span") + span.attrib["class"]="symbol" + span.text="= " + span=ET.SubElement(div3,"span") + span.attrib["class"]="constant_value" + span.text=c.attrib["value"]+" " + span=ET.SubElement(div3,"span") + span.attrib["class"]="constant_description" + span.text=c.text + +# ET.SubElement(div,"br") + + + descr=node.find("description") + if (descr!=None and descr.text.strip()!=""): + + h4=ET.SubElement(div,"h4") + h4.text="Description:" + + make_text_def(node.attrib["name"],div,descr.text) +# div2=ET.SubElement(div,"div") +# div2.attrib["class"]="description"; +# div2.text=descr.text + + + + if(methods!=None or events!=None): + + h4=ET.SubElement(div,"h4") + h4.text="Method Documentation:" + iter_list = [] + if (methods!=None): + iter_list+=list(methods) + if (events!=None): + iter_list+=list(events) + + for m in iter_list: + + descr=m.find("description") + + if (descr==None or descr.text.strip()==""): + continue; + + div2=ET.SubElement(div,"div") + div2.attrib["class"]="method_doc"; + + + div2.append( make_method_def(node.attrib["name"],m,True) ) + #anchor = ET.SubElement(div2, "a") + #anchor.attrib["name"] = + make_text_def(node.attrib["name"],div2,descr.text) + #div3=ET.SubElement(div2,"div") + #div3.attrib["class"]="description"; + #div3.text=descr.text + + + return div +""" +for file in input_list: + tree = ET.parse(file) + doc=tree.getroot() + + if ("version" not in doc.attrib): + print("Version missing from 'doc'") + sys.exit(255) + + version=doc.attrib["version"] + + for c in list(doc): + if (c.attrib["name"] in class_names): + continue + class_names.append(c.attrib["name"]) + classes[c.attrib["name"]]=c + + +class_names.sort() + +make_class_list(class_names,4) + +for cn in class_names: + c=classes[cn] + make_doku_class(c) + + diff --git a/doc/tools/makehtml.py b/doc/tools/makehtml.py new file mode 100644 index 0000000000..34db47e424 --- /dev/null +++ b/doc/tools/makehtml.py @@ -0,0 +1,720 @@ +#!/usr/bin/python +# -*- coding: utf-8 -*- + +import sys +import xml.etree.ElementTree as ET +from xml.sax.saxutils import escape, unescape + +html_escape_table = { + '"': """, + "'": "'" +} + +html_unescape_table = {v:k for k, v in html_escape_table.items()} + +def html_escape(text): + return escape(text, html_escape_table) + +def html_unescape(text): + return unescape(text, html_unescape_table) + +input_list = [] + +single_page=True + +for arg in sys.argv[1:]: + if arg[:1] == "-": + if arg[1:] == "multipage": + single_page = False + if arg[1:] == "singlepage": + single_page = True + else: + input_list.append(arg) + +if len(input_list) < 1: + print("usage: makehtml.py <classes.xml>") + sys.exit(0) + + +def validate_tag(elem,tag): + if (elem.tag != tag): + print("Tag mismatch, expected '"+tag+"', got "+elem.tag); + sys.exit(255) + +def make_html_bottom(body): + #make_html_top(body,True) + ET.SubElement(body,"hr") + copyright = ET.SubElement(body,"span") + copyright.text = "Copyright 2008-2010 Codenix SRL" + +def make_html_top(body,bottom=False): + + if (bottom): + ET.SubElement(body,"hr") + + table = ET.SubElement(body,"table") + table.attrib["class"]="top_table" + tr = ET.SubElement(table,"tr") + td = ET.SubElement(tr,"td") + td.attrib["class"]="top_table" + + img = ET.SubElement(td,"image") + img.attrib["src"]="images/logo.png" + td = ET.SubElement(tr,"td") + td.attrib["class"]="top_table" + a = ET.SubElement(td,"a") + a.attrib["href"]="index.html" + a.text="Index" + td = ET.SubElement(tr,"td") + td.attrib["class"]="top_table" + a = ET.SubElement(td,"a") + a.attrib["href"]="alphabetical.html" + a.text="Classes" + td = ET.SubElement(tr,"td") + td.attrib["class"]="top_table" + a = ET.SubElement(td,"a") + a.attrib["href"]="category.html" + a.text="Categories" + td = ET.SubElement(tr,"td") + a = ET.SubElement(td,"a") + a.attrib["href"]="inheritance.html" + a.text="Inheritance" + if (not bottom): + ET.SubElement(body,"hr") + + + + +def make_html_class_list(class_list,columns): + + div=ET.Element("div") + div.attrib["class"]="ClassList"; + + h1=ET.SubElement(div,"h2") + h1.text="Alphabetical Class List" + + table=ET.SubElement(div,"table") + table.attrib["class"]="class_table" + table.attrib["width"]="100%" + prev=0 + + col_max = len(class_list) / columns + 1 + print("col max is ", col_max) + col_count = 0 + row_count = 0 + last_initial = "" + fit_columns=[] + + for n in range(0,columns): + fit_columns+=[[]] + + indexers=[] + last_initial="" + + idx=0 + for n in class_list: + col = int(idx/col_max) + if (col>=columns): + col=columns-1 + fit_columns[col]+=[n] + idx+=1 + if (n[:1]!=last_initial): + indexers+=[n] + last_initial=n[:1] + + row_max=0 + + for n in range(0,columns): + if (len(fit_columns[n])>row_max): + row_max=len(fit_columns[n]) + + + for r in range(0,row_max): + tr = ET.SubElement(table,"tr") + for c in range(0,columns): + tdi = ET.SubElement(tr,"td") + tdi.attrib["align"]="right" + td = ET.SubElement(tr,"td") + if (r>=len(fit_columns[c])): + continue + + classname = fit_columns[c][r] + print(classname) + if (classname in indexers): + + span = ET.SubElement(tdi, "span") + span.attrib["class"] = "class_index_letter" + span.text = classname[:1].upper() + + if (single_page): + link="#"+classname + else: + link=classname+".html" + + a=ET.SubElement(td,"a") + a.attrib["href"]=link + a.text=classname + + + if (not single_page): + cat_class_list=ET.Element("html") + csscc = ET.SubElement(cat_class_list, "link") + csscc.attrib["href"] = "main.css" + csscc.attrib["rel"] = "stylesheet" + csscc.attrib["type"] = "text/css" + bodycc = ET.SubElement(cat_class_list, "body") + make_html_top(bodycc) + + cat_class_parent=bodycc + else: + cat_class_parent=div + + + + + h1=ET.SubElement(cat_class_parent,"h2") + h1.text="Class List By Category" + + class_cat_table={} + class_cat_list=[] + + for c in class_list: + clss = classes[c] + if ("category" in clss.attrib): + class_cat=clss.attrib["category"] + else: + class_cat="Core" + if (class_cat.find("/")!=-1): + class_cat=class_cat[class_cat.rfind("/")+1:] + if (not class_cat in class_cat_list): + class_cat_list.append(class_cat) + class_cat_table[class_cat]=[] + class_cat_table[class_cat].append(c) + + class_cat_list.sort() + + ct = ET.SubElement(cat_class_parent,"table") + for cl in class_cat_list: + l = class_cat_table[cl] + l.sort() + tr = ET.SubElement(ct,"tr") + tr.attrib["class"]="category_title" + td = ET.SubElement(ct,"td") + td.attrib["class"]="category_title" + + a = ET.SubElement(td,"a") + a.attrib["class"]="category_title" + a.text=cl + a.attrib["name"]="CATEGORY_"+cl + + td = ET.SubElement(ct,"td") + td.attrib["class"]="category_title" + + for clt in l: + tr = ET.SubElement(ct,"tr") + td = ET.SubElement(ct,"td") + make_type(clt,td) + clss=classes[clt] + bd = clss.find("brief_description") + bdtext="" + if (bd!=None): + bdtext=bd.text + td = ET.SubElement(ct,"td") + td.text=bdtext + + if (not single_page): + make_html_bottom(bodycc) + catet_out = ET.ElementTree(cat_class_list) + catet_out.write("category.html") + + + if (not single_page): + inh_class_list=ET.Element("html") + cssic = ET.SubElement(inh_class_list, "link") + cssic.attrib["href"] = "main.css" + cssic.attrib["rel"] = "stylesheet" + cssic.attrib["type"] = "text/css" + bodyic = ET.SubElement(inh_class_list, "body") + make_html_top(bodyic) + inh_class_parent=bodyic + else: + inh_class_parent=div + + + + + h1=ET.SubElement(inh_class_parent,"h2") + h1.text="Class List By Inheritance" + + itemlist = ET.SubElement(inh_class_parent,"list") + + class_inh_table={} + + def add_class(clss): + if (clss.attrib["name"] in class_inh_table): + return #already added + parent_list=None + + if ("inherits" in clss.attrib): + inhc = clss.attrib["inherits"] + if (not (inhc in class_inh_table)): + add_class(classes[inhc]) + + parent_list = class_inh_table[inhc].find("div") + if (parent_list == None): + parent_div = ET.SubElement(class_inh_table[inhc],"div") + parent_list = ET.SubElement(parent_div,"list") + parent_div.attrib["class"]="inh_class_list" + else: + parent_list = parent_list.find("list") + + + else: + parent_list=itemlist + + item = ET.SubElement(parent_list,"li") +# item.attrib["class"]="inh_class_list" + class_inh_table[clss.attrib["name"]]=item + make_type(clss.attrib["name"],item) + + + for c in class_list: + add_class(classes[c]) + + if (not single_page): + make_html_bottom(bodyic) + catet_out = ET.ElementTree(inh_class_list) + catet_out.write("inheritance.html") + + + + + + #h1=ET.SubElement(div,"h2") + #h1.text="Class List By Inheritance" + + return div + + +def make_type(p_type,p_parent): + if (p_type=="RefPtr"): + p_type="Resource" + + if (p_type in class_names): + a=ET.SubElement(p_parent,"a") + a.attrib["class"]="datatype_existing" + a.text=p_type+" " + if (single_page): + a.attrib["href"]="#"+p_type + else: + a.attrib["href"]=p_type+".html" + else: + span=ET.SubElement(p_parent,"span") + span.attrib["class"]="datatype" + span.text=p_type+" " + + + +def make_text_def(class_name,parent,text): + text = html_escape(text) + pos=0 + while(True): + pos = text.find("[",pos) + if (pos==-1): + break + + endq_pos=text.find("]",pos+1) + if (endq_pos==-1): + break + + pre_text=text[:pos] + post_text=text[endq_pos+1:] + tag_text=text[pos+1:endq_pos] + + if (tag_text in class_names): + if (single_page): + tag_text='<a href="#'+tag_text+'">'+tag_text+'</a>' + else: + tag_text='<a href="'+tag_text+'.html">'+tag_text+'</a>' + else: #command + cmd=tag_text + space_pos=tag_text.find(" ") + if (cmd.find("html")==0): + cmd=tag_text[:space_pos] + param=tag_text[space_pos+1:] + tag_text="<"+param+">" + elif(cmd.find("method")==0): + cmd=tag_text[:space_pos] + param=tag_text[space_pos+1:] + + if (not single_page and param.find(".")!=-1): + class_param,method_param=param.split(".") + tag_text=tag_text='<a href="'+class_param+'.html#'+class_param+"_"+method_param+'">'+class_param+'.'+method_param+'()</a>' + else: + tag_text=tag_text='<a href="#'+class_name+"_"+param+'">'+class_name+'.'+param+'()</a>' + elif (cmd.find("image=")==0): + print("found image: "+cmd) + tag_text="<img src="+cmd[6:]+"/>" + elif (cmd.find("url=")==0): + tag_text="<a href="+cmd[4:]+">" + elif (cmd=="/url"): + tag_text="</a>" + elif (cmd=="center"): + tag_text="<div align=\"center\">" + elif (cmd=="/center"): + tag_text="</div>" + elif (cmd=="br"): + tag_text="<br/>" + elif (cmd=="i" or cmd=="/i" or cmd=="b" or cmd=="/b" or cmd=="u" or cmd=="/u"): + tag_text="<"+tag_text+">" #html direct mapping + else: + tag_text="["+tag_text+"]" + + + text=pre_text+tag_text+post_text + pos=len(pre_text)+len(tag_text) + + #tnode = ET.SubElement(parent,"div") + #tnode.text=text + text="<div class=\"description\">"+text+"</div>" + try: + tnode=ET.XML(text) + parent.append(tnode) + except: + print("Error parsing description text: '"+text+"'") + sys.exit(255) + + + return tnode + + + + +def make_method_def(name,m,declare,event=False): + + mdata={} + + + if (not declare): + div=ET.Element("tr") + div.attrib["class"]="method" + ret_parent=ET.SubElement(div,"td") + ret_parent.attrib["align"]="right" + func_parent=ET.SubElement(div,"td") + else: + div=ET.Element("div") + div.attrib["class"]="method" + ret_parent=div + func_parent=div + + mdata["argidx"]=[] + mdata["name"]=m.attrib["name"] + qualifiers="" + if ("qualifiers" in m.attrib): + qualifiers=m.attrib["qualifiers"] + + args=list(m) + for a in args: + if (a.tag=="return"): + idx=-1 + elif (a.tag=="argument"): + idx=int(a.attrib["index"]) + else: + continue + + mdata["argidx"].append(idx) + mdata[idx]=a + + if (not event): + if (-1 in mdata["argidx"]): + make_type(mdata[-1].attrib["type"],ret_parent) + mdata["argidx"].remove(-1) + else: + make_type("void",ret_parent) + + span=ET.SubElement(func_parent,"span") + if (declare): + span.attrib["class"]="funcdecl" + a=ET.SubElement(span,"a") + a.attrib["name"]=name+"_"+m.attrib["name"] + a.text=name+"::"+m.attrib["name"] + else: + span.attrib["class"]="identifier funcdef" + a=ET.SubElement(span,"a") + a.attrib["href"]="#"+name+"_"+m.attrib["name"] + a.text=m.attrib["name"] + + span=ET.SubElement(func_parent,"span") + span.attrib["class"]="symbol" + span.text=" (" + + for a in mdata["argidx"]: + arg=mdata[a] + if (a>0): + span=ET.SubElement(func_parent,"span") + span.text=", " + else: + span=ET.SubElement(func_parent,"span") + span.text=" " + + + make_type(arg.attrib["type"],func_parent) + + span=ET.SubElement(func_parent,"span") + span.text=arg.attrib["name"] + if ("default" in arg.attrib): + span.text=span.text+"="+arg.attrib["default"] + + + span=ET.SubElement(func_parent,"span") + span.attrib["class"]="symbol" + if (len(mdata["argidx"])): + span.text=" )" + else: + span.text=")" + + if (qualifiers): + span=ET.SubElement(func_parent,"span") + span.attrib["class"]="qualifier" + span.text=" "+qualifiers + + return div + + +def make_html_class(node): + + div=ET.Element("div") + div.attrib["class"]="class"; + + a=ET.SubElement(div,"a") + a.attrib["name"]=node.attrib["name"] + + h3=ET.SubElement(a,"h3") + h3.attrib["class"]="title class_title" + h3.text=node.attrib["name"] + + briefd = node.find("brief_description") + if (briefd!=None): + div2=ET.SubElement(div,"div") + div2.attrib["class"]="description class_description" + div2.text=briefd.text + + if ("inherits" in node.attrib): + ET.SubElement(div,"br") + + div2=ET.SubElement(div,"div") + div2.attrib["class"]="inheritance"; + + span=ET.SubElement(div2,"span") + span.text="Inherits: " + + make_type(node.attrib["inherits"],div2) + + if ("category" in node.attrib): + ET.SubElement(div,"br") + + div3=ET.SubElement(div,"div") + div3.attrib["class"]="category"; + + span=ET.SubElement(div3,"span") + span.attrib["class"]="category" + span.text="Category: " + + a = ET.SubElement(div3,"a") + a.attrib["class"]="category_ref" + a.text=node.attrib["category"] + catname=a.text + if (catname.rfind("/")!=-1): + catname=catname[catname.rfind("/"):] + catname="CATEGORY_"+catname + + if (single_page): + a.attrib["href"]="#"+catname + else: + a.attrib["href"]="category.html#"+catname + + + methods = node.find("methods") + + if(methods!=None and len(list(methods))>0): + + h4=ET.SubElement(div,"h4") + h4.text="Public Methods:" + + method_table=ET.SubElement(div,"table") + method_table.attrib["class"]="method_list"; + + for m in list(methods): +# li = ET.SubElement(div2, "li") + method_table.append( make_method_def(node.attrib["name"],m,False) ) + + events = node.find("signals") + + if(events!=None and len(list(events))>0): + h4=ET.SubElement(div,"h4") + h4.text="Events:" + + event_table=ET.SubElement(div,"table") + event_table.attrib["class"]="method_list"; + + for m in list(events): +# li = ET.SubElement(div2, "li") + event_table.append( make_method_def(node.attrib["name"],m,False,True) ) + + + members = node.find("members") + if(members!=None and len(list(members))>0): + + h4=ET.SubElement(div,"h4") + h4.text="Public Variables:" + div2=ET.SubElement(div,"div") + div2.attrib["class"]="member_list"; + + for c in list(members): + + li = ET.SubElement(div2, "li") + div3=ET.SubElement(li,"div") + div3.attrib["class"]="member"; + make_type(c.attrib["type"],div3) + span=ET.SubElement(div3,"span") + span.attrib["class"]="identifier member_name" + span.text=" "+c.attrib["name"]+" " + span=ET.SubElement(div3,"span") + span.attrib["class"]="member_description" + span.text=c.text + + + constants = node.find("constants") + if(constants!=None and len(list(constants))>0): + + h4=ET.SubElement(div,"h4") + h4.text="Constants:" + div2=ET.SubElement(div,"div") + div2.attrib["class"]="constant_list"; + + for c in list(constants): + li = ET.SubElement(div2, "li") + div3=ET.SubElement(li,"div") + div3.attrib["class"]="constant"; + + span=ET.SubElement(div3,"span") + span.attrib["class"]="identifier constant_name" + span.text=c.attrib["name"]+" " + if ("value" in c.attrib): + span=ET.SubElement(div3,"span") + span.attrib["class"]="symbol" + span.text="= " + span=ET.SubElement(div3,"span") + span.attrib["class"]="constant_value" + span.text=c.attrib["value"]+" " + span=ET.SubElement(div3,"span") + span.attrib["class"]="constant_description" + span.text=c.text + +# ET.SubElement(div,"br") + + + descr=node.find("description") + if (descr!=None and descr.text.strip()!=""): + h4=ET.SubElement(div,"h4") + h4.text="Description:" + + make_text_def(node.attrib["name"],div,descr.text) +# div2=ET.SubElement(div,"div") +# div2.attrib["class"]="description"; +# div2.text=descr.text + + + + if(methods!=None or events!=None): + + h4=ET.SubElement(div,"h4") + h4.text="Method Documentation:" + iter_list = [] + if (methods!=None): + iter_list+=list(methods) + if (events!=None): + iter_list+=list(events) + + for m in iter_list: + + descr=m.find("description") + + if (descr==None or descr.text.strip()==""): + continue; + + div2=ET.SubElement(div,"div") + div2.attrib["class"]="method_doc"; + + + div2.append( make_method_def(node.attrib["name"],m,True) ) + #anchor = ET.SubElement(div2, "a") + #anchor.attrib["name"] = + make_text_def(node.attrib["name"],div2,descr.text) + #div3=ET.SubElement(div2,"div") + #div3.attrib["class"]="description"; + #div3.text=descr.text + + + return div + +class_names=[] +classes={} + +for file in input_list: + tree = ET.parse(file) + doc=tree.getroot() + + if ("version" not in doc.attrib): + print("Version missing from 'doc'") + sys.exit(255) + + version=doc.attrib["version"] + + for c in list(doc): + if (c.attrib["name"] in class_names): + continue + class_names.append(c.attrib["name"]) + classes[c.attrib["name"]]=c + +html = ET.Element("html") +css = ET.SubElement(html, "link") +css.attrib["href"] = "main.css" +css.attrib["rel"] = "stylesheet" +css.attrib["type"] = "text/css" + +body = ET.SubElement(html, "body") +if (not single_page): + make_html_top(body) + + + +class_names.sort() + +body.append( make_html_class_list(class_names,5) ) + +for cn in class_names: + c=classes[cn] + if (single_page): + body.append( make_html_class(c)) + else: + html2 = ET.Element("html") + css = ET.SubElement(html2, "link") + css.attrib["href"] = "main.css" + css.attrib["rel"] = "stylesheet" + css.attrib["type"] = "text/css" + body2 = ET.SubElement(html2, "body" ) + make_html_top(body2) + body2.append( make_html_class(c) ); + make_html_bottom(body2) + et_out = ET.ElementTree(html2) + et_out.write(c.attrib["name"]+".html") + + +et_out = ET.ElementTree(html) +if (single_page): + et_out.write("singlepage.html") +else: + make_html_bottom(body) + et_out.write("alphabetical.html") + diff --git a/doc/tools/makemd.py b/doc/tools/makemd.py new file mode 100644 index 0000000000..e012287b0e --- /dev/null +++ b/doc/tools/makemd.py @@ -0,0 +1,346 @@ +#!/usr/bin/python +# -*- coding: utf-8 -*- + +import sys +import xml.etree.ElementTree as ET + +input_list = [] + +for arg in sys.argv[1:]: + input_list.append(arg) + +if len(input_list) < 1: + print 'usage: makemd.py <classes.xml>' + sys.exit(0) + + +def validate_tag(elem, tag): + if elem.tag != tag: + print "Tag mismatch, expected '" + tag + "', got " + elem.tag + sys.exit(255) + + +class_names = [] +classes = {} + + +def make_class_list(class_list, columns): + + f = open('class_list.md', 'wb') + prev = 0 + col_max = len(class_list) / columns + 1 + print ('col max is ', col_max) + col_count = 0 + row_count = 0 + last_initial = '' + fit_columns = [] + + for n in range(0, columns): + fit_columns += [[]] + + indexers = [] + last_initial = '' + + idx = 0 + for n in class_list: + col = idx / col_max + if col >= columns: + col = columns - 1 + fit_columns[col] += [n] + idx += 1 + if n[:1] != last_initial: + indexers += [n] + last_initial = n[:1] + + row_max = 0 + f.write("\n") + + for n in range(0, columns): + if len(fit_columns[n]) > row_max: + row_max = len(fit_columns[n]) + + f.write("| ") + for n in range(0, columns): + f.write(" | |") + + f.write("\n") + f.write("| ") + for n in range(0, columns): + f.write(" --- | ------- |") + f.write("\n") + + for r in range(0, row_max): + s = '| ' + for c in range(0, columns): + if r >= len(fit_columns[c]): + continue + + classname = fit_columns[c][r] + initial = classname[0] + if classname in indexers: + s += '**' + initial + '** | ' + else: + s += ' | ' + + s += '[' + classname + '](class_'+ classname.lower()+') | ' + + s += '\n' + f.write(s) + + +def dokuize_text(txt): + + return txt + + +def dokuize_text(text): + pos = 0 + while True: + pos = text.find('[', pos) + if pos == -1: + break + + endq_pos = text.find(']', pos + 1) + if endq_pos == -1: + break + + pre_text = text[:pos] + post_text = text[endq_pos + 1:] + tag_text = text[pos + 1:endq_pos] + + if tag_text in class_names: + tag_text = make_type(tag_text) + else: + + # command + + cmd = tag_text + space_pos = tag_text.find(' ') + if cmd.find('html') == 0: + cmd = tag_text[:space_pos] + param = tag_text[space_pos + 1:] + tag_text = '<' + param + '>' + elif cmd.find('method') == 0: + cmd = tag_text[:space_pos] + param = tag_text[space_pos + 1:] + + if param.find('.') != -1: + (class_param, method_param) = param.split('.') + tag_text = '['+class_param+'.'+method_param.replace("_","_")+'](' + class_param.lower() + '#' \ + + method_param + ')' + else: + tag_text = '[' + param.replace("_","_") + '](#' + param + ')' + elif cmd.find('image=') == 0: + tag_text = '' + elif cmd.find('url=') == 0: + tag_text = '[' + cmd[4:] + ']('+cmd[4:] + elif cmd == '/url': + tag_text = ')' + elif cmd == 'center': + tag_text = '' + elif cmd == '/center': + tag_text = '' + elif cmd == 'br': + tag_text = '\n' + elif cmd == 'i' or cmd == '/i': + tag_text = '_' + elif cmd == 'b' or cmd == '/b': + tag_text = '**' + elif cmd == 'u' or cmd == '/u': + tag_text = '__' + else: + tag_text = '[' + tag_text + ']' + + text = pre_text + tag_text + post_text + pos = len(pre_text) + len(tag_text) + + # tnode = ET.SubElement(parent,"div") + # tnode.text=text + + return text + + +def make_type(t): + global class_names + if t in class_names: + return '[' + t + '](class_' + t.lower() + ')' + return t + + +def make_method( + f, + name, + m, + declare, + event=False, + ): + + s = ' * ' + ret_type = 'void' + args = list(m) + mdata = {} + mdata['argidx'] = [] + for a in args: + if a.tag == 'return': + idx = -1 + elif a.tag == 'argument': + idx = int(a.attrib['index']) + else: + continue + + mdata['argidx'].append(idx) + mdata[idx] = a + + if not event: + if -1 in mdata['argidx']: + s += make_type(mdata[-1].attrib['type']) + else: + s += 'void' + s += ' ' + + if declare: + + # span.attrib["class"]="funcdecl" + # a=ET.SubElement(span,"a") + # a.attrib["name"]=name+"_"+m.attrib["name"] + # a.text=name+"::"+m.attrib["name"] + + s += ' **'+m.attrib['name'].replace("_","_")+'** ' + else: + s += ' **['+ m.attrib['name'].replace("_","_")+'](#' + m.attrib['name'] + ')** ' + + s += ' **(**' + argfound = False + for a in mdata['argidx']: + arg = mdata[a] + if a < 0: + continue + if a > 0: + s += ', ' + else: + s += ' ' + + s += make_type(arg.attrib['type']) + if 'name' in arg.attrib: + s += ' ' + arg.attrib['name'] + else: + s += ' arg' + str(a) + + if 'default' in arg.attrib: + s += '=' + arg.attrib['default'] + + argfound = True + + if argfound: + s += ' ' + s += ' **)**' + + if 'qualifiers' in m.attrib: + s += ' ' + m.attrib['qualifiers'] + + f.write(s + '\n') + + +def make_doku_class(node): + + name = node.attrib['name'] + + f = open("class_"+name.lower() + '.md', 'wb') + + f.write('# ' + name + ' \n') + + if 'inherits' in node.attrib: + inh = node.attrib['inherits'].strip() + f.write('####**Inherits:** '+make_type(inh)+'\n') + if 'category' in node.attrib: + f.write('####**Category:** ' + node.attrib['category'].strip() + + '\n') + + briefd = node.find('brief_description') + if briefd != None: + f.write('\n### Brief Description \n') + f.write(dokuize_text(briefd.text.strip()) + '\n') + + methods = node.find('methods') + + if methods != None and len(list(methods)) > 0: + f.write('\n### Member Functions \n') + for m in list(methods): + make_method(f, node.attrib['name'], m, False) + + events = node.find('signals') + if events != None and len(list(events)) > 0: + f.write('\n### Signals \n') + for m in list(events): + make_method(f, node.attrib['name'], m, True, True) + + members = node.find('members') + + if members != None and len(list(members)) > 0: + f.write('\n### Member Variables \n') + + for c in list(members): + s = ' * ' + s += make_type(c.attrib['type']) + ' ' + s += '**' + c.attrib['name'] + '**' + if c.text.strip() != '': + s += ' - ' + c.text.strip() + f.write(s + '\n') + + constants = node.find('constants') + if constants != None and len(list(constants)) > 0: + f.write('\n### Numeric Constants \n') + for c in list(constants): + s = ' * ' + s += '**' + c.attrib['name'] + '**' + if 'value' in c.attrib: + s += ' = **' + c.attrib['value'] + '**' + if c.text.strip() != '': + s += ' - ' + c.text.strip() + f.write(s + '\n') + + descr = node.find('description') + if descr != None and descr.text.strip() != '': + f.write('\n### Description \n') + f.write(dokuize_text(descr.text.strip()) + '\n') + + methods = node.find('methods') + + if methods != None and len(list(methods)) > 0: + f.write('\n### Member Function Description \n') + for m in list(methods): + + d = m.find('description') + if d == None or d.text.strip() == '': + continue + f.write('\n#### <a name="'+m.attrib['name']+'">' + m.attrib['name'] + '</a>\n') + make_method(f, node.attrib['name'], m, True) + f.write('\n') + f.write(dokuize_text(d.text.strip())) + f.write('\n') + + +for file in input_list: + tree = ET.parse(file) + doc = tree.getroot() + + if 'version' not in doc.attrib: + print "Version missing from 'doc'" + sys.exit(255) + + version = doc.attrib['version'] + + for c in list(doc): + if c.attrib['name'] in class_names: + continue + class_names.append(c.attrib['name']) + classes[c.attrib['name']] = c + +class_names.sort() + +make_class_list(class_names, 2) + +for cn in class_names: + c = classes[cn] + make_doku_class(c) + diff --git a/doc/tutorial/01 Getting Started.lyx b/doc/tutorial/01 Getting Started.lyx deleted file mode 100644 index bdb4c7706d..0000000000 --- a/doc/tutorial/01 Getting Started.lyx +++ /dev/null @@ -1,557 +0,0 @@ -#LyX 1.6.5 created this file. For more info see http://www.lyx.org/ -\lyxformat 345 -\begin_document -\begin_header -\textclass article -\use_default_options true -\language english -\inputencoding auto -\font_roman default -\font_sans default -\font_typewriter default -\font_default_family default -\font_sc false -\font_osf false -\font_sf_scale 100 -\font_tt_scale 100 - -\graphics default -\paperfontsize default -\use_hyperref false -\papersize default -\use_geometry false -\use_amsmath 1 -\use_esint 1 -\cite_engine basic -\use_bibtopic false -\paperorientation portrait -\secnumdepth 3 -\tocdepth 3 -\paragraph_separation indent -\defskip medskip -\quotes_language english -\papercolumns 1 -\papersides 1 -\paperpagestyle default -\tracking_changes false -\output_changes false -\author "" -\author "" -\end_header - -\begin_body - -\begin_layout Title -01. - Getting Started with Godot Engine -\end_layout - -\begin_layout Section* -Introduction: -\end_layout - -\begin_layout Standard -Godot Engine is designed to be useful. - This may sound rather vague and is difficult to explain without repeating - the same claims that every other engine does, but, as we progress through - this (and the next) tutorials, hopefully it will be made clear what -\begin_inset Quotes eld -\end_inset - -useful -\begin_inset Quotes erd -\end_inset - - means. -\end_layout - -\begin_layout Standard -Godot Engine has many components, both high and low level, and is usually - more abstract and complex than most other engines. - This is, however, to the advantage of the user as complexity is presented - in a way that it only needs to be discovered when more power needs to be - untapped. - This helps to provide an easy learning curve. -\end_layout - -\begin_layout Standard -Design wise, the whole API and set of components were created with a clear - goal in mind, which is to allow for smooth integration of design ideas, - code and assets. - This is achieved by defining the following rules: -\end_layout - -\begin_layout Itemize -Implementing a game feature should never be too many steps away from an - existing component. -\end_layout - -\begin_layout Itemize -More complex features should be leveraged by combining or extending existing - components. -\end_layout - -\begin_layout Itemize -If the above fails, creating custom components should be extremely simple. -\end_layout - -\begin_layout Standard -Ultimately, Godot Engine provides an editor and tools that allows everyone - to work with it: -\end_layout - -\begin_layout Itemize -Programmers can script and extend any component of the project. -\end_layout - -\begin_layout Itemize -Designers can tweak and animate any parameter from a friendly user interface. -\end_layout - -\begin_layout Itemize -Artists can import their art and models and tweak the look of everything - in realtime. -\end_layout - -\begin_layout Section* -Editor: -\end_layout - -\begin_layout Standard -As mentioned before, Godot Engine is very abstract so projects consist of - just a -\emph on -path -\emph default - (ie: C: -\backslash -games -\backslash -mygame5). - Projects don't have to be specifically created, and many can be placed - inside the same path (useful for not wasting folders on tests and experiments). - -\end_layout - -\begin_layout Standard -In any case, to ease the management of projects, a graphical util exists. -\end_layout - -\begin_layout Subsection* -Running From The Project Manager -\end_layout - -\begin_layout Standard -Godot Engine includes a built-in project manager. - This is installed by default on Windows and OSX and it allows for the creation - and removal projects that will be remembered at the next startup: -\end_layout - -\begin_layout Standard -\align center -\begin_inset Graphics - filename pm.png - -\end_inset - - -\end_layout - -\begin_layout Standard -To create a new project, the [Create] button must be pressed and a dialog - will appear, prompting for a path and project name. - Afterwards, the [Open] button will close the project manager and open the - desired project. -\end_layout - -\begin_layout Subsection* -Running From the Command Line -\end_layout - -\begin_layout Standard -To create and manage projects, it is perfectly possible to use the command - line. - Many users prefer this way of working with project data. -\end_layout - -\begin_layout Standard -\align center -\begin_inset Graphics - filename pmc.png - -\end_inset - - -\end_layout - -\begin_layout Standard -For ease of use, it is recommended that the -\begin_inset Quotes eld -\end_inset - -godot -\begin_inset Quotes erd -\end_inset - - binary exists in the path, so any project can be opened easily aywhere - just by changing location to the projec and executing the editor. -\end_layout - -\begin_layout Subsection* -Godot Editor -\end_layout - -\begin_layout Standard -Godot Editor should have been opened by now, if not please check the previous - steps again. -\end_layout - -\begin_layout Standard -Godot has a powerful buit-in editor. - It uses the graphics toolkint within itself to display the UI, so it runs - identical on any platform (even consoles or phones!). -\end_layout - -\begin_layout Standard -\align center -\begin_inset Graphics - filename editor.png - -\end_inset - - -\end_layout - -\begin_layout Standard -In the above screenshots, a few regions are labelled to be explained as - follows: -\end_layout - -\begin_layout Subsubsection* -Viewport -\end_layout - -\begin_layout Standard -The -\emph on -Viewport -\emph default - is the main space where the content is displayed. - Content includes 3D Nodes or Graphical User Interface (GUI) controls. - Other types of data spawn editors of their own when being edited. - The default viewport is the 3D viewport, which can be panned, zoomed, etc. -\end_layout - -\begin_layout Subsubsection* -Scene Tree -\end_layout - -\begin_layout Standard -The -\emph on -Scene Tree -\emph default - is a small dock that displays the tree of the current scene being edited. - A scene is a collection of nodes arranged in a tree-hierarchy (any node - can have several owned children-nodes). - The meaning of this ownership depends purely on the -\emph on -type -\emph default - of the node, but it will become clear after going through the examples. - In a -\emph on -MVC -\emph default - pattern, the scene tree could be considered the -\emph on -View -\emph default -. -\end_layout - -\begin_layout Subsubsection* -Property Editor -\end_layout - -\begin_layout Standard -The -\emph on -Property Editor -\emph default - is another small dock. - Every node contains a finite number of -\emph on -properties -\emph default -, which can be edited. - Properties can be of several types, such as integers, strings, images, - matrices, etc. - Usually, changes to properties are reflected in the -\emph on -viewport -\emph default - in real time. -\end_layout - -\begin_layout Section* -Examples: -\end_layout - -\begin_layout Standard -From now, a few, simple examples will be presented that will help understand - a little better how Godot Engine works. - -\end_layout - -\begin_layout Subsubsection* -Hello, World! -\end_layout - -\begin_layout Enumerate -Open the editor -\end_layout - -\begin_layout Enumerate -Click on -\begin_inset Quotes eld -\end_inset - -Node -\begin_inset Quotes erd -\end_inset - - (Node Menu), then on -\begin_inset Quotes eld -\end_inset - -Create Root -\begin_inset Quotes erd -\end_inset - - -\end_layout - -\begin_deeper -\begin_layout Standard -\align center -\begin_inset Graphics - filename tute1_1.png - -\end_inset - - -\end_layout - -\end_deeper -\begin_layout Enumerate -Create a node of type -\emph on -Label, -\emph default -then instruct the -\emph on -editor -\emph default -to switch to GUI editing mode. - A few red squares will appear on the top left corner, don't mind them yet. -\end_layout - -\begin_deeper -\begin_layout Standard -\align center -\begin_inset Graphics - filename tute1_2.png - -\end_inset - - -\end_layout - -\begin_layout Standard -\align center -\begin_inset Graphics - filename tute1_2b.png - -\end_inset - - -\end_layout - -\begin_layout Standard -\align center -\begin_inset Graphics - filename tute1_3c.png - -\end_inset - - -\end_layout - -\end_deeper -\begin_layout Enumerate -Select the -\emph on -Label -\emph default -node in the -\emph on -Scene Tree -\emph default - (if it's not selected yet), the properties of the selected node will appear - in the -\emph on -Property Editor -\end_layout - -\begin_deeper -\begin_layout Standard -\align center -\begin_inset Graphics - filename tute1_3a.png - -\end_inset - - -\end_layout - -\begin_layout Standard -\align center -\begin_inset Graphics - filename tute1_3b.png - -\end_inset - - -\end_layout - -\end_deeper -\begin_layout Enumerate -Look for the -\emph on -Text -\emph default - property in the -\emph on -Property Editor -\emph default - and click the right column, so it becomes editable. - Enter the text -\begin_inset Quotes eld -\end_inset - -Hello, World! -\begin_inset Quotes erd -\end_inset - -. - A red square containing -\begin_inset Quotes eld -\end_inset - -Hello World! -\begin_inset Quotes erd -\end_inset - - will appear at the top left, move it to the center. -\end_layout - -\begin_deeper -\begin_layout Standard -\align center -\begin_inset Graphics - filename tute1_4a.png - -\end_inset - - -\end_layout - -\begin_layout Standard -\align center -\begin_inset Graphics - filename tute1_4b.png - -\end_inset - - -\end_layout - -\end_deeper -\begin_layout Enumerate -Save the scene. -\end_layout - -\begin_deeper -\begin_layout Standard -\align center -\begin_inset Graphics - filename tute1_5a.png - -\end_inset - - -\end_layout - -\begin_layout Standard -\align center -\begin_inset Graphics - filename tute1_5b.png - -\end_inset - - -\end_layout - -\end_deeper -\begin_layout Enumerate -Press PLAY. - A new window will appear running the application. -\end_layout - -\begin_deeper -\begin_layout Standard -\align center -\begin_inset Graphics - filename tute1_6.png - -\end_inset - - -\end_layout - -\begin_layout Standard -\align center -\begin_inset Graphics - filename tute1_7.png - -\end_inset - - -\end_layout - -\end_deeper -\begin_layout Subsubsection* -Hello World 2 (a little more complex) -\end_layout - -\begin_layout Subsubsection* -A 3D Cube in Space -\end_layout - -\begin_layout Standard - -\end_layout - -\begin_layout Standard -In many cases, nodes and other types of engine objects need to express changes - in their state, such as a button being pressed, a scroll being dragged, - or a projectile colliding against a tank. - Godot Engine utilizes the concept of signals for this. - Different types of nodes and objects can emit signals, and any other node - or object can connect to them. - -\end_layout - -\end_body -\end_document diff --git a/doc/tutorial/editor.png b/doc/tutorial/editor.png Binary files differdeleted file mode 100644 index 92255a6f17..0000000000 --- a/doc/tutorial/editor.png +++ /dev/null diff --git a/doc/tutorial/pm.png b/doc/tutorial/pm.png Binary files differdeleted file mode 100644 index 00d46d9a64..0000000000 --- a/doc/tutorial/pm.png +++ /dev/null diff --git a/doc/tutorial/pmc.png b/doc/tutorial/pmc.png Binary files differdeleted file mode 100644 index 847d32b3a2..0000000000 --- a/doc/tutorial/pmc.png +++ /dev/null diff --git a/doc/tutorial/tute1_1.png b/doc/tutorial/tute1_1.png Binary files differdeleted file mode 100644 index 82152c7255..0000000000 --- a/doc/tutorial/tute1_1.png +++ /dev/null diff --git a/doc/tutorial/tute1_2.png b/doc/tutorial/tute1_2.png Binary files differdeleted file mode 100644 index 852015894c..0000000000 --- a/doc/tutorial/tute1_2.png +++ /dev/null diff --git a/doc/tutorial/tute1_2b.png b/doc/tutorial/tute1_2b.png Binary files differdeleted file mode 100644 index e97a40b4c5..0000000000 --- a/doc/tutorial/tute1_2b.png +++ /dev/null diff --git a/doc/tutorial/tute1_3a.png b/doc/tutorial/tute1_3a.png Binary files differdeleted file mode 100644 index 5feef01e03..0000000000 --- a/doc/tutorial/tute1_3a.png +++ /dev/null diff --git a/doc/tutorial/tute1_3b.png b/doc/tutorial/tute1_3b.png Binary files differdeleted file mode 100644 index 1f2ded42bb..0000000000 --- a/doc/tutorial/tute1_3b.png +++ /dev/null diff --git a/doc/tutorial/tute1_3c.png b/doc/tutorial/tute1_3c.png Binary files differdeleted file mode 100644 index 2c52ccd780..0000000000 --- a/doc/tutorial/tute1_3c.png +++ /dev/null diff --git a/doc/tutorial/tute1_4a.png b/doc/tutorial/tute1_4a.png Binary files differdeleted file mode 100644 index 8d0d04ff6b..0000000000 --- a/doc/tutorial/tute1_4a.png +++ /dev/null diff --git a/doc/tutorial/tute1_4b.png b/doc/tutorial/tute1_4b.png Binary files differdeleted file mode 100644 index fff5f8d723..0000000000 --- a/doc/tutorial/tute1_4b.png +++ /dev/null diff --git a/doc/tutorial/tute1_5a.png b/doc/tutorial/tute1_5a.png Binary files differdeleted file mode 100644 index 37bea04570..0000000000 --- a/doc/tutorial/tute1_5a.png +++ /dev/null diff --git a/doc/tutorial/tute1_5b.png b/doc/tutorial/tute1_5b.png Binary files differdeleted file mode 100644 index df9a987ef3..0000000000 --- a/doc/tutorial/tute1_5b.png +++ /dev/null diff --git a/doc/tutorial/tute1_6.png b/doc/tutorial/tute1_6.png Binary files differdeleted file mode 100644 index bbe04c8547..0000000000 --- a/doc/tutorial/tute1_6.png +++ /dev/null diff --git a/doc/tutorial/tute1_7.png b/doc/tutorial/tute1_7.png Binary files differdeleted file mode 100644 index 7653a89064..0000000000 --- a/doc/tutorial/tute1_7.png +++ /dev/null diff --git a/doc/undoredoapi.txt b/doc/undoredoapi.txt deleted file mode 100644 index eb73b8ccff..0000000000 --- a/doc/undoredoapi.txt +++ /dev/null @@ -1,25 +0,0 @@ -undo/redo api proposal - - - -o o o o o o o o - - -undoredo.create_method(); -undoredo.add_do_method(node,"add_child",node_to_add); -undoredo.add_undo_method(node,"remove_child",node_to_add); -undoredo.add_add_data(node_to_add); -undoredo.commit() - -undoredo.create_method(); -undoredo.add_do_method(node,"remove_node",node_to_remove); -undoredo.add_undo_method(node,"add_node",node_to_remove); -undoredo.add_remove_data(node_to_remove); -undoredo.commit() - - -undoredo.create_property(); -undoredo.add_do_set(node,"property",value); -undoredo.add_undo_set(node,"property",previous_value); -undoredo.add_remove_data(node_to_remove); -undoredo.commit() |
