Merge pull request #23633 from Naryosha/docs-sync
doc: Sync classref with current source
This commit is contained in:
commit
2c0a2fbda3
14 changed files with 110 additions and 31 deletions
|
@ -745,6 +745,22 @@
|
|||
[/codeblock]
|
||||
</description>
|
||||
</method>
|
||||
<method name="push_error">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="message" type="String">
|
||||
</argument>
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="push_warning">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="message" type="String">
|
||||
</argument>
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="rad2deg">
|
||||
<return type="float">
|
||||
</return>
|
||||
|
|
|
@ -1298,10 +1298,6 @@
|
|||
</constant>
|
||||
<constant name="PROPERTY_USAGE_CATEGORY" value="256" enum="PropertyUsageFlags">
|
||||
</constant>
|
||||
<constant name="PROPERTY_USAGE_STORE_IF_NONZERO" value="512" enum="PropertyUsageFlags">
|
||||
</constant>
|
||||
<constant name="PROPERTY_USAGE_STORE_IF_NONONE" value="1024" enum="PropertyUsageFlags">
|
||||
</constant>
|
||||
<constant name="PROPERTY_USAGE_NO_INSTANCE_STATE" value="2048" enum="PropertyUsageFlags">
|
||||
</constant>
|
||||
<constant name="PROPERTY_USAGE_RESTART_IF_CHANGED" value="4096" enum="PropertyUsageFlags">
|
||||
|
|
|
@ -9,12 +9,6 @@
|
|||
<demos>
|
||||
</demos>
|
||||
<methods>
|
||||
<method name="get_playback_time" qualifiers="const">
|
||||
<return type="float">
|
||||
</return>
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
</methods>
|
||||
<members>
|
||||
<member name="animation" type="String" setter="set_animation" getter="get_animation">
|
||||
|
|
|
@ -39,8 +39,6 @@
|
|||
</member>
|
||||
<member name="angular_velocity_random" type="float" setter="set_param_randomness" getter="get_param_randomness">
|
||||
</member>
|
||||
<member name="anim_loop" type="bool" setter="set_particle_flag" getter="get_particle_flag">
|
||||
</member>
|
||||
<member name="anim_offset" type="float" setter="set_param" getter="get_param">
|
||||
</member>
|
||||
<member name="anim_offset_curve" type="Curve" setter="set_param_curve" getter="get_param_curve">
|
||||
|
@ -181,7 +179,7 @@
|
|||
</constant>
|
||||
<constant name="FLAG_ROTATE_Y" value="1" enum="Flags">
|
||||
</constant>
|
||||
<constant name="FLAG_MAX" value="4" enum="Flags">
|
||||
<constant name="FLAG_MAX" value="3" enum="Flags">
|
||||
</constant>
|
||||
<constant name="EMISSION_SHAPE_POINT" value="0" enum="EmissionShape">
|
||||
</constant>
|
||||
|
|
|
@ -39,8 +39,6 @@
|
|||
</member>
|
||||
<member name="angular_velocity_random" type="float" setter="set_param_randomness" getter="get_param_randomness">
|
||||
</member>
|
||||
<member name="anim_loop" type="bool" setter="set_particle_flag" getter="get_particle_flag">
|
||||
</member>
|
||||
<member name="anim_offset" type="float" setter="set_param" getter="get_param">
|
||||
</member>
|
||||
<member name="anim_offset_curve" type="Curve" setter="set_param_curve" getter="get_param_curve">
|
||||
|
@ -177,7 +175,7 @@
|
|||
</constant>
|
||||
<constant name="FLAG_ALIGN_Y_TO_VELOCITY" value="0" enum="Flags">
|
||||
</constant>
|
||||
<constant name="FLAG_MAX" value="2" enum="Flags">
|
||||
<constant name="FLAG_MAX" value="1" enum="Flags">
|
||||
</constant>
|
||||
<constant name="EMISSION_SHAPE_POINT" value="0" enum="EmissionShape">
|
||||
</constant>
|
||||
|
|
|
@ -19,6 +19,14 @@
|
|||
<member name="light_mode" type="int" setter="set_light_mode" getter="get_light_mode" enum="CanvasItemMaterial.LightMode">
|
||||
The manner in which material reacts to lighting.
|
||||
</member>
|
||||
<member name="particles_anim_h_frames" type="int" setter="set_particles_anim_h_frames" getter="get_particles_anim_h_frames">
|
||||
</member>
|
||||
<member name="particles_anim_loop" type="bool" setter="set_particles_anim_loop" getter="get_particles_anim_loop">
|
||||
</member>
|
||||
<member name="particles_anim_v_frames" type="int" setter="set_particles_anim_v_frames" getter="get_particles_anim_v_frames">
|
||||
</member>
|
||||
<member name="particles_animation" type="bool" setter="set_particles_animation" getter="get_particles_animation">
|
||||
</member>
|
||||
</members>
|
||||
<constants>
|
||||
<constant name="BLEND_MODE_MIX" value="0" enum="BlendMode">
|
||||
|
|
|
@ -41,6 +41,14 @@
|
|||
<description>
|
||||
</description>
|
||||
</signal>
|
||||
<signal name="property_toggled">
|
||||
<argument index="0" name="property" type="String">
|
||||
</argument>
|
||||
<argument index="1" name="checked" type="bool">
|
||||
</argument>
|
||||
<description>
|
||||
</description>
|
||||
</signal>
|
||||
<signal name="resource_selected">
|
||||
<argument index="0" name="res" type="Object">
|
||||
</argument>
|
||||
|
|
|
@ -166,6 +166,14 @@
|
|||
Returns whether or not the item at the specified index is disabled
|
||||
</description>
|
||||
</method>
|
||||
<method name="is_item_icon_transposed" qualifiers="const">
|
||||
<return type="bool">
|
||||
</return>
|
||||
<argument index="0" name="idx" type="int">
|
||||
</argument>
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="is_item_selectable" qualifiers="const">
|
||||
<return type="bool">
|
||||
</return>
|
||||
|
@ -289,6 +297,16 @@
|
|||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_item_icon_transposed">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="idx" type="int">
|
||||
</argument>
|
||||
<argument index="1" name="rect" type="bool">
|
||||
</argument>
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_item_metadata">
|
||||
<return type="void">
|
||||
</return>
|
||||
|
|
|
@ -42,9 +42,6 @@
|
|||
</member>
|
||||
<member name="fract_delta" type="bool" setter="set_fractional_delta" getter="get_fractional_delta">
|
||||
</member>
|
||||
<member name="h_frames" type="int" setter="set_h_frames" getter="get_h_frames">
|
||||
Number of horizontal frames in [code]texture[/code].
|
||||
</member>
|
||||
<member name="lifetime" type="float" setter="set_lifetime" getter="get_lifetime">
|
||||
Amount of time each particle will exist. Default value: [code]1[/code].
|
||||
</member>
|
||||
|
@ -71,9 +68,6 @@
|
|||
<member name="texture" type="Texture" setter="set_texture" getter="get_texture">
|
||||
Particle texture. If [code]null[/code] particles will be squares.
|
||||
</member>
|
||||
<member name="v_frames" type="int" setter="set_v_frames" getter="get_v_frames">
|
||||
Number of vertical frames in [code]texture[/code].
|
||||
</member>
|
||||
<member name="visibility_rect" type="Rect2" setter="set_visibility_rect" getter="get_visibility_rect">
|
||||
Editor visibility helper.
|
||||
</member>
|
||||
|
|
|
@ -32,9 +32,6 @@
|
|||
<member name="angular_velocity_random" type="float" setter="set_param_randomness" getter="get_param_randomness">
|
||||
Angular velocity randomness ratio. Default value: [code]0[/code].
|
||||
</member>
|
||||
<member name="anim_loop" type="bool" setter="set_flag" getter="get_flag">
|
||||
If [code]true[/code] animation will loop. Default value: [code]false[/code].
|
||||
</member>
|
||||
<member name="anim_offset" type="float" setter="set_param" getter="get_param">
|
||||
Particle animation offset.
|
||||
</member>
|
||||
|
@ -216,7 +213,7 @@
|
|||
<constant name="FLAG_ROTATE_Y" value="1" enum="Flags">
|
||||
Use with [method set_flag] to set [member flag_rotate_y]
|
||||
</constant>
|
||||
<constant name="FLAG_MAX" value="4" enum="Flags">
|
||||
<constant name="FLAG_MAX" value="3" enum="Flags">
|
||||
</constant>
|
||||
<constant name="EMISSION_SHAPE_POINT" value="0" enum="EmissionShape">
|
||||
All particles will be emitted from a single point.
|
||||
|
|
|
@ -75,6 +75,26 @@
|
|||
Additionally, the method can take an [code]exclude[/code] array of objects or [RID]s that are to be excluded from collisions, a [code]collision_mask[/code] bitmask representing the physics layers to check in, or booleans to determine if the ray should collide with [PhysicsBody]s or [Area]s, respectively.
|
||||
</description>
|
||||
</method>
|
||||
<method name="intersect_point_on_canvas">
|
||||
<return type="Array">
|
||||
</return>
|
||||
<argument index="0" name="point" type="Vector2">
|
||||
</argument>
|
||||
<argument index="1" name="canvas_instance_id" type="int">
|
||||
</argument>
|
||||
<argument index="2" name="max_results" type="int" default="32">
|
||||
</argument>
|
||||
<argument index="3" name="exclude" type="Array" default="[ ]">
|
||||
</argument>
|
||||
<argument index="4" name="collision_layer" type="int" default="2147483647">
|
||||
</argument>
|
||||
<argument index="5" name="collide_with_bodies" type="bool" default="true">
|
||||
</argument>
|
||||
<argument index="6" name="collide_with_areas" type="bool" default="false">
|
||||
</argument>
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="intersect_ray">
|
||||
<return type="Dictionary">
|
||||
</return>
|
||||
|
|
|
@ -24,6 +24,16 @@
|
|||
Adds a shape to the area, along with a transform matrix. Shapes are usually referenced by their index, so you should track which shape has a given index.
|
||||
</description>
|
||||
</method>
|
||||
<method name="area_attach_canvas_instance_id">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="area" type="RID">
|
||||
</argument>
|
||||
<argument index="1" name="id" type="int">
|
||||
</argument>
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="area_attach_object_instance_id">
|
||||
<return type="void">
|
||||
</return>
|
||||
|
@ -51,6 +61,14 @@
|
|||
Creates an [Area2D].
|
||||
</description>
|
||||
</method>
|
||||
<method name="area_get_canvas_instance_id" qualifiers="const">
|
||||
<return type="int">
|
||||
</return>
|
||||
<argument index="0" name="area" type="RID">
|
||||
</argument>
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="area_get_object_instance_id" qualifiers="const">
|
||||
<return type="int">
|
||||
</return>
|
||||
|
@ -377,6 +395,16 @@
|
|||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="body_attach_canvas_instance_id">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="body" type="RID">
|
||||
</argument>
|
||||
<argument index="1" name="id" type="int">
|
||||
</argument>
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="body_attach_object_instance_id">
|
||||
<return type="void">
|
||||
</return>
|
||||
|
@ -404,6 +432,14 @@
|
|||
Creates a physics body. The first parameter can be any value from constants BODY_MODE*, for the type of body created. Additionally, the body can be created in sleeping state to save processing time.
|
||||
</description>
|
||||
</method>
|
||||
<method name="body_get_canvas_instance_id" qualifiers="const">
|
||||
<return type="int">
|
||||
</return>
|
||||
<argument index="0" name="body" type="RID">
|
||||
</argument>
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="body_get_collision_layer" qualifiers="const">
|
||||
<return type="int">
|
||||
</return>
|
||||
|
|
|
@ -180,7 +180,7 @@
|
|||
<member name="particles_anim_h_frames" type="int" setter="set_particles_anim_h_frames" getter="get_particles_anim_h_frames">
|
||||
The number of horizontal frames in the particle spritesheet. Only enabled when using [code]BillboardMode.BILLBOARD_PARTICLES[/code]. See [member params_billboard_mode].
|
||||
</member>
|
||||
<member name="particles_anim_loop" type="int" setter="set_particles_anim_loop" getter="get_particles_anim_loop">
|
||||
<member name="particles_anim_loop" type="bool" setter="set_particles_anim_loop" getter="get_particles_anim_loop">
|
||||
If [code]true[/code] particle animations are looped. Only enabled when using [code]BillboardMode.BILLBOARD_PARTICLES[/code]. See [member params_billboard_mode].
|
||||
</member>
|
||||
<member name="particles_anim_v_frames" type="int" setter="set_particles_anim_v_frames" getter="get_particles_anim_v_frames">
|
||||
|
|
|
@ -239,10 +239,6 @@
|
|||
</argument>
|
||||
<argument index="3" name="normal_map" type="RID">
|
||||
</argument>
|
||||
<argument index="4" name="h_frames" type="int">
|
||||
</argument>
|
||||
<argument index="5" name="v_frames" type="int">
|
||||
</argument>
|
||||
<description>
|
||||
Adds a particles system to the [CanvasItem]'s draw commands.
|
||||
</description>
|
||||
|
|
Loading…
Reference in a new issue