aboutsummaryrefslogtreecommitdiff
path: root/doc/classes/SceneTree.xml
diff options
context:
space:
mode:
authorJuan Linietsky2017-09-12 17:42:36 -0300
committerJuan Linietsky2017-09-12 17:45:41 -0300
commit4f929a0fdfae24b1ca5acf0b732219119090ee43 (patch)
tree730471182cae00f2e47c7430db441d057383d29b /doc/classes/SceneTree.xml
parent175777596ec3521731665dd750fd7087793b10fc (diff)
downloadgodot-4f929a0fdfae24b1ca5acf0b732219119090ee43.tar.gz
godot-4f929a0fdfae24b1ca5acf0b732219119090ee43.tar.zst
godot-4f929a0fdfae24b1ca5acf0b732219119090ee43.zip
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.
Diffstat (limited to 'doc/classes/SceneTree.xml')
-rw-r--r--doc/classes/SceneTree.xml408
1 files changed, 408 insertions, 0 deletions
diff --git a/doc/classes/SceneTree.xml b/doc/classes/SceneTree.xml
new file mode 100644
index 000000000..c40d9339d
--- /dev/null
+++ b/doc/classes/SceneTree.xml
@@ -0,0 +1,408 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<class name="SceneTree" inherits="MainLoop" category="Core" version="3.0.alpha.custom_build">
+ <brief_description>
+ </brief_description>
+ <description>
+ </description>
+ <tutorials>
+ </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_current_scene" qualifiers="const">
+ <return type="Node">
+ </return>
+ <description>
+ </description>
+ </method>
+ <method name="get_edited_scene_root" qualifiers="const">
+ <return type="Node">
+ </return>
+ <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_root" qualifiers="const">
+ <return type="Viewport">
+ </return>
+ <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_debugging_collisions_hint" qualifiers="const">
+ <return type="bool">
+ </return>
+ <description>
+ </description>
+ </method>
+ <method name="is_debugging_navigation_hint" qualifiers="const">
+ <return type="bool">
+ </return>
+ <description>
+ </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="is_paused" qualifiers="const">
+ <return type="bool">
+ </return>
+ <description>
+ </description>
+ </method>
+ <method name="is_refusing_new_network_connections" qualifiers="const">
+ <return type="bool">
+ </return>
+ <description>
+ </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_current_scene">
+ <return type="void">
+ </return>
+ <argument index="0" name="child_node" type="Node">
+ </argument>
+ <description>
+ </description>
+ </method>
+ <method name="set_debug_collisions_hint">
+ <return type="void">
+ </return>
+ <argument index="0" name="enable" type="bool">
+ </argument>
+ <description>
+ </description>
+ </method>
+ <method name="set_debug_navigation_hint">
+ <return type="void">
+ </return>
+ <argument index="0" name="enable" type="bool">
+ </argument>
+ <description>
+ </description>
+ </method>
+ <method name="set_edited_scene_root">
+ <return type="void">
+ </return>
+ <argument index="0" name="scene" type="Node">
+ </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>
+ <method name="set_network_peer">
+ <return type="void">
+ </return>
+ <argument index="0" name="peer" type="NetworkedMultiplayerPeer">
+ </argument>
+ <description>
+ Set the peer object to handle the RPC system (effectively enabling networking). 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.
+ </description>
+ </method>
+ <method name="set_pause">
+ <return type="void">
+ </return>
+ <argument index="0" name="enable" type="bool">
+ </argument>
+ <description>
+ </description>
+ </method>
+ <method name="set_refuse_new_network_connections">
+ <return type="void">
+ </return>
+ <argument index="0" name="refuse" type="bool">
+ </argument>
+ <description>
+ </description>
+ </method>
+ <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>
+ <argument index="3" name="shrink" type="int" default="1">
+ </argument>
+ <description>
+ </description>
+ </method>
+ </methods>
+ <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="fixed_frame">
+ <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>
+ <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>
+ <signal name="screen_resized">
+ <description>
+ </description>
+ </signal>
+ <signal name="server_disconnected">
+ <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>
+ <constant name="STRETCH_MODE_DISABLED" value="0">
+ </constant>
+ <constant name="STRETCH_MODE_2D" value="1">
+ </constant>
+ <constant name="STRETCH_MODE_VIEWPORT" value="2">
+ </constant>
+ <constant name="STRETCH_ASPECT_IGNORE" value="0">
+ </constant>
+ <constant name="STRETCH_ASPECT_KEEP" value="1">
+ </constant>
+ <constant name="STRETCH_ASPECT_KEEP_WIDTH" value="2">
+ </constant>
+ <constant name="STRETCH_ASPECT_KEEP_HEIGHT" value="3">
+ </constant>
+ </constants>
+</class>