mirror of
https://github.com/Relintai/pandemonium_engine.git
synced 2025-01-11 13:21:10 +01:00
Re-extracted class docs.
This commit is contained in:
parent
8e6d7ea9b0
commit
b6624bf30b
@ -332,6 +332,11 @@
|
||||
Returns the node's [Viewport].
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_world" qualifiers="const">
|
||||
<return type="World" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="has_network_peer">
|
||||
<return type="bool" />
|
||||
<description>
|
||||
|
||||
@ -1898,10 +1898,6 @@
|
||||
</member>
|
||||
<member name="thread_pool/max_work_per_frame_percent" type="int" setter="" getter="" default="25">
|
||||
</member>
|
||||
<member name="thread_pool/queue_grow_size" type="int" setter="" getter="" default="10">
|
||||
</member>
|
||||
<member name="thread_pool/queue_start_size" type="int" setter="" getter="" default="20">
|
||||
</member>
|
||||
<member name="thread_pool/thread_count" type="int" setter="" getter="" default="-1">
|
||||
</member>
|
||||
<member name="thread_pool/thread_fallback_count" type="int" setter="" getter="" default="4">
|
||||
|
||||
@ -31,8 +31,13 @@
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="register_update">
|
||||
<return type="void" />
|
||||
<method name="is_working" qualifiers="const">
|
||||
<return type="bool" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="is_working_no_lock" qualifiers="const">
|
||||
<return type="bool" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<class name="Viewport" inherits="Node" version="3.8">
|
||||
<class name="Viewport" inherits="World" version="3.8">
|
||||
<brief_description>
|
||||
Creates a sub-view into the screen.
|
||||
</brief_description>
|
||||
@ -23,36 +23,12 @@
|
||||
<link title="3D Viewport Scaling Demo">https://godotengine.org/asset-library/asset/586</link>
|
||||
</tutorials>
|
||||
<methods>
|
||||
<method name="find_world_3d" qualifiers="const">
|
||||
<return type="World3D" />
|
||||
<description>
|
||||
Returns the first valid [World3D] for this viewport, searching the [member world] property of itself and any Viewport ancestor.
|
||||
</description>
|
||||
</method>
|
||||
<method name="find_world_2d" qualifiers="const">
|
||||
<return type="World2D" />
|
||||
<description>
|
||||
Returns the first valid [World2D] for this viewport, searching the [member world_2d] property of itself and any Viewport ancestor.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_camera" qualifiers="const">
|
||||
<return type="Camera" />
|
||||
<description>
|
||||
Returns the active 3D camera.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_camera_2d" qualifiers="const">
|
||||
<return type="Camera2D" />
|
||||
<description>
|
||||
Returns the currently active 2D camera. Returns null if there are no active cameras.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_final_transform" qualifiers="const">
|
||||
<return type="Transform2D" />
|
||||
<description>
|
||||
Returns the total transform of the viewport.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_modal_stack_top" qualifiers="const">
|
||||
<return type="Control" />
|
||||
<description>
|
||||
@ -96,18 +72,6 @@
|
||||
[/codeblock]
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_viewport_rid" qualifiers="const">
|
||||
<return type="RID" />
|
||||
<description>
|
||||
Returns the viewport's RID from the [RenderingServer].
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_visible_rect" qualifiers="const">
|
||||
<return type="Rect2" />
|
||||
<description>
|
||||
Returns the visible rectangle in global screen coordinates.
|
||||
</description>
|
||||
</method>
|
||||
<method name="gui_get_drag_data" qualifiers="const">
|
||||
<return type="Variant" />
|
||||
<description>
|
||||
@ -186,12 +150,6 @@
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="update_worlds">
|
||||
<return type="void" />
|
||||
<description>
|
||||
Forces update of the 2D and 3D worlds.
|
||||
</description>
|
||||
</method>
|
||||
<method name="warp_mouse">
|
||||
<return type="void" />
|
||||
<argument index="0" name="to_position" type="Vector2" />
|
||||
@ -207,9 +165,6 @@
|
||||
<member name="audio_listener_enable_3d" type="bool" setter="set_as_audio_listener" getter="is_audio_listener" default="false">
|
||||
If [code]true[/code], the viewport will process 3D audio streams.
|
||||
</member>
|
||||
<member name="canvas_transform" type="Transform2D" setter="set_canvas_transform" getter="get_canvas_transform">
|
||||
The canvas transform of the viewport, useful for changing the on-screen positions of all child [CanvasItem]s. This is relative to the global canvas transform of the viewport.
|
||||
</member>
|
||||
<member name="debanding" type="bool" setter="set_use_debanding" getter="get_use_debanding" default="false">
|
||||
If [code]true[/code], uses a fast post-processing filter to make banding significantly less visible. In some cases, debanding may introduce a slightly noticeable dithering pattern. It's recommended to enable debanding only when actually needed since the dithering pattern will make lossless-compressed screenshots larger.
|
||||
[b]Note:[/b] Only available on the GLES3 backend. [member hdr] must also be [code]true[/code] for debanding to be effective.
|
||||
@ -223,9 +178,6 @@
|
||||
<member name="fxaa" type="bool" setter="set_use_fxaa" getter="get_use_fxaa" default="false">
|
||||
Enables fast approximate antialiasing. FXAA is a popular screen-space antialiasing method, which is fast but will make the image look blurry, especially at lower resolutions. It can still work relatively well at large resolutions such as 1440p and 4K. Some of the lost sharpness can be recovered by enabling contrast-adaptive sharpening (see [member sharpen_intensity]).
|
||||
</member>
|
||||
<member name="global_canvas_transform" type="Transform2D" setter="set_global_canvas_transform" getter="get_global_canvas_transform">
|
||||
The global canvas transform of the viewport. The canvas transform is relative to this.
|
||||
</member>
|
||||
<member name="gui_disable_input" type="bool" setter="set_disable_input" getter="is_input_disabled" default="false">
|
||||
If [code]true[/code], the viewport will not receive input events.
|
||||
</member>
|
||||
@ -245,9 +197,6 @@
|
||||
<member name="msaa" type="int" setter="set_msaa" getter="get_msaa" enum="Viewport.MSAA" default="0">
|
||||
The multisample anti-aliasing mode. A higher number results in smoother edges at the cost of significantly worse performance. A value of 4 is best unless targeting very high-end systems.
|
||||
</member>
|
||||
<member name="own_world_3d" type="bool" setter="set_use_own_world_3d" getter="is_using_own_world_3d" default="false">
|
||||
If [code]true[/code], the viewport will use a unique copy of the [World3D] defined in [member world].
|
||||
</member>
|
||||
<member name="physics_object_picking" type="bool" setter="set_physics_object_picking" getter="get_physics_object_picking" default="false">
|
||||
If [code]true[/code], the objects rendered by viewport become subjects of mouse picking process.
|
||||
</member>
|
||||
@ -301,12 +250,6 @@
|
||||
[b]Note:[/b] Enabling this setting does not improve rendering quality. Using full floating-point precision is slower, and is generally only needed for advanced shaders that require a high level of precision. To reduce banding, enable [member debanding] instead.
|
||||
[b]Note:[/b] Only available on the GLES3 backend.
|
||||
</member>
|
||||
<member name="world" type="World3D" setter="set_world_3d" getter="get_world_3d">
|
||||
The custom [World3D] which can be used as 3D environment source.
|
||||
</member>
|
||||
<member name="world_2d" type="World2D" setter="set_world_2d" getter="get_world_2d">
|
||||
The custom [World2D] which can be used as 2D environment source.
|
||||
</member>
|
||||
</members>
|
||||
<signals>
|
||||
<signal name="gui_focus_changed">
|
||||
|
||||
@ -37,13 +37,13 @@
|
||||
</description>
|
||||
</signal>
|
||||
<signal name="viewport_entered">
|
||||
<argument index="0" name="viewport" type="World" />
|
||||
<argument index="0" name="world" type="World" />
|
||||
<description>
|
||||
Emitted when the VisibilityNotifier2D enters a [Viewport]'s view.
|
||||
</description>
|
||||
</signal>
|
||||
<signal name="viewport_exited">
|
||||
<argument index="0" name="viewport" type="World" />
|
||||
<argument index="0" name="world" type="World" />
|
||||
<description>
|
||||
Emitted when the VisibilityNotifier2D exits a [Viewport]'s view.
|
||||
</description>
|
||||
|
||||
78
doc/classes/World.xml
Normal file
78
doc/classes/World.xml
Normal file
@ -0,0 +1,78 @@
|
||||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<class name="World" inherits="Node" version="3.8">
|
||||
<brief_description>
|
||||
</brief_description>
|
||||
<description>
|
||||
</description>
|
||||
<tutorials>
|
||||
</tutorials>
|
||||
<methods>
|
||||
<method name="find_world_2d" qualifiers="const">
|
||||
<return type="World2D" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="find_world_3d" qualifiers="const">
|
||||
<return type="World3D" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_camera" qualifiers="const">
|
||||
<return type="Camera" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_final_transform" qualifiers="const">
|
||||
<return type="Transform2D" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_override_world">
|
||||
<return type="World" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_override_world_or_this">
|
||||
<return type="World" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_viewport_rid" qualifiers="const">
|
||||
<return type="RID" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_visible_rect" qualifiers="const">
|
||||
<return type="Rect2" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_override_world">
|
||||
<return type="void" />
|
||||
<argument index="0" name="world" type="Node" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="update_worlds">
|
||||
<return type="void" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
</methods>
|
||||
<members>
|
||||
<member name="canvas_transform" type="Transform2D" setter="set_canvas_transform" getter="get_canvas_transform">
|
||||
</member>
|
||||
<member name="global_canvas_transform" type="Transform2D" setter="set_global_canvas_transform" getter="get_global_canvas_transform">
|
||||
</member>
|
||||
<member name="override_in_parent_viewport" type="bool" setter="set_override_in_parent_viewport" getter="get_override_in_parent_viewport" default="false">
|
||||
</member>
|
||||
<member name="own_world_3d" type="bool" setter="set_use_own_world_3d" getter="is_using_own_world_3d" default="false">
|
||||
</member>
|
||||
<member name="world" type="World3D" setter="set_world_3d" getter="get_world_3d">
|
||||
</member>
|
||||
<member name="world_2d" type="World2D" setter="set_world_2d" getter="get_world_2d">
|
||||
</member>
|
||||
</members>
|
||||
<constants>
|
||||
</constants>
|
||||
</class>
|
||||
@ -15,7 +15,7 @@
|
||||
</method>
|
||||
</methods>
|
||||
<members>
|
||||
<member name="amount_absorbed" type="int" setter="amount_absorbed_set" getter="amount_absorbed_get" default="-2004318072">
|
||||
<member name="amount_absorbed" type="int" setter="amount_absorbed_set" getter="amount_absorbed_get" default="0">
|
||||
</member>
|
||||
<member name="aura_source" type="Spell" setter="aura_source_set" getter="aura_source_get">
|
||||
</member>
|
||||
|
||||
@ -15,7 +15,7 @@
|
||||
</method>
|
||||
</methods>
|
||||
<members>
|
||||
<member name="amount_absorbed" type="int" setter="amount_absorbed_set" getter="amount_absorbed_get" default="-2004318072">
|
||||
<member name="amount_absorbed" type="int" setter="amount_absorbed_set" getter="amount_absorbed_get" default="0">
|
||||
</member>
|
||||
<member name="aura_source" type="Spell" setter="aura_source_set" getter="aura_source_get">
|
||||
</member>
|
||||
|
||||
@ -7,12 +7,57 @@
|
||||
<tutorials>
|
||||
</tutorials>
|
||||
<methods>
|
||||
<method name="center_paint_canvas">
|
||||
<return type="void" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="change_color">
|
||||
<return type="void" />
|
||||
<argument index="0" name="color" type="Color" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="clear_image">
|
||||
<return type="void" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_bottom_content_panel">
|
||||
<return type="Control" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_image">
|
||||
<return type="Image" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_left_content_panel">
|
||||
<return type="Control" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_navbar">
|
||||
<return type="Control" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_paint_canvas">
|
||||
<return type="Control" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_right_panel_container">
|
||||
<return type="Control" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_text_info_control">
|
||||
<return type="Control" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="lock_layer">
|
||||
<return type="void" />
|
||||
<argument index="0" name="arg0" type="Node" />
|
||||
@ -32,6 +77,13 @@
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="new_image">
|
||||
<return type="void" />
|
||||
<argument index="0" name="x" type="int" />
|
||||
<argument index="1" name="y" type="int" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="select_layer">
|
||||
<return type="void" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
@ -45,12 +97,52 @@
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="window_fit_paint_canvas">
|
||||
<return type="void" />
|
||||
<argument index="0" name="ratio" type="float" default="0.8" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
</methods>
|
||||
<members>
|
||||
<member name="allow_canvas_move" type="bool" setter="set_allow_canvas_move" getter="get_allow_canvas_move" default="true">
|
||||
</member>
|
||||
<member name="allow_canvas_zoom" type="bool" setter="set_allow_canvas_zoom" getter="get_allow_canvas_zoom" default="true">
|
||||
</member>
|
||||
<member name="brush_size" type="int" setter="set_brush_size" getter="get_brush_size" default="1">
|
||||
</member>
|
||||
<member name="brush_type" type="int" setter="set_brush_type" getter="get_brush_type" default="3">
|
||||
</member>
|
||||
<member name="rect_clip_content" type="bool" setter="set_clip_contents" getter="is_clipping_contents" overrides="Control" default="true" />
|
||||
<member name="selected_color" type="Color" setter="set_selected_color" getter="get_selected_color" default="Color( 1, 1, 1, 1 )">
|
||||
</member>
|
||||
<member name="size_flags_horizontal" type="int" setter="set_h_size_flags" getter="get_h_size_flags" overrides="Control" default="3" />
|
||||
<member name="size_flags_vertical" type="int" setter="set_v_size_flags" getter="get_v_size_flags" overrides="Control" default="3" />
|
||||
<member name="tool" type="int" setter="set_tool" getter="get_tool" default="0">
|
||||
</member>
|
||||
</members>
|
||||
<constants>
|
||||
<constant name="PAINT" value="0" enum="Tools">
|
||||
</constant>
|
||||
<constant name="BRUSH" value="1" enum="Tools">
|
||||
</constant>
|
||||
<constant name="BUCKET" value="2" enum="Tools">
|
||||
</constant>
|
||||
<constant name="RAINBOW" value="3" enum="Tools">
|
||||
</constant>
|
||||
<constant name="LINE" value="4" enum="Tools">
|
||||
</constant>
|
||||
<constant name="RECT" value="5" enum="Tools">
|
||||
</constant>
|
||||
<constant name="DARKEN" value="6" enum="Tools">
|
||||
</constant>
|
||||
<constant name="BRIGHTEN" value="7" enum="Tools">
|
||||
</constant>
|
||||
<constant name="COLORPICKER" value="8" enum="Tools">
|
||||
</constant>
|
||||
<constant name="CUT" value="9" enum="Tools">
|
||||
</constant>
|
||||
<constant name="PASTECUT" value="10" enum="Tools">
|
||||
</constant>
|
||||
</constants>
|
||||
</class>
|
||||
|
||||
@ -357,6 +357,12 @@
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="cols">
|
||||
<return type="_HTMLTag" />
|
||||
<argument index="0" name="val" type="String" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="content">
|
||||
<return type="_HTMLTag" />
|
||||
<argument index="0" name="val" type="String" />
|
||||
@ -369,6 +375,17 @@
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="enctype">
|
||||
<return type="_HTMLTag" />
|
||||
<argument index="0" name="val" type="String" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="enctype_multipart_form_data">
|
||||
<return type="_HTMLTag" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="f">
|
||||
<return type="_HTMLBuilder" />
|
||||
<description>
|
||||
@ -740,6 +757,12 @@
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="rows">
|
||||
<return type="_HTMLTag" />
|
||||
<argument index="0" name="val" type="String" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="selected">
|
||||
<return type="_HTMLTag" />
|
||||
<argument index="0" name="val" type="bool" default="true" />
|
||||
|
||||
@ -49,7 +49,7 @@
|
||||
<member name="max_visible_navigation_links" type="int" setter="set_max_visible_navigation_links" getter="get_max_visible_navigation_links" default="6">
|
||||
This many pagination links will be visible max.
|
||||
</member>
|
||||
<member name="paginate" type="bool" setter="set_paginate" getter="get_paginate" default="true">
|
||||
<member name="paginate" type="bool" setter="set_paginate" getter="get_paginate" default="false">
|
||||
Whether to allow pagination or not.
|
||||
</member>
|
||||
<member name="placeholder_text" type="String" setter="set_placeholder_text" getter="get_placeholder_text" default=""No content yet!"">
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<class name="WebPermission" inherits="Reference" version="3.8">
|
||||
<class name="WebPermission" inherits="Resource" version="3.8">
|
||||
<brief_description>
|
||||
</brief_description>
|
||||
<description>
|
||||
|
||||
@ -324,7 +324,7 @@
|
||||
<method name="send_redirect">
|
||||
<return type="void" />
|
||||
<argument index="0" name="location" type="String" />
|
||||
<argument index="1" name="status_code " type="int" enum="HTTPServerEnums.HTTPStatusCode" />
|
||||
<argument index="1" name="status_code" type="int" enum="HTTPServerEnums.HTTPStatusCode" default="302" />
|
||||
<description>
|
||||
Sends a redirect http header.
|
||||
</description>
|
||||
|
||||
Loading…
Reference in New Issue
Block a user