godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
godot/doc/classes/SceneTree.xml

349 lines
10 KiB
XML
Raw Normal View History

Fix malformed doc after #15611
2018-01-12 08:03:11 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
doc: Update version string for 3.0.2
2018-02-27 12:57:10 +00:00
<class name="SceneTree" inherits="MainLoop" category="Core" version="3.0.2">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
doc: Fix references to online tutorials after godotengine/godot-docs#1015
2018-01-25 08:03:59 +00:00
http://docs.godotengine.org/en/3.0/getting_started/step_by_step/scene_tree.html
http://docs.godotengine.org/en/3.0/tutorials/viewports/multiple_resolutions.html
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</tutorials>
<demos>
</demos>
<methods>
<method name="call_group" qualifiers="vararg">
<return type="Variant">
</return>
<argument index="0" name="group" type="String">
</argument>
<argument index="1" name="method" type="String">
</argument>
<description>
</description>
</method>
<method name="call_group_flags" qualifiers="vararg">
<return type="Variant">
</return>
<argument index="0" name="flags" type="int">
</argument>
<argument index="1" name="group" type="String">
</argument>
<argument index="2" name="method" type="String">
</argument>
<description>
</description>
</method>
<method name="change_scene">
<return type="int" enum="Error">
</return>
<argument index="0" name="path" type="String">
</argument>
<description>
</description>
</method>
<method name="change_scene_to">
<return type="int" enum="Error">
</return>
<argument index="0" name="packed_scene" type="PackedScene">
</argument>
<description>
</description>
</method>
<method name="create_timer">
<return type="SceneTreeTimer">
</return>
<argument index="0" name="time_sec" type="float">
</argument>
<argument index="1" name="pause_mode_process" type="bool" default="true">
</argument>
<description>
</description>
</method>
<method name="get_frame" qualifiers="const">
<return type="int">
</return>
<description>
</description>
</method>
<method name="get_network_connected_peers" qualifiers="const">
<return type="PoolIntArray">
</return>
<description>
</description>
</method>
<method name="get_network_unique_id" qualifiers="const">
<return type="int">
</return>
<description>
</description>
</method>
<method name="get_node_count" qualifiers="const">
<return type="int">
</return>
<description>
</description>
</method>
<method name="get_nodes_in_group">
<return type="Array">
</return>
<argument index="0" name="group" type="String">
</argument>
<description>
</description>
</method>
<method name="get_rpc_sender_id" qualifiers="const">
<return type="int">
</return>
<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="has_network_peer" qualifiers="const">
<return type="bool">
</return>
<description>
Returns true if there is a [NetworkedMultiplayerPeer] set (with [method SceneTree.set_network_peer]).
</description>
</method>
<method name="is_input_handled">
<return type="bool">
</return>
<description>
</description>
</method>
<method name="is_network_server" qualifiers="const">
<return type="bool">
</return>
<description>
Returns true if this SceneTree's [NetworkedMultiplayerPeer] is in server mode (listening for connections).
</description>
</method>
<method name="notify_group">
<return type="void">
</return>
<argument index="0" name="group" type="String">
</argument>
<argument index="1" name="notification" type="int">
</argument>
<description>
</description>
</method>
<method name="notify_group_flags">
<return type="void">
</return>
<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="queue_delete">
<return type="void">
</return>
<argument index="0" name="obj" type="Object">
</argument>
<description>
</description>
</method>
<method name="quit">
<return type="void">
</return>
<description>
</description>
</method>
<method name="reload_current_scene">
<return type="int" enum="Error">
</return>
<description>
</description>
</method>
<method name="set_auto_accept_quit">
<return type="void">
</return>
<argument index="0" name="enabled" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_group">
<return type="void">
</return>
<argument index="0" name="group" type="String">
</argument>
<argument index="1" name="property" type="String">
</argument>
<argument index="2" name="value" type="Variant">
</argument>
<description>
</description>
</method>
<method name="set_group_flags">
<return type="void">
</return>
<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="Variant">
</argument>
<description>
</description>
</method>
<method name="set_input_as_handled">
<return type="void">
</return>
<description>
</description>
</method>
doc: Sync classref with current source
2018-01-03 12:45:03 +00:00
<method name="set_quit_on_go_back">
<return type="void">
</return>
<argument index="0" name="enabled" type="bool">
</argument>
<description>
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<method name="set_screen_stretch">
<return type="void">
</return>
<argument index="0" name="mode" type="int" enum="SceneTree.StretchMode">
</argument>
<argument index="1" name="aspect" type="int" enum="SceneTree.StretchAspect">
</argument>
<argument index="2" name="minsize" type="Vector2">
</argument>
classref: Sync with current source
2017-10-21 10:02:08 +00:00
<argument index="3" name="shrink" type="float" default="1">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</argument>
<description>
</description>
</method>
</methods>
Update docs [ci skip]
2018-01-11 22:38:35 +00:00
<members>
<member name="current_scene" type="Node" setter="set_current_scene" getter="get_current_scene">
</member>
<member name="debug_collisions_hint" type="bool" setter="set_debug_collisions_hint" getter="is_debugging_collisions_hint">
</member>
<member name="debug_navigation_hint" type="bool" setter="set_debug_navigation_hint" getter="is_debugging_navigation_hint">
</member>
<member name="edited_scene_root" type="Node" setter="set_edited_scene_root" getter="get_edited_scene_root">
</member>
<member name="network_peer" type="NetworkedMultiplayerPeer" setter="set_network_peer" getter="get_network_peer">
The peer object to handle the RPC system (effectively enabling networking when set). Depending on the peer itself, the SceneTree will become a network server (check with [method is_network_server()]) and will set root node's network mode to master (see NETWORK_MODE_* constants in [Node]), or it will become a regular peer with root node set to slave. All child nodes are set to inherit the network mode by default. Handling of networking-related events (connection, disconnection, new clients) is done by connecting to SceneTree's signals.
</member>
<member name="paused" type="bool" setter="set_pause" getter="is_paused">
</member>
<member name="refuse_new_network_connections" type="bool" setter="set_refuse_new_network_connections" getter="is_refusing_new_network_connections">
</member>
<member name="root" type="Viewport" setter="" getter="get_root">
</member>
<member name="use_font_oversampling" type="bool" setter="set_use_font_oversampling" getter="is_using_font_oversampling">
</member>
</members>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<signals>
<signal name="connected_to_server">
<description>
</description>
</signal>
<signal name="connection_failed">
<description>
</description>
</signal>
<signal name="files_dropped">
<argument index="0" name="files" type="PoolStringArray">
</argument>
<argument index="1" name="screen" type="int">
</argument>
<description>
</description>
</signal>
<signal name="idle_frame">
<description>
</description>
</signal>
<signal name="network_peer_connected">
<argument index="0" name="id" type="int">
</argument>
<description>
</description>
</signal>
<signal name="network_peer_disconnected">
<argument index="0" name="id" type="int">
</argument>
<description>
</description>
</signal>
classref: Sync with current source
2017-10-21 10:02:08 +00:00
<signal name="node_added">
<argument index="0" name="node" type="Object">
</argument>
<description>
</description>
</signal>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<signal name="node_configuration_warning_changed">
<argument index="0" name="node" type="Object">
</argument>
<description>
</description>
</signal>
<signal name="node_removed">
<argument index="0" name="node" type="Object">
</argument>
<description>
</description>
</signal>
doc: Sync classref with current source Ensure that s/fixed_process/physics_process/ is handled properly. [ci skip]
2017-10-11 21:54:43 +00:00
<signal name="physics_frame">
<description>
</description>
</signal>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<signal name="screen_resized">
<description>
</description>
</signal>
<signal name="server_disconnected">
<description>
</description>
</signal>
<signal name="tree_changed">
<description>
</description>
</signal>
</signals>
<constants>
doc: Sync classref with current source
2018-01-03 12:45:03 +00:00
<constant name="GROUP_CALL_DEFAULT" value="0" enum="GroupCallFlags">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</constant>
doc: Sync classref with current source
2018-01-03 12:45:03 +00:00
<constant name="GROUP_CALL_REVERSE" value="1" enum="GroupCallFlags">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</constant>
doc: Sync classref with current source
2018-01-03 12:45:03 +00:00
<constant name="GROUP_CALL_REALTIME" value="2" enum="GroupCallFlags">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</constant>
doc: Sync classref with current source
2018-01-03 12:45:03 +00:00
<constant name="GROUP_CALL_UNIQUE" value="4" enum="GroupCallFlags">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="STRETCH_MODE_DISABLED" value="0" enum="StretchMode">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="STRETCH_MODE_2D" value="1" enum="StretchMode">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="STRETCH_MODE_VIEWPORT" value="2" enum="StretchMode">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="STRETCH_ASPECT_IGNORE" value="0" enum="StretchAspect">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="STRETCH_ASPECT_KEEP" value="1" enum="StretchAspect">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="STRETCH_ASPECT_KEEP_WIDTH" value="2" enum="StretchAspect">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="STRETCH_ASPECT_KEEP_HEIGHT" value="3" enum="StretchAspect">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="STRETCH_ASPECT_EXPAND" value="4" enum="StretchAspect">
doc: Sync classref with current source Ensure that s/fixed_process/physics_process/ is handled properly. [ci skip]
2017-10-11 21:54:43 +00:00
</constant>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</constants>
</class>