maxmustermann/godot
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

doc: Fix enum tags thanks to 2bc6db6

Browse source
This commit is contained in:
Rémi Verschelde 2017-11-24 23:16:30 +01:00
parent 2bc6db65c1
commit 7dfba3cda9
133 changed files with 2117 additions and 2060 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
doc/classes/@GDScript.xml
View file

@ -1138,16 +1138,16 @@
</method>
</methods>
<constants>
<constant name="PI" value="3.141593" enum="">
<constant name="PI" value="3.141593">
Constant that represents how many times the diameter of a circle fits around its perimeter.
</constant>
<constant name="TAU" value="6.283185" enum="">
<constant name="TAU" value="6.283185">
The circle constant, the circumference of the unit circle.
</constant>
<constant name="INF" value="inf" enum="">
<constant name="INF" value="inf">
A positive infinity. (For negative infinity, use -INF).
</constant>
<constant name="NAN" value="nan" enum="">
<constant name="NAN" value="nan">
Macro constant that expands to an expression of type float that represents a NaN.
The NaN values are used to identify undefined or non-representable values for floating-point elements, such as the square root of negative numbers or the result of 0/0.
</constant>

896
doc/classes/@GlobalScope.xml
View file

File diff suppressed because it is too large Load diff

26
doc/classes/ARVRInterface.xml
View file

@ -78,43 +78,43 @@
</member>
</members>
<constants>
<constant name="ARVR_NONE" value="0">
<constant name="ARVR_NONE" value="0" enum="Capabilities">
No ARVR capabilities.
</constant>
<constant name="ARVR_MONO" value="1">
<constant name="ARVR_MONO" value="1" enum="Capabilities">
This interface can work with normal rendering output (non-HMD based AR).
</constant>
<constant name="ARVR_STEREO" value="2">
<constant name="ARVR_STEREO" value="2" enum="Capabilities">
This interface supports stereoscopic rendering.
</constant>
<constant name="ARVR_AR" value="4">
<constant name="ARVR_AR" value="4" enum="Capabilities">
This interface support AR (video background and real world tracking).
</constant>
<constant name="ARVR_EXTERNAL" value="8">
<constant name="ARVR_EXTERNAL" value="8" enum="Capabilities">
This interface outputs to an external device, if the main viewport is used the on screen output is an unmodified buffer of either the left or right eye (stretched if the viewport size is not changed to the same aspect ratio of get_render_targetsize. Using a seperate viewport node frees up the main viewport for other purposes.
</constant>
<constant name="EYE_MONO" value="0">
<constant name="EYE_MONO" value="0" enum="Eyes">
Mono output, this is mostly used internally when retrieving positioning information for our camera node or when stereo scopic rendering is not supported.
</constant>
<constant name="EYE_LEFT" value="1">
<constant name="EYE_LEFT" value="1" enum="Eyes">
Left eye output, this is mostly used internally when rendering the image for the left eye and obtaining positioning and projection information.
</constant>
<constant name="EYE_RIGHT" value="2">
<constant name="EYE_RIGHT" value="2" enum="Eyes">
Right eye output, this is mostly used internally when rendering the image for the right eye and obtaining positioning and projection information.
</constant>
<constant name="ARVR_NORMAL_TRACKING" value="0">
<constant name="ARVR_NORMAL_TRACKING" value="0" enum="Tracking_status">
Tracking is behaving as expected.
</constant>
<constant name="ARVR_EXCESSIVE_MOTION" value="1">
<constant name="ARVR_EXCESSIVE_MOTION" value="1" enum="Tracking_status">
Tracking is hindered by excessive motion, player is moving faster then tracking can keep up.
</constant>
<constant name="ARVR_INSUFFICIENT_FEATURES" value="2">
<constant name="ARVR_INSUFFICIENT_FEATURES" value="2" enum="Tracking_status">
Tracking is hindered by insufficient features, it's too dark (for camera based tracking), player is blocked, etc.
</constant>
<constant name="ARVR_UNKNOWN_TRACKING" value="3">
<constant name="ARVR_UNKNOWN_TRACKING" value="3" enum="Tracking_status">
We don't know the status of the tracking or this interface does not provide feedback.
</constant>
<constant name="ARVR_NOT_TRACKING" value="4">
<constant name="ARVR_NOT_TRACKING" value="4" enum="Tracking_status">
Tracking is not functional (camera not plugged in or obscured, lighthouses turned off, etc.)
</constant>
</constants>

6
doc/classes/ARVRPositionalTracker.xml
View file

@ -84,13 +84,13 @@
</member>
</members>
<constants>
<constant name="TRACKER_HAND_UNKNOWN" value="0">
<constant name="TRACKER_HAND_UNKNOWN" value="0" enum="TrackerHand">
The hand this tracker is held in is unknown or not applicable.
</constant>
<constant name="TRACKER_LEFT_HAND" value="1">
<constant name="TRACKER_LEFT_HAND" value="1" enum="TrackerHand">
This tracker is the left hand controller.
</constant>
<constant name="TRACKER_RIGHT_HAND" value="2">
<constant name="TRACKER_RIGHT_HAND" value="2" enum="TrackerHand">
This tracker is the right hand controller.
</constant>
</constants>

12
doc/classes/ARVRServer.xml
View file

@ -136,22 +136,22 @@
</signal>
</signals>
<constants>
<constant name="TRACKER_CONTROLLER" value="1">
<constant name="TRACKER_CONTROLLER" value="1" enum="TrackerType">
Our tracker tracks the location of a controller.
</constant>
<constant name="TRACKER_BASESTATION" value="2">
<constant name="TRACKER_BASESTATION" value="2" enum="TrackerType">
Our tracker tracks the location of a base station.
</constant>
<constant name="TRACKER_ANCHOR" value="4">
<constant name="TRACKER_ANCHOR" value="4" enum="TrackerType">
Our tracker tracks the location and size of an AR anchor.
</constant>
<constant name="TRACKER_ANY_KNOWN" value="127">
<constant name="TRACKER_ANY_KNOWN" value="127" enum="TrackerType">
Used internally to filter trackers of any known type.
</constant>
<constant name="TRACKER_UNKNOWN" value="128">
<constant name="TRACKER_UNKNOWN" value="128" enum="TrackerType">
Used internally if we haven't set the tracker type yet.
</constant>
<constant name="TRACKER_ANY" value="255">
<constant name="TRACKER_ANY" value="255" enum="TrackerType">
Used internally to select all trackers.
</constant>
</constants>

18
doc/classes/Animation.xml
View file

@ -424,31 +424,31 @@
</method>
</methods>
<constants>
<constant name="TYPE_VALUE" value="0">
<constant name="TYPE_VALUE" value="0" enum="TrackType">
Value tracks set values in node properties, but only those which can be Interpolated.
</constant>
<constant name="TYPE_TRANSFORM" value="1">
<constant name="TYPE_TRANSFORM" value="1" enum="TrackType">
Transform tracks are used to change node local transforms or skeleton pose bones. Transitions are Interpolated.
</constant>
<constant name="TYPE_METHOD" value="2">
<constant name="TYPE_METHOD" value="2" enum="TrackType">
Method tracks call functions with given arguments per key.
</constant>
<constant name="INTERPOLATION_NEAREST" value="0">
<constant name="INTERPOLATION_NEAREST" value="0" enum="InterpolationType">
No interpolation (nearest value).
</constant>
<constant name="INTERPOLATION_LINEAR" value="1">
<constant name="INTERPOLATION_LINEAR" value="1" enum="InterpolationType">
Linear interpolation.
</constant>
<constant name="INTERPOLATION_CUBIC" value="2">
<constant name="INTERPOLATION_CUBIC" value="2" enum="InterpolationType">
Cubic interpolation.
</constant>
<constant name="UPDATE_CONTINUOUS" value="0">
<constant name="UPDATE_CONTINUOUS" value="0" enum="UpdateMode">
Update between keyframes.
</constant>
<constant name="UPDATE_DISCRETE" value="1">
<constant name="UPDATE_DISCRETE" value="1" enum="UpdateMode">
Update at the keyframes and hold the value.
</constant>
<constant name="UPDATE_TRIGGER" value="2">
<constant name="UPDATE_TRIGGER" value="2" enum="UpdateMode">
Update at the keyframes.
</constant>
</constants>

4
doc/classes/AnimationPlayer.xml
View file

@ -332,10 +332,10 @@
</signal>
</signals>
<constants>
<constant name="ANIMATION_PROCESS_PHYSICS" value="0">
<constant name="ANIMATION_PROCESS_PHYSICS" value="0" enum="AnimationProcessMode">
Process animation during the physics process. This is especially useful when animating physics bodies.
</constant>
<constant name="ANIMATION_PROCESS_IDLE" value="1">
<constant name="ANIMATION_PROCESS_IDLE" value="1" enum="AnimationProcessMode">
Process animation during the idle process.
</constant>
</constants>

24
doc/classes/AnimationTreePlayer.xml
View file

@ -613,39 +613,39 @@
</member>
</members>
<constants>
<constant name="NODE_OUTPUT" value="0">
<constant name="NODE_OUTPUT" value="0" enum="NodeType">
Output node.
</constant>
<constant name="NODE_ANIMATION" value="1">
<constant name="NODE_ANIMATION" value="1" enum="NodeType">
Animation node.
</constant>
<constant name="NODE_ONESHOT" value="2">
<constant name="NODE_ONESHOT" value="2" enum="NodeType">
OneShot node.
</constant>
<constant name="NODE_MIX" value="3">
<constant name="NODE_MIX" value="3" enum="NodeType">
Mix node.
</constant>
<constant name="NODE_BLEND2" value="4">
<constant name="NODE_BLEND2" value="4" enum="NodeType">
Blend2 node.
</constant>
<constant name="NODE_BLEND3" value="5">
<constant name="NODE_BLEND3" value="5" enum="NodeType">
Blend3 node.
</constant>
<constant name="NODE_BLEND4" value="6">
<constant name="NODE_BLEND4" value="6" enum="NodeType">
Blend4 node.
</constant>
<constant name="NODE_TIMESCALE" value="7">
<constant name="NODE_TIMESCALE" value="7" enum="NodeType">
TimeScale node.
</constant>
<constant name="NODE_TIMESEEK" value="8">
<constant name="NODE_TIMESEEK" value="8" enum="NodeType">
TimeSeek node.
</constant>
<constant name="NODE_TRANSITION" value="9">
<constant name="NODE_TRANSITION" value="9" enum="NodeType">
Transition node.
</constant>
<constant name="ANIMATION_PROCESS_PHYSICS" value="0">
<constant name="ANIMATION_PROCESS_PHYSICS" value="0" enum="AnimationProcessMode">
</constant>
<constant name="ANIMATION_PROCESS_IDLE" value="1">
<constant name="ANIMATION_PROCESS_IDLE" value="1" enum="AnimationProcessMode">
</constant>
</constants>
</class>

10
doc/classes/Area.xml
View file

@ -219,19 +219,19 @@
</signal>
</signals>
<constants>
<constant name="SPACE_OVERRIDE_DISABLED" value="0">
<constant name="SPACE_OVERRIDE_DISABLED" value="0" enum="SpaceOverride">
This area does not affect gravity/damping.
</constant>
<constant name="SPACE_OVERRIDE_COMBINE" value="1">
<constant name="SPACE_OVERRIDE_COMBINE" value="1" enum="SpaceOverride">
This area adds its gravity/damping values to whatever has been calculated so far (in [code]priority[/code] order).
</constant>
<constant name="SPACE_OVERRIDE_COMBINE_REPLACE" value="2">
<constant name="SPACE_OVERRIDE_COMBINE_REPLACE" value="2" enum="SpaceOverride">
This area adds its gravity/damping values to whatever has been calculated so far (in [code]priority[/code] order), ignoring any lower priority areas.
</constant>
<constant name="SPACE_OVERRIDE_REPLACE" value="3">
<constant name="SPACE_OVERRIDE_REPLACE" value="3" enum="SpaceOverride">
This area replaces any gravity/damping, even the defaults, ignoring any lower priority areas.
</constant>
<constant name="SPACE_OVERRIDE_REPLACE_COMBINE" value="4">
<constant name="SPACE_OVERRIDE_REPLACE_COMBINE" value="4" enum="SpaceOverride">
This area replaces any gravity/damping calculated so far (in [code]priority[/code] order), but keeps calculating the rest of the areas.
</constant>
</constants>

10
doc/classes/Area2D.xml
View file

@ -211,19 +211,19 @@
</signal>
</signals>
<constants>
<constant name="SPACE_OVERRIDE_DISABLED" value="0">
<constant name="SPACE_OVERRIDE_DISABLED" value="0" enum="SpaceOverride">
This area does not affect gravity/damping.
</constant>
<constant name="SPACE_OVERRIDE_COMBINE" value="1">
<constant name="SPACE_OVERRIDE_COMBINE" value="1" enum="SpaceOverride">
This area adds its gravity/damping values to whatever has been calculated so far (in [code]priority[/code] order).
</constant>
<constant name="SPACE_OVERRIDE_COMBINE_REPLACE" value="2">
<constant name="SPACE_OVERRIDE_COMBINE_REPLACE" value="2" enum="SpaceOverride">
This area adds its gravity/damping values to whatever has been calculated so far (in [code]priority[/code] order), ignoring any lower priority areas.
</constant>
<constant name="SPACE_OVERRIDE_REPLACE" value="3">
<constant name="SPACE_OVERRIDE_REPLACE" value="3" enum="SpaceOverride">
This area replaces any gravity/damping, even the defaults, ignoring any lower priority areas.
</constant>
<constant name="SPACE_OVERRIDE_REPLACE_COMBINE" value="4">
<constant name="SPACE_OVERRIDE_REPLACE_COMBINE" value="4" enum="SpaceOverride">
This area replaces any gravity/damping calculated so far (in [code]priority[/code] order), but keeps calculating the rest of the areas.
</constant>
</constants>

42
doc/classes/ArrayMesh.xml
View file

@ -213,66 +213,66 @@
</method>
</methods>
<constants>
<constant name="NO_INDEX_ARRAY" value="-1" enum="">
<constant name="NO_INDEX_ARRAY" value="-1">
Default value used for index_array_len when no indices are present.
</constant>
<constant name="ARRAY_WEIGHTS_SIZE" value="4" enum="">
<constant name="ARRAY_WEIGHTS_SIZE" value="4">
Amount of weights/bone indices per vertex (always 4).
</constant>
<constant name="ARRAY_VERTEX" value="0">
<constant name="ARRAY_VERTEX" value="0" enum="ArrayType">
Vertex array (array of [Vector3] vertices).
</constant>
<constant name="ARRAY_NORMAL" value="1">
<constant name="ARRAY_NORMAL" value="1" enum="ArrayType">
Normal array (array of [Vector3] normals).
</constant>
<constant name="ARRAY_TANGENT" value="2">
<constant name="ARRAY_TANGENT" value="2" enum="ArrayType">
Tangent array, array of groups of 4 floats. first 3 floats determine the tangent, and the last the binormal direction as -1 or 1.
</constant>
<constant name="ARRAY_COLOR" value="3">
<constant name="ARRAY_COLOR" value="3" enum="ArrayType">
Vertex array (array of [Color] colors).
</constant>
<constant name="ARRAY_TEX_UV" value="4">
<constant name="ARRAY_TEX_UV" value="4" enum="ArrayType">
UV array (array of [Vector3] UVs or float array of groups of 2 floats (u,v)).
</constant>
<constant name="ARRAY_TEX_UV2" value="5">
<constant name="ARRAY_TEX_UV2" value="5" enum="ArrayType">
Second UV array (array of [Vector3] UVs or float array of groups of 2 floats (u,v)).
</constant>
<constant name="ARRAY_BONES" value="6">
<constant name="ARRAY_BONES" value="6" enum="ArrayType">
Array of bone indices, as a float array. Each element in groups of 4 floats.
</constant>
<constant name="ARRAY_WEIGHTS" value="7">
<constant name="ARRAY_WEIGHTS" value="7" enum="ArrayType">
Array of bone weights, as a float array. Each element in groups of 4 floats.
</constant>
<constant name="ARRAY_INDEX" value="8">
<constant name="ARRAY_INDEX" value="8" enum="ArrayType">
Array of integers, used as indices referencing vertices. No index can be beyond the vertex array size.
</constant>
<constant name="ARRAY_MAX" value="9">
<constant name="ARRAY_MAX" value="9" enum="ArrayType">
</constant>
<constant name="ARRAY_FORMAT_VERTEX" value="1">
<constant name="ARRAY_FORMAT_VERTEX" value="1" enum="ArrayFormat">
Array format will include vertices (mandatory).
</constant>
<constant name="ARRAY_FORMAT_NORMAL" value="2">
<constant name="ARRAY_FORMAT_NORMAL" value="2" enum="ArrayFormat">
Array format will include normals
</constant>
<constant name="ARRAY_FORMAT_TANGENT" value="4">
<constant name="ARRAY_FORMAT_TANGENT" value="4" enum="ArrayFormat">
Array format will include tangents
</constant>
<constant name="ARRAY_FORMAT_COLOR" value="8">
<constant name="ARRAY_FORMAT_COLOR" value="8" enum="ArrayFormat">
Array format will include a color array.
</constant>
<constant name="ARRAY_FORMAT_TEX_UV" value="16">
<constant name="ARRAY_FORMAT_TEX_UV" value="16" enum="ArrayFormat">
Array format will include UVs.
</constant>
<constant name="ARRAY_FORMAT_TEX_UV2" value="32">
<constant name="ARRAY_FORMAT_TEX_UV2" value="32" enum="ArrayFormat">
Array format will include another set of UVs.
</constant>
<constant name="ARRAY_FORMAT_BONES" value="64">
<constant name="ARRAY_FORMAT_BONES" value="64" enum="ArrayFormat">
Array format will include bone indices.
</constant>
<constant name="ARRAY_FORMAT_WEIGHTS" value="128">
<constant name="ARRAY_FORMAT_WEIGHTS" value="128" enum="ArrayFormat">
Array format will include bone weights.
</constant>
<constant name="ARRAY_FORMAT_INDEX" value="256">
<constant name="ARRAY_FORMAT_INDEX" value="256" enum="ArrayFormat">
Index array will be used.
</constant>
</constants>

10
doc/classes/AudioEffectDistortion.xml
View file

@ -32,18 +32,18 @@
</member>
</members>
<constants>
<constant name="MODE_CLIP" value="0">
<constant name="MODE_CLIP" value="0" enum="Mode">
Digital distortion effect which cuts off peaks at the top and bottom of the waveform.
</constant>
<constant name="MODE_ATAN" value="1">
<constant name="MODE_ATAN" value="1" enum="Mode">
</constant>
<constant name="MODE_LOFI" value="2">
<constant name="MODE_LOFI" value="2" enum="Mode">
Low-resolution digital distortion effect. You can use it to emulate the sound of early digital audio devices.
</constant>
<constant name="MODE_OVERDRIVE" value="3">
<constant name="MODE_OVERDRIVE" value="3" enum="Mode">
Emulates the warm distortion produced by a field effect transistor, which is commonly used in solid-state musical instrument amplifiers.
</constant>
<constant name="MODE_WAVESHAPE" value="4">
<constant name="MODE_WAVESHAPE" value="4" enum="Mode">
Waveshaper distortions are used mainly by electronic musicians to achieve an extra-abrasive sound.
</constant>
</constants>

8
doc/classes/AudioEffectFilter.xml
View file

@ -26,13 +26,13 @@
</member>
</members>
<constants>
<constant name="FILTER_6DB" value="0">
<constant name="FILTER_6DB" value="0" enum="FilterDB">
</constant>
<constant name="FILTER_12DB" value="1">
<constant name="FILTER_12DB" value="1" enum="FilterDB">
</constant>
<constant name="FILTER_18DB" value="2">
<constant name="FILTER_18DB" value="2" enum="FilterDB">
</constant>
<constant name="FILTER_24DB" value="3">
<constant name="FILTER_24DB" value="3" enum="FilterDB">
</constant>
</constants>
</class>

6
doc/classes/AudioServer.xml
View file

@ -341,13 +341,13 @@
</signal>
</signals>
<constants>
<constant name="SPEAKER_MODE_STEREO" value="0">
<constant name="SPEAKER_MODE_STEREO" value="0" enum="SpeakerMode">
Two or fewer speakers are detected.
</constant>
<constant name="SPEAKER_SURROUND_51" value="2">
<constant name="SPEAKER_SURROUND_51" value="2" enum="SpeakerMode">
A 5.1 channel surround setup detected.
</constant>
<constant name="SPEAKER_SURROUND_71" value="3">
<constant name="SPEAKER_SURROUND_71" value="3" enum="SpeakerMode">
A 7.1 channel surround setup detected.
</constant>
</constants>

6
doc/classes/AudioStreamPlayer.xml
View file

@ -73,13 +73,13 @@
</signal>
</signals>
<constants>
<constant name="MIX_TARGET_STEREO" value="0">
<constant name="MIX_TARGET_STEREO" value="0" enum="MixTarget">
The audio will be played only on the first channel.
</constant>
<constant name="MIX_TARGET_SURROUND" value="1">
<constant name="MIX_TARGET_SURROUND" value="1" enum="MixTarget">
The audio will be played on all surround channels.
</constant>
<constant name="MIX_TARGET_CENTER" value="2">
<constant name="MIX_TARGET_CENTER" value="2" enum="MixTarget">
The audio will be played on the second channel, which is usually the center.
</constant>
</constants>

16
doc/classes/AudioStreamPlayer3D.xml
View file

@ -106,28 +106,28 @@
</signal>
</signals>
<constants>
<constant name="ATTENUATION_INVERSE_DISTANCE" value="0">
<constant name="ATTENUATION_INVERSE_DISTANCE" value="0" enum="AttenuationModel">
Linear dampening of loudness according to distance.
</constant>
<constant name="ATTENUATION_INVERSE_SQUARE_DISTANCE" value="1">
<constant name="ATTENUATION_INVERSE_SQUARE_DISTANCE" value="1" enum="AttenuationModel">
Squared dampening of loudness according to distance.
</constant>
<constant name="ATTENUATION_LOGARITHMIC" value="2">
<constant name="ATTENUATION_LOGARITHMIC" value="2" enum="AttenuationModel">
Logarithmic dampening of loudness according to distance.
</constant>
<constant name="OUT_OF_RANGE_MIX" value="0">
<constant name="OUT_OF_RANGE_MIX" value="0" enum="OutOfRangeMode">
Mix this audio in, even when it's out of range.
</constant>
<constant name="OUT_OF_RANGE_PAUSE" value="1">
<constant name="OUT_OF_RANGE_PAUSE" value="1" enum="OutOfRangeMode">
Pause this audio when it gets out of range.
</constant>
<constant name="DOPPLER_TRACKING_DISABLED" value="0">
<constant name="DOPPLER_TRACKING_DISABLED" value="0" enum="DopplerTracking">
Disables doppler tracking.
</constant>
<constant name="DOPPLER_TRACKING_IDLE_STEP" value="1">
<constant name="DOPPLER_TRACKING_IDLE_STEP" value="1" enum="DopplerTracking">
Executes doppler tracking in idle step.
</constant>
<constant name="DOPPLER_TRACKING_PHYSICS_STEP" value="2">
<constant name="DOPPLER_TRACKING_PHYSICS_STEP" value="2" enum="DopplerTracking">
Executes doppler tracking in physics step.
</constant>
</constants>

12
doc/classes/AudioStreamSample.xml
View file

@ -36,22 +36,22 @@
</member>
</members>
<constants>
<constant name="FORMAT_8_BITS" value="0">
<constant name="FORMAT_8_BITS" value="0" enum="Format">
Audio codec 8 bit.
</constant>
<constant name="FORMAT_16_BITS" value="1">
<constant name="FORMAT_16_BITS" value="1" enum="Format">
Audio codec 16 bit.
</constant>
<constant name="FORMAT_IMA_ADPCM" value="2">
<constant name="FORMAT_IMA_ADPCM" value="2" enum="Format">
Audio codec IMA ADPCM.
</constant>
<constant name="LOOP_DISABLED" value="0">
<constant name="LOOP_DISABLED" value="0" enum="LoopMode">
Audio does not loop.
</constant>
<constant name="LOOP_FORWARD" value="1">
<constant name="LOOP_FORWARD" value="1" enum="LoopMode">
Audio loops the data between loop_begin and loop_end playing forward only.
</constant>
<constant name="LOOP_PING_PONG" value="2">
<constant name="LOOP_PING_PONG" value="2" enum="LoopMode">
Audio loops the data between loop_begin and loop_end playing back and forth.
</constant>
</constants>

6
doc/classes/BackBufferCopy.xml
View file

@ -21,13 +21,13 @@
</member>
</members>
<constants>
<constant name="COPY_MODE_DISABLED" value="0">
<constant name="COPY_MODE_DISABLED" value="0" enum="CopyMode">
Disables the buffering mode. This means the BackBufferCopy node will directly use the portion of screen it covers.
</constant>
<constant name="COPY_MODE_RECT" value="1">
<constant name="COPY_MODE_RECT" value="1" enum="CopyMode">
BackBufferCopy buffers a rectangular region.
</constant>
<constant name="COPY_MODE_VIEWPORT" value="2">
<constant name="COPY_MODE_VIEWPORT" value="2" enum="CopyMode">
BackBufferCopy buffers the entire screen.
</constant>
</constants>

12
doc/classes/BaseButton.xml
View file

@ -90,22 +90,22 @@
</signal>
</signals>
<constants>
<constant name="DRAW_NORMAL" value="0">
<constant name="DRAW_NORMAL" value="0" enum="DrawMode">
The normal state (i.e. not pressed, not hovered, not toggled and enabled) of buttons.
</constant>
<constant name="DRAW_PRESSED" value="1">
<constant name="DRAW_PRESSED" value="1" enum="DrawMode">
The state of buttons are pressed.
</constant>
<constant name="DRAW_HOVER" value="2">
<constant name="DRAW_HOVER" value="2" enum="DrawMode">
The state of buttons are hovered.
</constant>
<constant name="DRAW_DISABLED" value="3">
<constant name="DRAW_DISABLED" value="3" enum="DrawMode">
The state of buttons are disabled.
</constant>
<constant name="ACTION_MODE_BUTTON_PRESS" value="0">
<constant name="ACTION_MODE_BUTTON_PRESS" value="0" enum="ActionMode">
Require just a press to consider the button clicked.
</constant>
<constant name="ACTION_MODE_BUTTON_RELEASE" value="1">
<constant name="ACTION_MODE_BUTTON_RELEASE" value="1" enum="ActionMode">
Require a press and a subsequent release before considering the button clicked.
</constant>
</constants>

6
doc/classes/BoxContainer.xml
View file

@ -27,13 +27,13 @@
</member>
</members>
<constants>
<constant name="ALIGN_BEGIN" value="0">
<constant name="ALIGN_BEGIN" value="0" enum="AlignMode">
Aligns children with the beginning of the container.
</constant>
<constant name="ALIGN_CENTER" value="1">
<constant name="ALIGN_CENTER" value="1" enum="AlignMode">
Aligns children with the center of the container.
</constant>
<constant name="ALIGN_END" value="2">
<constant name="ALIGN_END" value="2" enum="AlignMode">
Aligns children with the end of the container.
</constant>
</constants>

6
doc/classes/Button.xml
View file

@ -30,13 +30,13 @@
</member>
</members>
<constants>
<constant name="ALIGN_LEFT" value="0">
<constant name="ALIGN_LEFT" value="0" enum="TextAlign">
Align the text to the left.
</constant>
<constant name="ALIGN_CENTER" value="1">
<constant name="ALIGN_CENTER" value="1" enum="TextAlign">
Align the text to the center.
</constant>
<constant name="ALIGN_RIGHT" value="2">
<constant name="ALIGN_RIGHT" value="2" enum="TextAlign">
Align the text to the right.
</constant>
</constants>

14
doc/classes/Camera.xml
View file

@ -249,25 +249,25 @@
</method>
</methods>
<constants>
<constant name="PROJECTION_PERSPECTIVE" value="0">
<constant name="PROJECTION_PERSPECTIVE" value="0" enum="Projection">
Perspective Projection (object's size on the screen becomes smaller when far away).
</constant>
<constant name="PROJECTION_ORTHOGONAL" value="1">
<constant name="PROJECTION_ORTHOGONAL" value="1" enum="Projection">
Orthogonal Projection (objects remain the same size on the screen no matter how far away they are).
</constant>
<constant name="KEEP_WIDTH" value="0">
<constant name="KEEP_WIDTH" value="0" enum="KeepAspect">
Try to keep the aspect ratio when scaling the Camera's viewport to the screen. If not possible, preserve the viewport's width by changing the height. Height is [code]sizey[/code] for orthographic projection, [code]fovy[/code] for perspective projection.
</constant>
<constant name="KEEP_HEIGHT" value="1">
<constant name="KEEP_HEIGHT" value="1" enum="KeepAspect">
Try to keep the aspect ratio when scaling the Camera's viewport to the screen. If not possible, preserve the viewport's height by changing the width. Width is [code]sizex[/code] for orthographic projection, [code]fovx[/code] for perspective projection.
</constant>
<constant name="DOPPLER_TRACKING_DISABLED" value="0">
<constant name="DOPPLER_TRACKING_DISABLED" value="0" enum="DopplerTracking">
Disable Doppler effect simulation (default).
</constant>
<constant name="DOPPLER_TRACKING_IDLE_STEP" value="1">
<constant name="DOPPLER_TRACKING_IDLE_STEP" value="1" enum="DopplerTracking">
Simulate Doppler effect by tracking positions of objects that are changed in [code]_process[/code]. Changes in the relative velocity of this Camera compared to those objects affect how Audio is perceived (changing the Audio's [code]pitch shift[/code]).
</constant>
<constant name="DOPPLER_TRACKING_PHYSICS_STEP" value="2">
<constant name="DOPPLER_TRACKING_PHYSICS_STEP" value="2" enum="DopplerTracking">
Simulate Doppler effect by tracking positions of objects that are changed in [code]_physics_process[/code]. Changes in the relative velocity of this Camera compared to those objects affect how Audio is perceived (changing the Audio's [code]pitch shift[/code]).
</constant>
</constants>

4
doc/classes/Camera2D.xml
View file

@ -169,9 +169,9 @@
</member>
</members>
<constants>
<constant name="ANCHOR_MODE_FIXED_TOP_LEFT" value="0">
<constant name="ANCHOR_MODE_FIXED_TOP_LEFT" value="0" enum="AnchorMode">
</constant>
<constant name="ANCHOR_MODE_DRAG_CENTER" value="1">
<constant name="ANCHOR_MODE_DRAG_CENTER" value="1" enum="AnchorMode">
</constant>
</constants>
</class>

20
doc/classes/CanvasItem.xml
View file

@ -477,34 +477,34 @@
</signal>
</signals>
<constants>
<constant name="BLEND_MODE_MIX" value="0">
<constant name="BLEND_MODE_MIX" value="0" enum="BlendMode">
Mix blending mode. Colors are assumed to be independent of the alpha (opacity) value.
</constant>
<constant name="BLEND_MODE_ADD" value="1">
<constant name="BLEND_MODE_ADD" value="1" enum="BlendMode">
Additive blending mode.
</constant>
<constant name="BLEND_MODE_SUB" value="2">
<constant name="BLEND_MODE_SUB" value="2" enum="BlendMode">
Subtractive blending mode.
</constant>
<constant name="BLEND_MODE_MUL" value="3">
<constant name="BLEND_MODE_MUL" value="3" enum="BlendMode">
Multiplicative blending mode.
</constant>
<constant name="BLEND_MODE_PREMULT_ALPHA" value="4">
<constant name="BLEND_MODE_PREMULT_ALPHA" value="4" enum="BlendMode">
Mix blending mode. Colors are assumed to be premultiplied by the alpha (opacity) value.
</constant>
<constant name="NOTIFICATION_TRANSFORM_CHANGED" value="29" enum="">
<constant name="NOTIFICATION_TRANSFORM_CHANGED" value="29">
Canvas item transform has changed. Only received if requested.
</constant>
<constant name="NOTIFICATION_DRAW" value="30" enum="">
<constant name="NOTIFICATION_DRAW" value="30">
CanvasItem is requested to draw.
</constant>
<constant name="NOTIFICATION_VISIBILITY_CHANGED" value="31" enum="">
<constant name="NOTIFICATION_VISIBILITY_CHANGED" value="31">
Canvas item visibility has changed.
</constant>
<constant name="NOTIFICATION_ENTER_CANVAS" value="32" enum="">
<constant name="NOTIFICATION_ENTER_CANVAS" value="32">
Canvas item has entered the canvas.
</constant>
<constant name="NOTIFICATION_EXIT_CANVAS" value="33" enum="">
<constant name="NOTIFICATION_EXIT_CANVAS" value="33">
Canvas item has exited the canvas.
</constant>
</constants>

16
doc/classes/CanvasItemMaterial.xml
View file

@ -17,21 +17,21 @@
</member>
</members>
<constants>
<constant name="BLEND_MODE_MIX" value="0">
<constant name="BLEND_MODE_MIX" value="0" enum="BlendMode">
</constant>
<constant name="BLEND_MODE_ADD" value="1">
<constant name="BLEND_MODE_ADD" value="1" enum="BlendMode">
</constant>
<constant name="BLEND_MODE_SUB" value="2">
<constant name="BLEND_MODE_SUB" value="2" enum="BlendMode">
</constant>
<constant name="BLEND_MODE_MUL" value="3">
<constant name="BLEND_MODE_MUL" value="3" enum="BlendMode">
</constant>
<constant name="BLEND_MODE_PREMULT_ALPHA" value="4">
<constant name="BLEND_MODE_PREMULT_ALPHA" value="4" enum="BlendMode">
</constant>
<constant name="LIGHT_MODE_NORMAL" value="0">
<constant name="LIGHT_MODE_NORMAL" value="0" enum="LightMode">
</constant>
<constant name="LIGHT_MODE_UNSHADED" value="1">
<constant name="LIGHT_MODE_UNSHADED" value="1" enum="LightMode">
</constant>
<constant name="LIGHT_MODE_LIGHT_ONLY" value="2">
<constant name="LIGHT_MODE_LIGHT_ONLY" value="2" enum="LightMode">
</constant>
</constants>
</class>

4
doc/classes/CollisionPolygon2D.xml
View file

@ -27,10 +27,10 @@
</member>
</members>
<constants>
<constant name="BUILD_SOLIDS" value="0">
<constant name="BUILD_SOLIDS" value="0" enum="BuildMode">
Collisions will include the polygon and its contained area.
</constant>
<constant name="BUILD_SEGMENTS" value="1">
<constant name="BUILD_SEGMENTS" value="1" enum="BuildMode">
Collisions will only include the polygon edges.
</constant>
</constants>

12
doc/classes/ConeTwistJoint.xml
View file

@ -37,27 +37,27 @@
</member>
</members>
<constants>
<constant name="PARAM_SWING_SPAN" value="0">
<constant name="PARAM_SWING_SPAN" value="0" enum="Param">
Swing is rotation from side to side, around the axis perpendicular to the twist axis.
The swing span defines, how much rotation will not get corrected allong the swing axis.
Could be defined as looseness in the [code]ConeTwistJoint[/code].
If below 0.05, this behaviour is locked. Default value: [code]PI/4[/code].
</constant>
<constant name="PARAM_TWIST_SPAN" value="1">
<constant name="PARAM_TWIST_SPAN" value="1" enum="Param">
Twist is the rotation around the twist axis, this value defined how far the joint can twist.
Twist is locked if below 0.05.
</constant>
<constant name="PARAM_BIAS" value="2">
<constant name="PARAM_BIAS" value="2" enum="Param">
The speed with which the swing or twist will take place.
The higher, the faster.
</constant>
<constant name="PARAM_SOFTNESS" value="3">
<constant name="PARAM_SOFTNESS" value="3" enum="Param">
The ease with which the joint starts to twist. If it's too low, it takes more force to start twisting the joint.
</constant>
<constant name="PARAM_RELAXATION" value="4">
<constant name="PARAM_RELAXATION" value="4" enum="Param">
Defines, how fast the swing- and twist-speed-difference on both sides gets synced.
</constant>
<constant name="PARAM_MAX" value="5">
<constant name="PARAM_MAX" value="5" enum="Param">
End flag of PARAM_* constants, used internally.
</constant>
</constants>

2
doc/classes/Container.xml
View file

@ -39,7 +39,7 @@
</signal>
</signals>
<constants>
<constant name="NOTIFICATION_SORT_CHILDREN" value="50" enum="">
<constant name="NOTIFICATION_SORT_CHILDREN" value="50">
Notification for when sorting the children, it must be obeyed immediately.
</constant>
</constants>

118
doc/classes/Control.xml
View file

@ -716,172 +716,172 @@
</signal>
</signals>
<constants>
<constant name="FOCUS_NONE" value="0">
<constant name="FOCUS_NONE" value="0" enum="FocusMode">
The node cannot grab focus. Use with [member set_focus_mode].
</constant>
<constant name="FOCUS_CLICK" value="1">
<constant name="FOCUS_CLICK" value="1" enum="FocusMode">
The node can only grab focus on mouse clicks. Use with [member set_focus_mode].
</constant>
<constant name="FOCUS_ALL" value="2">
<constant name="FOCUS_ALL" value="2" enum="FocusMode">
The node can grab focus on mouse click or using the arrows and the Tab keys on the keyboard. Use with [member set_focus_mode].
</constant>
<constant name="NOTIFICATION_RESIZED" value="40" enum="">
<constant name="NOTIFICATION_RESIZED" value="40">
Sent when the node changes size. Use [member rect_size] to get the new size.
</constant>
<constant name="NOTIFICATION_MOUSE_ENTER" value="41" enum="">
<constant name="NOTIFICATION_MOUSE_ENTER" value="41">
Sent when the mouse pointer enters the node's [code]Rect[/code] area.
</constant>
<constant name="NOTIFICATION_MOUSE_EXIT" value="42" enum="">
<constant name="NOTIFICATION_MOUSE_EXIT" value="42">
Sent when the mouse pointer exits the node's [code]Rect[/code] area.
</constant>
<constant name="NOTIFICATION_FOCUS_ENTER" value="43" enum="">
<constant name="NOTIFICATION_FOCUS_ENTER" value="43">
Sent when the node grabs focus.
</constant>
<constant name="NOTIFICATION_FOCUS_EXIT" value="44" enum="">
<constant name="NOTIFICATION_FOCUS_EXIT" value="44">
Sent when the node loses focus.
</constant>
<constant name="NOTIFICATION_THEME_CHANGED" value="45" enum="">
<constant name="NOTIFICATION_THEME_CHANGED" value="45">
Sent when the node's [member theme] changes, right before Godot redraws the [code]Control[/code]. Happens when you call one of the [code]add_*_override[/code]
</constant>
<constant name="NOTIFICATION_MODAL_CLOSE" value="46" enum="">
<constant name="NOTIFICATION_MODAL_CLOSE" value="46">
Sent when an open modal dialog closes. See [member show_modal].
</constant>
<constant name="CURSOR_ARROW" value="0">
<constant name="CURSOR_ARROW" value="0" enum="CursorShape">
Show the system's arrow mouse cursor when the user hovers the node. Use with [method set_default_cursor_shape].
</constant>
<constant name="CURSOR_IBEAM" value="1">
<constant name="CURSOR_IBEAM" value="1" enum="CursorShape">
Show the system's I-beam mouse cursor when the user hovers the node. The I-beam pointer has a shape similar to "I". It tells the user they can highlight or insert text.
</constant>
<constant name="CURSOR_POINTING_HAND" value="2">
<constant name="CURSOR_POINTING_HAND" value="2" enum="CursorShape">
Show the system's pointing hand mouse cursor when the user hovers the node.
</constant>
<constant name="CURSOR_CROSS" value="3">
<constant name="CURSOR_CROSS" value="3" enum="CursorShape">
Show the system's cross mouse cursor when the user hovers the node.
</constant>
<constant name="CURSOR_WAIT" value="4">
<constant name="CURSOR_WAIT" value="4" enum="CursorShape">
Show the system's wait mouse cursor, often an hourglass, when the user hovers the node.
</constant>
<constant name="CURSOR_BUSY" value="5">
<constant name="CURSOR_BUSY" value="5" enum="CursorShape">
Show the system's busy mouse cursor when the user hovers the node. Often an hourglass.
</constant>
<constant name="CURSOR_DRAG" value="6">
<constant name="CURSOR_DRAG" value="6" enum="CursorShape">
Show the system's drag mouse cursor, often a closed fist or a cross symbol, when the user hovers the node. It tells the user they're currently dragging an item, like a node in the Scene dock.
</constant>
<constant name="CURSOR_CAN_DROP" value="7">
<constant name="CURSOR_CAN_DROP" value="7" enum="CursorShape">
Show the system's drop mouse cursor when the user hovers the node. It can be an open hand. It tells the user they can drop an item they're currently grabbing, like a node in the Scene dock.
</constant>
<constant name="CURSOR_FORBIDDEN" value="8">
<constant name="CURSOR_FORBIDDEN" value="8" enum="CursorShape">
Show the system's forbidden mouse cursor when the user hovers the node. Often a crossed circle.
</constant>
<constant name="CURSOR_VSIZE" value="9">
<constant name="CURSOR_VSIZE" value="9" enum="CursorShape">
Show the system's vertical resize mouse cursor when the user hovers the node. A double headed vertical arrow. It tells the user they can resize the window or the panel vertically.
</constant>
<constant name="CURSOR_HSIZE" value="10">
<constant name="CURSOR_HSIZE" value="10" enum="CursorShape">
Show the system's horizontal resize mouse cursor when the user hovers the node. A double headed horizontal arrow. It tells the user they can resize the window or the panel horizontally.
</constant>
<constant name="CURSOR_BDIAGSIZE" value="11">
<constant name="CURSOR_BDIAGSIZE" value="11" enum="CursorShape">
Show the system's window resize mouse cursor when the user hovers the node. The cursor is a double headed arrow that goes from the bottom left to the top right. It tells the user they can resize the window or the panel both horizontally and vertically.
</constant>
<constant name="CURSOR_FDIAGSIZE" value="12">
<constant name="CURSOR_FDIAGSIZE" value="12" enum="CursorShape">
Show the system's window resize mouse cursor when the user hovers the node. The cursor is a double headed arrow that goes from the top left to the bottom right, the opposite of [code]CURSOR_BDIAGSIZE[/code]. It tells the user they can resize the window or the panel both horizontally and vertically.
</constant>
<constant name="CURSOR_MOVE" value="13">
<constant name="CURSOR_MOVE" value="13" enum="CursorShape">
Show the system's move mouse cursor when the user hovers the node. It shows 2 double-headed arrows at a 90 degree angle. It tells the user they can move a UI element freely.
</constant>
<constant name="CURSOR_VSPLIT" value="14">
<constant name="CURSOR_VSPLIT" value="14" enum="CursorShape">
Show the system's vertical split mouse cursor when the user hovers the node. On Windows, it's the same as [code]CURSOR_VSIZE[/code].
</constant>
<constant name="CURSOR_HSPLIT" value="15">
<constant name="CURSOR_HSPLIT" value="15" enum="CursorShape">
Show the system's horizontal split mouse cursor when the user hovers the node. On Windows, it's the same as [code]CURSOR_HSIZE[/code].
</constant>
<constant name="CURSOR_HELP" value="16">
<constant name="CURSOR_HELP" value="16" enum="CursorShape">
Show the system's help mouse cursor when the user hovers the node, a question mark.
</constant>
<constant name="PRESET_TOP_LEFT" value="0">
<constant name="PRESET_TOP_LEFT" value="0" enum="LayoutPreset">
Snap all 4 anchors to the top-left of the parent container's bounds. Use with [method set_anchors_preset].
</constant>
<constant name="PRESET_TOP_RIGHT" value="1">
<constant name="PRESET_TOP_RIGHT" value="1" enum="LayoutPreset">
Snap all 4 anchors to the top-right of the parent container's bounds. Use with [method set_anchors_preset].
</constant>
<constant name="PRESET_BOTTOM_LEFT" value="2">
<constant name="PRESET_BOTTOM_LEFT" value="2" enum="LayoutPreset">
Snap all 4 anchors to the bottom-left of the parent container's bounds. Use with [method set_anchors_preset].
</constant>
<constant name="PRESET_BOTTOM_RIGHT" value="3">
<constant name="PRESET_BOTTOM_RIGHT" value="3" enum="LayoutPreset">
Snap all 4 anchors to the bottom-right of the parent container's bounds. Use with [method set_anchors_preset].
</constant>
<constant name="PRESET_CENTER_LEFT" value="4">
<constant name="PRESET_CENTER_LEFT" value="4" enum="LayoutPreset">
Snap all 4 anchors to the center of the left edge of the parent container's bounds. Use with [method set_anchors_preset].
</constant>
<constant name="PRESET_CENTER_TOP" value="5">
<constant name="PRESET_CENTER_TOP" value="5" enum="LayoutPreset">
Snap all 4 anchors to the center of the top edge of the parent container's bounds. Use with [method set_anchors_preset].
</constant>
<constant name="PRESET_CENTER_RIGHT" value="6">
<constant name="PRESET_CENTER_RIGHT" value="6" enum="LayoutPreset">
Snap all 4 anchors to the center of the right edge of the parent container's bounds. Use with [method set_anchors_preset].
</constant>
<constant name="PRESET_CENTER_BOTTOM" value="7">
<constant name="PRESET_CENTER_BOTTOM" value="7" enum="LayoutPreset">
Snap all 4 anchors to the center of the bottom edge of the parent container's bounds. Use with [method set_anchors_preset].
</constant>
<constant name="PRESET_CENTER" value="8">
<constant name="PRESET_CENTER" value="8" enum="LayoutPreset">
Snap all 4 anchors to the center of the parent container's bounds. Use with [method set_anchors_preset].
</constant>
<constant name="PRESET_LEFT_WIDE" value="9">
<constant name="PRESET_LEFT_WIDE" value="9" enum="LayoutPreset">
Snap all 4 anchors to the left edge of the parent container. The left margin becomes relative to the left edge and the top margin relative to the top left corner of the node's parent. Use with [method set_anchors_preset].
</constant>
<constant name="PRESET_TOP_WIDE" value="10">
<constant name="PRESET_TOP_WIDE" value="10" enum="LayoutPreset">
Snap all 4 anchors to the top edge of the parent container. The left margin becomes relative to the top left corner, the top margin relative to the top edge, and the right margin relative to the top right corner of the node's parent. Use with [method set_anchors_preset].
</constant>
<constant name="PRESET_RIGHT_WIDE" value="11">
<constant name="PRESET_RIGHT_WIDE" value="11" enum="LayoutPreset">
Snap all 4 anchors to the right edge of the parent container. The right margin becomes relative to the right edge and the top margin relative to the top right corner of the node's parent. Use with [method set_anchors_preset].
</constant>
<constant name="PRESET_BOTTOM_WIDE" value="12">
<constant name="PRESET_BOTTOM_WIDE" value="12" enum="LayoutPreset">
Snap all 4 anchors to the bottom edge of the parent container. The left margin becomes relative to the bottom left corner, the bottom margin relative to the bottom edge, and the right margin relative to the bottom right corner of the node's parent. Use with [method set_anchors_preset].
</constant>
<constant name="PRESET_VCENTER_WIDE" value="13">
<constant name="PRESET_VCENTER_WIDE" value="13" enum="LayoutPreset">
Snap all 4 anchors to a vertical line that cuts the parent container in half. Use with [method set_anchors_preset].
</constant>
<constant name="PRESET_HCENTER_WIDE" value="14">
<constant name="PRESET_HCENTER_WIDE" value="14" enum="LayoutPreset">
Snap all 4 anchors to a horizontal line that cuts the parent container in half. Use with [method set_anchors_preset].
</constant>
<constant name="PRESET_WIDE" value="15">
<constant name="PRESET_WIDE" value="15" enum="LayoutPreset">
Snap all 4 anchors to the respective corners of the parent container. Set all 4 margins to 0 after you applied this preset and the [code]Control[/code] will fit its parent container. Use with [method set_anchors_preset].
</constant>
<constant name="PRESET_MODE_MINSIZE" value="0">
<constant name="PRESET_MODE_MINSIZE" value="0" enum="LayoutPresetMode">
</constant>
<constant name="PRESET_MODE_KEEP_WIDTH" value="1">
<constant name="PRESET_MODE_KEEP_WIDTH" value="1" enum="LayoutPresetMode">
</constant>
<constant name="PRESET_MODE_KEEP_HEIGHT" value="2">
<constant name="PRESET_MODE_KEEP_HEIGHT" value="2" enum="LayoutPresetMode">
</constant>
<constant name="PRESET_MODE_KEEP_SIZE" value="3">
<constant name="PRESET_MODE_KEEP_SIZE" value="3" enum="LayoutPresetMode">
</constant>
<constant name="SIZE_FILL" value="1">
<constant name="SIZE_FILL" value="1" enum="SizeFlags">
Tells the parent [Container] to expand the bounds of this node to fill all the available space without pushing any other node. Use with [member size_flags_horizontal] and [member size_flags_vertical].
</constant>
<constant name="SIZE_EXPAND" value="2">
<constant name="SIZE_EXPAND" value="2" enum="SizeFlags">
Tells the parent [Container] to let this node take all the available space on the axis you flag. If multiple neighboring nodes are set to expand, they'll share the space based on their stretch ratio. See [member size_flags_stretch_ratio]. Use with [member size_flags_horizontal] and [member size_flags_vertical].
</constant>
<constant name="SIZE_EXPAND_FILL" value="3">
<constant name="SIZE_EXPAND_FILL" value="3" enum="SizeFlags">
Sets the node's size flags to both fill and expand. See the 2 constants above for more information.
</constant>
<constant name="SIZE_SHRINK_CENTER" value="4">
<constant name="SIZE_SHRINK_CENTER" value="4" enum="SizeFlags">
Tells the parent [Container] to center the node in itself. It centers the [code]Control[/code] based on its bounding box, so it doesn't work with the fill or expand size flags. Use with [member size_flags_horizontal] and [member size_flags_vertical].
</constant>
<constant name="SIZE_SHRINK_END" value="8">
<constant name="SIZE_SHRINK_END" value="8" enum="SizeFlags">
Tells the parent [Container] to align the node with its end, either the bottom or the right edge. It doesn't work with the fill or expand size flags. Use with [member size_flags_horizontal] and [member size_flags_vertical].
</constant>
<constant name="MOUSE_FILTER_STOP" value="0">
<constant name="MOUSE_FILTER_STOP" value="0" enum="MouseFilter">
</constant>
<constant name="MOUSE_FILTER_PASS" value="1">
<constant name="MOUSE_FILTER_PASS" value="1" enum="MouseFilter">
</constant>
<constant name="MOUSE_FILTER_IGNORE" value="2">
<constant name="MOUSE_FILTER_IGNORE" value="2" enum="MouseFilter">
</constant>
<constant name="GROW_DIRECTION_BEGIN" value="0">
<constant name="GROW_DIRECTION_BEGIN" value="0" enum="GrowDirection">
</constant>
<constant name="GROW_DIRECTION_END" value="1">
<constant name="GROW_DIRECTION_END" value="1" enum="GrowDirection">
</constant>
<constant name="ANCHOR_BEGIN" value="0">
<constant name="ANCHOR_BEGIN" value="0" enum="Anchor">
Snaps one of the 4 anchor's sides to the origin of the node's [code]Rect[/code], in the top left. Use it with one of the [code]anchor_*[/code] member variables, like [member anchor_left]. To change all 4 anchors at once, use [method set_anchors_preset].
</constant>
<constant name="ANCHOR_END" value="1">
<constant name="ANCHOR_END" value="1" enum="Anchor">
Snaps one of the 4 anchor's sides to the end of the node's [code]Rect[/code], in the bottom right. Use it with one of the [code]anchor_*[/code] member variables, like [member anchor_left]. To change all 4 anchors at once, use [method set_anchors_preset].
</constant>
</constants>

26
doc/classes/CubeMap.xml
View file

@ -69,31 +69,31 @@
</member>
</members>
<constants>
<constant name="STORAGE_RAW" value="0">
<constant name="STORAGE_RAW" value="0" enum="Storage">
</constant>
<constant name="STORAGE_COMPRESS_LOSSY" value="1">
<constant name="STORAGE_COMPRESS_LOSSY" value="1" enum="Storage">
</constant>
<constant name="STORAGE_COMPRESS_LOSSLESS" value="2">
<constant name="STORAGE_COMPRESS_LOSSLESS" value="2" enum="Storage">
</constant>
<constant name="SIDE_LEFT" value="0">
<constant name="SIDE_LEFT" value="0" enum="Side">
</constant>
<constant name="SIDE_RIGHT" value="1">
<constant name="SIDE_RIGHT" value="1" enum="Side">
</constant>
<constant name="SIDE_BOTTOM" value="2">
<constant name="SIDE_BOTTOM" value="2" enum="Side">
</constant>
<constant name="SIDE_TOP" value="3">
<constant name="SIDE_TOP" value="3" enum="Side">
</constant>
<constant name="SIDE_FRONT" value="4">
<constant name="SIDE_FRONT" value="4" enum="Side">
</constant>
<constant name="SIDE_BACK" value="5">
<constant name="SIDE_BACK" value="5" enum="Side">
</constant>
<constant name="FLAG_MIPMAPS" value="1">
<constant name="FLAG_MIPMAPS" value="1" enum="Flags">
</constant>
<constant name="FLAG_REPEAT" value="2">
<constant name="FLAG_REPEAT" value="2" enum="Flags">
</constant>
<constant name="FLAG_FILTER" value="4">
<constant name="FLAG_FILTER" value="4" enum="Flags">
</constant>
<constant name="FLAGS_DEFAULT" value="7">
<constant name="FLAGS_DEFAULT" value="7" enum="Flags">
</constant>
</constants>
</class>

6
doc/classes/Curve.xml
View file

@ -185,11 +185,11 @@
</signal>
</signals>
<constants>
<constant name="TANGENT_FREE" value="0">
<constant name="TANGENT_FREE" value="0" enum="TangentMode">
</constant>
<constant name="TANGENT_LINEAR" value="1">
<constant name="TANGENT_LINEAR" value="1" enum="TangentMode">
</constant>
<constant name="TANGENT_MODE_COUNT" value="2">
<constant name="TANGENT_MODE_COUNT" value="2" enum="TangentMode">
</constant>
</constants>
</class>

10
doc/classes/DirectionalLight.xml
View file

@ -33,15 +33,15 @@
</member>
</members>
<constants>
<constant name="SHADOW_ORTHOGONAL" value="0">
<constant name="SHADOW_ORTHOGONAL" value="0" enum="ShadowMode">
</constant>
<constant name="SHADOW_PARALLEL_2_SPLITS" value="1">
<constant name="SHADOW_PARALLEL_2_SPLITS" value="1" enum="ShadowMode">
</constant>
<constant name="SHADOW_PARALLEL_4_SPLITS" value="2">
<constant name="SHADOW_PARALLEL_4_SPLITS" value="2" enum="ShadowMode">
</constant>
<constant name="SHADOW_DEPTH_RANGE_STABLE" value="0">
<constant name="SHADOW_DEPTH_RANGE_STABLE" value="0" enum="ShadowDepthRange">
</constant>
<constant name="SHADOW_DEPTH_RANGE_OPTIMIZED" value="1">
<constant name="SHADOW_DEPTH_RANGE_OPTIMIZED" value="1" enum="ShadowDepthRange">
</constant>
</constants>
</class>

8
doc/classes/DynamicFont.xml
View file

@ -84,16 +84,16 @@
</member>
</members>
<constants>
<constant name="SPACING_TOP" value="0">
<constant name="SPACING_TOP" value="0" enum="SpacingType">
Spacing at the top.
</constant>
<constant name="SPACING_BOTTOM" value="1">
<constant name="SPACING_BOTTOM" value="1" enum="SpacingType">
Spacing at the bottom.
</constant>
<constant name="SPACING_CHAR" value="2">
<constant name="SPACING_CHAR" value="2" enum="SpacingType">
Character spacing.
</constant>
<constant name="SPACING_SPACE" value="3">
<constant name="SPACING_SPACE" value="3" enum="SpacingType">
Space spacing.
</constant>
</constants>

20
doc/classes/EditorFileDialog.xml
View file

@ -169,25 +169,25 @@
</signal>
</signals>
<constants>
<constant name="MODE_OPEN_FILE" value="0">
<constant name="MODE_OPEN_FILE" value="0" enum="Mode">
</constant>
<constant name="MODE_OPEN_FILES" value="1">
<constant name="MODE_OPEN_FILES" value="1" enum="Mode">
</constant>
<constant name="MODE_OPEN_DIR" value="2">
<constant name="MODE_OPEN_DIR" value="2" enum="Mode">
</constant>
<constant name="MODE_OPEN_ANY" value="3">
<constant name="MODE_OPEN_ANY" value="3" enum="Mode">
</constant>
<constant name="MODE_SAVE_FILE" value="4">
<constant name="MODE_SAVE_FILE" value="4" enum="Mode">
</constant>
<constant name="ACCESS_RESOURCES" value="0">
<constant name="ACCESS_RESOURCES" value="0" enum="Access">
</constant>
<constant name="ACCESS_USERDATA" value="1">
<constant name="ACCESS_USERDATA" value="1" enum="Access">
</constant>
<constant name="ACCESS_FILESYSTEM" value="2">
<constant name="ACCESS_FILESYSTEM" value="2" enum="Access">
</constant>
<constant name="DISPLAY_THUMBNAILS" value="0">
<constant name="DISPLAY_THUMBNAILS" value="0" enum="DisplayMode">
</constant>
<constant name="DISPLAY_LIST" value="1">
<constant name="DISPLAY_LIST" value="1" enum="DisplayMode">
</constant>
</constants>
</class>

34
doc/classes/EditorPlugin.xml
View file

@ -354,39 +354,39 @@
</signal>
</signals>
<constants>
<constant name="CONTAINER_TOOLBAR" value="0">
<constant name="CONTAINER_TOOLBAR" value="0" enum="CustomControlContainer">
</constant>
<constant name="CONTAINER_SPATIAL_EDITOR_MENU" value="1">
<constant name="CONTAINER_SPATIAL_EDITOR_MENU" value="1" enum="CustomControlContainer">
</constant>
<constant name="CONTAINER_SPATIAL_EDITOR_SIDE" value="2">
<constant name="CONTAINER_SPATIAL_EDITOR_SIDE" value="2" enum="CustomControlContainer">
</constant>
<constant name="CONTAINER_SPATIAL_EDITOR_BOTTOM" value="3">
<constant name="CONTAINER_SPATIAL_EDITOR_BOTTOM" value="3" enum="CustomControlContainer">
</constant>
<constant name="CONTAINER_CANVAS_EDITOR_MENU" value="4">
<constant name="CONTAINER_CANVAS_EDITOR_MENU" value="4" enum="CustomControlContainer">
</constant>
<constant name="CONTAINER_CANVAS_EDITOR_SIDE" value="5">
<constant name="CONTAINER_CANVAS_EDITOR_SIDE" value="5" enum="CustomControlContainer">
</constant>
<constant name="CONTAINER_CANVAS_EDITOR_BOTTOM" value="6">
<constant name="CONTAINER_CANVAS_EDITOR_BOTTOM" value="6" enum="CustomControlContainer">
</constant>
<constant name="CONTAINER_PROPERTY_EDITOR_BOTTOM" value="7">
<constant name="CONTAINER_PROPERTY_EDITOR_BOTTOM" value="7" enum="CustomControlContainer">
</constant>
<constant name="DOCK_SLOT_LEFT_UL" value="0">
<constant name="DOCK_SLOT_LEFT_UL" value="0" enum="DockSlot">
</constant>
<constant name="DOCK_SLOT_LEFT_BL" value="1">
<constant name="DOCK_SLOT_LEFT_BL" value="1" enum="DockSlot">
</constant>
<constant name="DOCK_SLOT_LEFT_UR" value="2">
<constant name="DOCK_SLOT_LEFT_UR" value="2" enum="DockSlot">
</constant>
<constant name="DOCK_SLOT_LEFT_BR" value="3">
<constant name="DOCK_SLOT_LEFT_BR" value="3" enum="DockSlot">
</constant>
<constant name="DOCK_SLOT_RIGHT_UL" value="4">
<constant name="DOCK_SLOT_RIGHT_UL" value="4" enum="DockSlot">
</constant>
<constant name="DOCK_SLOT_RIGHT_BL" value="5">
<constant name="DOCK_SLOT_RIGHT_BL" value="5" enum="DockSlot">
</constant>
<constant name="DOCK_SLOT_RIGHT_UR" value="6">
<constant name="DOCK_SLOT_RIGHT_UR" value="6" enum="DockSlot">
</constant>
<constant name="DOCK_SLOT_RIGHT_BR" value="7">
<constant name="DOCK_SLOT_RIGHT_BR" value="7" enum="DockSlot">
</constant>
<constant name="DOCK_SLOT_MAX" value="8">
<constant name="DOCK_SLOT_MAX" value="8" enum="DockSlot">
</constant>
</constants>
</class>

50
doc/classes/Environment.xml
View file

@ -233,73 +233,73 @@
</member>
</members>
<constants>
<constant name="BG_KEEP" value="5">
<constant name="BG_KEEP" value="5" enum="BGMode">
Keep on screen every pixel drawn in the background.
</constant>
<constant name="BG_CLEAR_COLOR" value="0">
<constant name="BG_CLEAR_COLOR" value="0" enum="BGMode">
Clear the background using the project's clear color.
</constant>
<constant name="BG_COLOR" value="1">
<constant name="BG_COLOR" value="1" enum="BGMode">
Clear the background using a custom clear color.
</constant>
<constant name="BG_SKY" value="2">
<constant name="BG_SKY" value="2" enum="BGMode">
Display a user-defined sky in the background.
</constant>
<constant name="BG_COLOR_SKY" value="3">
<constant name="BG_COLOR_SKY" value="3" enum="BGMode">
Clear the background using a custom clear color and allows defining a sky for shading and reflection.
</constant>
<constant name="BG_CANVAS" value="4">
<constant name="BG_CANVAS" value="4" enum="BGMode">
Display a [CanvasLayer] in the background.
</constant>
<constant name="BG_MAX" value="6">
<constant name="BG_MAX" value="6" enum="BGMode">
Helper constant keeping track of the enum's size, has no direct usage in API calls.
</constant>
<constant name="GLOW_BLEND_MODE_ADDITIVE" value="0">
<constant name="GLOW_BLEND_MODE_ADDITIVE" value="0" enum="GlowBlendMode">
Additive glow blending mode. Mostly used for particles, glows (bloom), lens flare, bright sources.
</constant>
<constant name="GLOW_BLEND_MODE_SCREEN" value="1">
<constant name="GLOW_BLEND_MODE_SCREEN" value="1" enum="GlowBlendMode">
Screen glow blending mode. Increases brightness, used frequently with bloom.
</constant>
<constant name="GLOW_BLEND_MODE_SOFTLIGHT" value="2">
<constant name="GLOW_BLEND_MODE_SOFTLIGHT" value="2" enum="GlowBlendMode">
Softlight glow blending mode. Modifies contrast, exposes shadows and highlights, vivid bloom.
</constant>
<constant name="GLOW_BLEND_MODE_REPLACE" value="3">
<constant name="GLOW_BLEND_MODE_REPLACE" value="3" enum="GlowBlendMode">
Replace glow blending mode. Replaces all pixels' color by the glow value.
</constant>
<constant name="TONE_MAPPER_LINEAR" value="0">
<constant name="TONE_MAPPER_LINEAR" value="0" enum="ToneMapper">
Linear tonemapper operator. Reads the linear data and performs an exposure adjustment.
</constant>
<constant name="TONE_MAPPER_REINHARDT" value="1">
<constant name="TONE_MAPPER_REINHARDT" value="1" enum="ToneMapper">
Reinhardt tonemapper operator. Performs a variation on rendered pixels' colors by this formula: color = color / (1 + color).
</constant>
<constant name="TONE_MAPPER_FILMIC" value="2">
<constant name="TONE_MAPPER_FILMIC" value="2" enum="ToneMapper">
Filmic tonemapper operator.
</constant>
<constant name="TONE_MAPPER_ACES" value="3">
<constant name="TONE_MAPPER_ACES" value="3" enum="ToneMapper">
Academy Color Encoding System tonemapper operator.
</constant>
<constant name="DOF_BLUR_QUALITY_LOW" value="0">
<constant name="DOF_BLUR_QUALITY_LOW" value="0" enum="DOFBlurQuality">
Low depth-of-field blur quality.
</constant>
<constant name="DOF_BLUR_QUALITY_MEDIUM" value="1">
<constant name="DOF_BLUR_QUALITY_MEDIUM" value="1" enum="DOFBlurQuality">
Medium depth-of-field blur quality.
</constant>
<constant name="DOF_BLUR_QUALITY_HIGH" value="2">
<constant name="DOF_BLUR_QUALITY_HIGH" value="2" enum="DOFBlurQuality">
High depth-of-field blur quality.
</constant>
<constant name="SSAO_BLUR_DISABLED" value="0">
<constant name="SSAO_BLUR_DISABLED" value="0" enum="SSAOBlur">
</constant>
<constant name="SSAO_BLUR_1x1" value="1">
<constant name="SSAO_BLUR_1x1" value="1" enum="SSAOBlur">
</constant>
<constant name="SSAO_BLUR_2x2" value="2">
<constant name="SSAO_BLUR_2x2" value="2" enum="SSAOBlur">
</constant>
<constant name="SSAO_BLUR_3x3" value="3">
<constant name="SSAO_BLUR_3x3" value="3" enum="SSAOBlur">
</constant>
<constant name="SSAO_QUALITY_LOW" value="0">
<constant name="SSAO_QUALITY_LOW" value="0" enum="SSAOQuality">
</constant>
<constant name="SSAO_QUALITY_MEDIUM" value="1">
<constant name="SSAO_QUALITY_MEDIUM" value="1" enum="SSAOQuality">
</constant>
<constant name="SSAO_QUALITY_HIGH" value="2">
<constant name="SSAO_QUALITY_HIGH" value="2" enum="SSAOQuality">
</constant>
</constants>
</class>

16
doc/classes/File.xml
View file

@ -394,28 +394,28 @@
</method>
</methods>
<constants>
<constant name="READ" value="1">
<constant name="READ" value="1" enum="ModeFlags">
Opens the file for read operations.
</constant>
<constant name="WRITE" value="2">
<constant name="WRITE" value="2" enum="ModeFlags">
Opens the file for write operations. Create it if the file does not exist and truncate if it exists.
</constant>
<constant name="READ_WRITE" value="3">
<constant name="READ_WRITE" value="3" enum="ModeFlags">
Opens the file for read and write operations. Does not truncate the file.
</constant>
<constant name="WRITE_READ" value="7">
<constant name="WRITE_READ" value="7" enum="ModeFlags">
Opens the file for read and write operations. Create it if the file does not exist and truncate if it exists.
</constant>
<constant name="COMPRESSION_FASTLZ" value="0">
<constant name="COMPRESSION_FASTLZ" value="0" enum="CompressionMode">
Uses the FastLZ compression method.
</constant>
<constant name="COMPRESSION_DEFLATE" value="1">
<constant name="COMPRESSION_DEFLATE" value="1" enum="CompressionMode">
Uses the Deflate compression method.
</constant>
<constant name="COMPRESSION_ZSTD" value="2">
<constant name="COMPRESSION_ZSTD" value="2" enum="CompressionMode">
Uses the Zstd compression method.
</constant>
<constant name="COMPRESSION_GZIP" value="3">
<constant name="COMPRESSION_GZIP" value="3" enum="CompressionMode">
Uses the gzip compression method.
</constant>
</constants>

16
doc/classes/FileDialog.xml
View file

@ -124,28 +124,28 @@
</signal>
</signals>
<constants>
<constant name="MODE_OPEN_FILE" value="0">
<constant name="MODE_OPEN_FILE" value="0" enum="Mode">
The dialog allows the selection of one, and only one file.
</constant>
<constant name="MODE_OPEN_FILES" value="1">
<constant name="MODE_OPEN_FILES" value="1" enum="Mode">
The dialog allows the selection of multiple files.
</constant>
<constant name="MODE_OPEN_DIR" value="2">
<constant name="MODE_OPEN_DIR" value="2" enum="Mode">
The dialog functions as a folder selector, disallowing the selection of any file.
</constant>
<constant name="MODE_OPEN_ANY" value="3">
<constant name="MODE_OPEN_ANY" value="3" enum="Mode">
The dialog allows the selection of a file or a directory.
</constant>
<constant name="MODE_SAVE_FILE" value="4">
<constant name="MODE_SAVE_FILE" value="4" enum="Mode">
The dialog will warn when a file exists.
</constant>
<constant name="ACCESS_RESOURCES" value="0">
<constant name="ACCESS_RESOURCES" value="0" enum="Access">
The dialog allows the selection of file and directory.
</constant>
<constant name="ACCESS_USERDATA" value="1">
<constant name="ACCESS_USERDATA" value="1" enum="Access">
The dialog allows access files under [Resource] path(res://) .
</constant>
<constant name="ACCESS_FILESYSTEM" value="2">
<constant name="ACCESS_FILESYSTEM" value="2" enum="Access">
The dialog allows access files in whole file system.
</constant>
</constants>

10
doc/classes/GIProbe.xml
View file

@ -49,15 +49,15 @@
</member>
</members>
<constants>
<constant name="SUBDIV_64" value="0">
<constant name="SUBDIV_64" value="0" enum="Subdiv">
</constant>
<constant name="SUBDIV_128" value="1">
<constant name="SUBDIV_128" value="1" enum="Subdiv">
</constant>
<constant name="SUBDIV_256" value="2">
<constant name="SUBDIV_256" value="2" enum="Subdiv">
</constant>
<constant name="SUBDIV_512" value="3">
<constant name="SUBDIV_512" value="3" enum="Subdiv">
</constant>
<constant name="SUBDIV_MAX" value="4">
<constant name="SUBDIV_MAX" value="4" enum="Subdiv">
</constant>
</constants>
</class>

38
doc/classes/Generic6DOFJoint.xml
View file

@ -169,61 +169,61 @@
</member>
</members>
<constants>
<constant name="PARAM_LINEAR_LOWER_LIMIT" value="0">
<constant name="PARAM_LINEAR_LOWER_LIMIT" value="0" enum="Param">
The minimum difference between the pivot points' axes.
</constant>
<constant name="PARAM_LINEAR_UPPER_LIMIT" value="1">
<constant name="PARAM_LINEAR_UPPER_LIMIT" value="1" enum="Param">
The maximum difference between the pivot points' axes.
</constant>
<constant name="PARAM_LINEAR_LIMIT_SOFTNESS" value="2">
<constant name="PARAM_LINEAR_LIMIT_SOFTNESS" value="2" enum="Param">
A factor applied to the movement across the axes The lower, the slower the movement.
</constant>
<constant name="PARAM_LINEAR_RESTITUTION" value="3">
<constant name="PARAM_LINEAR_RESTITUTION" value="3" enum="Param">
The amount of restitution on the axes movement The lower, the more momentum gets lost.
</constant>
<constant name="PARAM_LINEAR_DAMPING" value="4">
<constant name="PARAM_LINEAR_DAMPING" value="4" enum="Param">
The amount of damping that happens at the linear motion across the axes.
</constant>
<constant name="PARAM_ANGULAR_LOWER_LIMIT" value="5">
<constant name="PARAM_ANGULAR_LOWER_LIMIT" value="5" enum="Param">
The minimum rotation in negative direction to break loose and rotate arround the axes.
</constant>
<constant name="PARAM_ANGULAR_UPPER_LIMIT" value="6">
<constant name="PARAM_ANGULAR_UPPER_LIMIT" value="6" enum="Param">
The minimum rotation in positive direction to break loose and rotate arround the axes.
</constant>
<constant name="PARAM_ANGULAR_LIMIT_SOFTNESS" value="7">
<constant name="PARAM_ANGULAR_LIMIT_SOFTNESS" value="7" enum="Param">
The speed of all rotations across the axes.
</constant>
<constant name="PARAM_ANGULAR_DAMPING" value="8">
<constant name="PARAM_ANGULAR_DAMPING" value="8" enum="Param">
The amount of rotational damping across the axes. The lower, the more dampening occurs.
</constant>
<constant name="PARAM_ANGULAR_RESTITUTION" value="9">
<constant name="PARAM_ANGULAR_RESTITUTION" value="9" enum="Param">
The amount of rotational restitution across the axes. The lower, the more restitution occurs.
</constant>
<constant name="PARAM_ANGULAR_FORCE_LIMIT" value="10">
<constant name="PARAM_ANGULAR_FORCE_LIMIT" value="10" enum="Param">
The maximum amount of force that can occur, when rotating arround the axes.
</constant>
<constant name="PARAM_ANGULAR_ERP" value="11">
<constant name="PARAM_ANGULAR_ERP" value="11" enum="Param">
When rotating across the axes, this error tolerance factor defines how much the correction gets slowed down. The lower, the slower.
</constant>
<constant name="PARAM_ANGULAR_MOTOR_TARGET_VELOCITY" value="12">
<constant name="PARAM_ANGULAR_MOTOR_TARGET_VELOCITY" value="12" enum="Param">
Target speed for the motor at the axes.
</constant>
<constant name="PARAM_ANGULAR_MOTOR_FORCE_LIMIT" value="13">
<constant name="PARAM_ANGULAR_MOTOR_FORCE_LIMIT" value="13" enum="Param">
Maximum acceleration for the motor at the axes.
</constant>
<constant name="PARAM_MAX" value="14">
<constant name="PARAM_MAX" value="14" enum="Param">
End flag of PARAM_* constants, used internally.
</constant>
<constant name="FLAG_ENABLE_LINEAR_LIMIT" value="0">
<constant name="FLAG_ENABLE_LINEAR_LIMIT" value="0" enum="Flag">
If [code]set[/code] there is linear motion possible within the given limits.
</constant>
<constant name="FLAG_ENABLE_ANGULAR_LIMIT" value="1">
<constant name="FLAG_ENABLE_ANGULAR_LIMIT" value="1" enum="Flag">
If [code]set[/code] there is rotational motion possible.
</constant>
<constant name="FLAG_ENABLE_MOTOR" value="2">
<constant name="FLAG_ENABLE_MOTOR" value="2" enum="Flag">
If [code]set[/code] there is a rotational motor across these axes.
</constant>
<constant name="FLAG_MAX" value="3">
<constant name="FLAG_MAX" value="3" enum="Flag">
End flag of FLAG_* constants, used internally.
</constant>
</constants>

12
doc/classes/GeometryInstance.xml
View file

@ -31,17 +31,17 @@
</member>
</members>
<constants>
<constant name="SHADOW_CASTING_SETTING_OFF" value="0">
<constant name="SHADOW_CASTING_SETTING_OFF" value="0" enum="ShadowCastingSetting">
</constant>
<constant name="SHADOW_CASTING_SETTING_ON" value="1">
<constant name="SHADOW_CASTING_SETTING_ON" value="1" enum="ShadowCastingSetting">
</constant>
<constant name="SHADOW_CASTING_SETTING_DOUBLE_SIDED" value="2">
<constant name="SHADOW_CASTING_SETTING_DOUBLE_SIDED" value="2" enum="ShadowCastingSetting">
</constant>
<constant name="SHADOW_CASTING_SETTING_SHADOWS_ONLY" value="3">
<constant name="SHADOW_CASTING_SETTING_SHADOWS_ONLY" value="3" enum="ShadowCastingSetting">
</constant>
<constant name="FLAG_USE_BAKED_LIGHT" value="0">
<constant name="FLAG_USE_BAKED_LIGHT" value="0" enum="Flags">
</constant>
<constant name="FLAG_MAX" value="1">
<constant name="FLAG_MAX" value="1" enum="Flags">
</constant>
</constants>
</class>

6
doc/classes/GraphNode.xml
View file

@ -273,11 +273,11 @@
</signal>
</signals>
<constants>
<constant name="OVERLAY_DISABLED" value="0">
<constant name="OVERLAY_DISABLED" value="0" enum="Overlay">
</constant>
<constant name="OVERLAY_BREAKPOINT" value="1">
<constant name="OVERLAY_BREAKPOINT" value="1" enum="Overlay">
</constant>
<constant name="OVERLAY_POSITION" value="2">
<constant name="OVERLAY_POSITION" value="2" enum="Overlay">
</constant>
</constants>
<theme_items>

136
doc/classes/HTTPClient.xml
View file

@ -198,141 +198,141 @@
</method>
</methods>
<constants>
<constant name="METHOD_GET" value="0">
<constant name="METHOD_GET" value="0" enum="Method">
</constant>
<constant name="METHOD_HEAD" value="1">
<constant name="METHOD_HEAD" value="1" enum="Method">
</constant>
<constant name="METHOD_POST" value="2">
<constant name="METHOD_POST" value="2" enum="Method">
</constant>
<constant name="METHOD_PUT" value="3">
<constant name="METHOD_PUT" value="3" enum="Method">
</constant>
<constant name="METHOD_DELETE" value="4">
<constant name="METHOD_DELETE" value="4" enum="Method">
</constant>
<constant name="METHOD_OPTIONS" value="5">
<constant name="METHOD_OPTIONS" value="5" enum="Method">
</constant>
<constant name="METHOD_TRACE" value="6">
<constant name="METHOD_TRACE" value="6" enum="Method">
</constant>
<constant name="METHOD_CONNECT" value="7">
<constant name="METHOD_CONNECT" value="7" enum="Method">
</constant>
<constant name="METHOD_MAX" value="8">
<constant name="METHOD_MAX" value="8" enum="Method">
</constant>
<constant name="STATUS_DISCONNECTED" value="0">
<constant name="STATUS_DISCONNECTED" value="0" enum="Status">
</constant>
<constant name="STATUS_RESOLVING" value="1">
<constant name="STATUS_RESOLVING" value="1" enum="Status">
</constant>
<constant name="STATUS_CANT_RESOLVE" value="2">
<constant name="STATUS_CANT_RESOLVE" value="2" enum="Status">
</constant>
<constant name="STATUS_CONNECTING" value="3">
<constant name="STATUS_CONNECTING" value="3" enum="Status">
</constant>
<constant name="STATUS_CANT_CONNECT" value="4">
<constant name="STATUS_CANT_CONNECT" value="4" enum="Status">
</constant>
<constant name="STATUS_CONNECTED" value="5">
<constant name="STATUS_CONNECTED" value="5" enum="Status">
</constant>
<constant name="STATUS_REQUESTING" value="6">
<constant name="STATUS_REQUESTING" value="6" enum="Status">
</constant>
<constant name="STATUS_BODY" value="7">
<constant name="STATUS_BODY" value="7" enum="Status">
</constant>
<constant name="STATUS_CONNECTION_ERROR" value="8">
<constant name="STATUS_CONNECTION_ERROR" value="8" enum="Status">
</constant>
<constant name="STATUS_SSL_HANDSHAKE_ERROR" value="9">
<constant name="STATUS_SSL_HANDSHAKE_ERROR" value="9" enum="Status">
</constant>
<constant name="RESPONSE_CONTINUE" value="100">
<constant name="RESPONSE_CONTINUE" value="100" enum="ResponseCode">
</constant>
<constant name="RESPONSE_SWITCHING_PROTOCOLS" value="101">
<constant name="RESPONSE_SWITCHING_PROTOCOLS" value="101" enum="ResponseCode">
</constant>
<constant name="RESPONSE_PROCESSING" value="102">
<constant name="RESPONSE_PROCESSING" value="102" enum="ResponseCode">
</constant>
<constant name="RESPONSE_OK" value="200">
<constant name="RESPONSE_OK" value="200" enum="ResponseCode">
</constant>
<constant name="RESPONSE_CREATED" value="201">
<constant name="RESPONSE_CREATED" value="201" enum="ResponseCode">
</constant>
<constant name="RESPONSE_ACCEPTED" value="202">
<constant name="RESPONSE_ACCEPTED" value="202" enum="ResponseCode">
</constant>
<constant name="RESPONSE_NON_AUTHORITATIVE_INFORMATION" value="203">
<constant name="RESPONSE_NON_AUTHORITATIVE_INFORMATION" value="203" enum="ResponseCode">
</constant>
<constant name="RESPONSE_NO_CONTENT" value="204">
<constant name="RESPONSE_NO_CONTENT" value="204" enum="ResponseCode">
</constant>
<constant name="RESPONSE_RESET_CONTENT" value="205">
<constant name="RESPONSE_RESET_CONTENT" value="205" enum="ResponseCode">
</constant>
<constant name="RESPONSE_PARTIAL_CONTENT" value="206">
<constant name="RESPONSE_PARTIAL_CONTENT" value="206" enum="ResponseCode">
</constant>
<constant name="RESPONSE_MULTI_STATUS" value="207">
<constant name="RESPONSE_MULTI_STATUS" value="207" enum="ResponseCode">
</constant>
<constant name="RESPONSE_IM_USED" value="226">
<constant name="RESPONSE_IM_USED" value="226" enum="ResponseCode">
</constant>
<constant name="RESPONSE_MULTIPLE_CHOICES" value="300">
<constant name="RESPONSE_MULTIPLE_CHOICES" value="300" enum="ResponseCode">
</constant>
<constant name="RESPONSE_MOVED_PERMANENTLY" value="301">
<constant name="RESPONSE_MOVED_PERMANENTLY" value="301" enum="ResponseCode">
</constant>
<constant name="RESPONSE_FOUND" value="302">
<constant name="RESPONSE_FOUND" value="302" enum="ResponseCode">
</constant>
<constant name="RESPONSE_SEE_OTHER" value="303">
<constant name="RESPONSE_SEE_OTHER" value="303" enum="ResponseCode">
</constant>
<constant name="RESPONSE_NOT_MODIFIED" value="304">
<constant name="RESPONSE_NOT_MODIFIED" value="304" enum="ResponseCode">
</constant>
<constant name="RESPONSE_USE_PROXY" value="305">
<constant name="RESPONSE_USE_PROXY" value="305" enum="ResponseCode">
</constant>
<constant name="RESPONSE_TEMPORARY_REDIRECT" value="307">
<constant name="RESPONSE_TEMPORARY_REDIRECT" value="307" enum="ResponseCode">
</constant>
<constant name="RESPONSE_BAD_REQUEST" value="400">
<constant name="RESPONSE_BAD_REQUEST" value="400" enum="ResponseCode">
</constant>
<constant name="RESPONSE_UNAUTHORIZED" value="401">
<constant name="RESPONSE_UNAUTHORIZED" value="401" enum="ResponseCode">
</constant>
<constant name="RESPONSE_PAYMENT_REQUIRED" value="402">
<constant name="RESPONSE_PAYMENT_REQUIRED" value="402" enum="ResponseCode">
</constant>
<constant name="RESPONSE_FORBIDDEN" value="403">
<constant name="RESPONSE_FORBIDDEN" value="403" enum="ResponseCode">
</constant>
<constant name="RESPONSE_NOT_FOUND" value="404">
<constant name="RESPONSE_NOT_FOUND" value="404" enum="ResponseCode">
</constant>
<constant name="RESPONSE_METHOD_NOT_ALLOWED" value="405">
<constant name="RESPONSE_METHOD_NOT_ALLOWED" value="405" enum="ResponseCode">
</constant>
<constant name="RESPONSE_NOT_ACCEPTABLE" value="406">
<constant name="RESPONSE_NOT_ACCEPTABLE" value="406" enum="ResponseCode">
</constant>
<constant name="RESPONSE_PROXY_AUTHENTICATION_REQUIRED" value="407">
<constant name="RESPONSE_PROXY_AUTHENTICATION_REQUIRED" value="407" enum="ResponseCode">
</constant>
<constant name="RESPONSE_REQUEST_TIMEOUT" value="408">
<constant name="RESPONSE_REQUEST_TIMEOUT" value="408" enum="ResponseCode">
</constant>
<constant name="RESPONSE_CONFLICT" value="409">
<constant name="RESPONSE_CONFLICT" value="409" enum="ResponseCode">
</constant>
<constant name="RESPONSE_GONE" value="410">
<constant name="RESPONSE_GONE" value="410" enum="ResponseCode">
</constant>
<constant name="RESPONSE_LENGTH_REQUIRED" value="411">
<constant name="RESPONSE_LENGTH_REQUIRED" value="411" enum="ResponseCode">
</constant>
<constant name="RESPONSE_PRECONDITION_FAILED" value="412">
<constant name="RESPONSE_PRECONDITION_FAILED" value="412" enum="ResponseCode">
</constant>
<constant name="RESPONSE_REQUEST_ENTITY_TOO_LARGE" value="413">
<constant name="RESPONSE_REQUEST_ENTITY_TOO_LARGE" value="413" enum="ResponseCode">
</constant>
<constant name="RESPONSE_REQUEST_URI_TOO_LONG" value="414">
<constant name="RESPONSE_REQUEST_URI_TOO_LONG" value="414" enum="ResponseCode">
</constant>
<constant name="RESPONSE_UNSUPPORTED_MEDIA_TYPE" value="415">
<constant name="RESPONSE_UNSUPPORTED_MEDIA_TYPE" value="415" enum="ResponseCode">
</constant>
<constant name="RESPONSE_REQUESTED_RANGE_NOT_SATISFIABLE" value="416">
<constant name="RESPONSE_REQUESTED_RANGE_NOT_SATISFIABLE" value="416" enum="ResponseCode">
</constant>
<constant name="RESPONSE_EXPECTATION_FAILED" value="417">
<constant name="RESPONSE_EXPECTATION_FAILED" value="417" enum="ResponseCode">
</constant>
<constant name="RESPONSE_UNPROCESSABLE_ENTITY" value="422">
<constant name="RESPONSE_UNPROCESSABLE_ENTITY" value="422" enum="ResponseCode">
</constant>
<constant name="RESPONSE_LOCKED" value="423">
<constant name="RESPONSE_LOCKED" value="423" enum="ResponseCode">
</constant>
<constant name="RESPONSE_FAILED_DEPENDENCY" value="424">
<constant name="RESPONSE_FAILED_DEPENDENCY" value="424" enum="ResponseCode">
</constant>
<constant name="RESPONSE_UPGRADE_REQUIRED" value="426">
<constant name="RESPONSE_UPGRADE_REQUIRED" value="426" enum="ResponseCode">
</constant>
<constant name="RESPONSE_INTERNAL_SERVER_ERROR" value="500">
<constant name="RESPONSE_INTERNAL_SERVER_ERROR" value="500" enum="ResponseCode">
</constant>
<constant name="RESPONSE_NOT_IMPLEMENTED" value="501">
<constant name="RESPONSE_NOT_IMPLEMENTED" value="501" enum="ResponseCode">
</constant>
<constant name="RESPONSE_BAD_GATEWAY" value="502">
<constant name="RESPONSE_BAD_GATEWAY" value="502" enum="ResponseCode">
</constant>
<constant name="RESPONSE_SERVICE_UNAVAILABLE" value="503">
<constant name="RESPONSE_SERVICE_UNAVAILABLE" value="503" enum="ResponseCode">
</constant>
<constant name="RESPONSE_GATEWAY_TIMEOUT" value="504">
<constant name="RESPONSE_GATEWAY_TIMEOUT" value="504" enum="ResponseCode">
</constant>
<constant name="RESPONSE_HTTP_VERSION_NOT_SUPPORTED" value="505">
<constant name="RESPONSE_HTTP_VERSION_NOT_SUPPORTED" value="505" enum="ResponseCode">
</constant>
<constant name="RESPONSE_INSUFFICIENT_STORAGE" value="507">
<constant name="RESPONSE_INSUFFICIENT_STORAGE" value="507" enum="ResponseCode">
</constant>
<constant name="RESPONSE_NOT_EXTENDED" value="510">
<constant name="RESPONSE_NOT_EXTENDED" value="510" enum="ResponseCode">
</constant>
</constants>
</class>

24
doc/classes/HTTPRequest.xml
View file

@ -97,39 +97,39 @@
</signal>
</signals>
<constants>
<constant name="RESULT_SUCCESS" value="0">
<constant name="RESULT_SUCCESS" value="0" enum="Result">
Request successful.
</constant>
<constant name="RESULT_CHUNKED_BODY_SIZE_MISMATCH" value="1">
<constant name="RESULT_CHUNKED_BODY_SIZE_MISMATCH" value="1" enum="Result">
</constant>
<constant name="RESULT_CANT_CONNECT" value="2">
<constant name="RESULT_CANT_CONNECT" value="2" enum="Result">
Request failed while connecting.
</constant>
<constant name="RESULT_CANT_RESOLVE" value="3">
<constant name="RESULT_CANT_RESOLVE" value="3" enum="Result">
Request failed while resolving.
</constant>
<constant name="RESULT_CONNECTION_ERROR" value="4">
<constant name="RESULT_CONNECTION_ERROR" value="4" enum="Result">
Request failed due to connection(read/write) error.
</constant>
<constant name="RESULT_SSL_HANDSHAKE_ERROR" value="5">
<constant name="RESULT_SSL_HANDSHAKE_ERROR" value="5" enum="Result">
Request failed on SSL handshake.
</constant>
<constant name="RESULT_NO_RESPONSE" value="6">
<constant name="RESULT_NO_RESPONSE" value="6" enum="Result">
Request does not have a response(yet).
</constant>
<constant name="RESULT_BODY_SIZE_LIMIT_EXCEEDED" value="7">
<constant name="RESULT_BODY_SIZE_LIMIT_EXCEEDED" value="7" enum="Result">
Request exceeded its maximum size limit, see [method set_body_size_limit].
</constant>
<constant name="RESULT_REQUEST_FAILED" value="8">
<constant name="RESULT_REQUEST_FAILED" value="8" enum="Result">
Request failed. (unused)
</constant>
<constant name="RESULT_DOWNLOAD_FILE_CANT_OPEN" value="9">
<constant name="RESULT_DOWNLOAD_FILE_CANT_OPEN" value="9" enum="Result">
HTTPRequest couldn't open the download file.
</constant>
<constant name="RESULT_DOWNLOAD_FILE_WRITE_ERROR" value="10">
<constant name="RESULT_DOWNLOAD_FILE_WRITE_ERROR" value="10" enum="Result">
HTTPRequest couldn't write to the download file.
</constant>
<constant name="RESULT_REDIRECT_LIMIT_REACHED" value="11">
<constant name="RESULT_REDIRECT_LIMIT_REACHED" value="11" enum="Result">
Request reached its maximum redirect limit, see [method set_max_redirects].
</constant>
</constants>

24
doc/classes/HingeJoint.xml
View file

@ -44,39 +44,39 @@
</member>
</members>
<constants>
<constant name="PARAM_BIAS" value="0">
<constant name="PARAM_BIAS" value="0" enum="Param">
The speed with wich the two bodies get pulled together when they move in different directions.
</constant>
<constant name="PARAM_LIMIT_UPPER" value="1">
<constant name="PARAM_LIMIT_UPPER" value="1" enum="Param">
The maximum rotation. only active if [member angular_limit/enable] is [code]true[/code].
</constant>
<constant name="PARAM_LIMIT_LOWER" value="2">
<constant name="PARAM_LIMIT_LOWER" value="2" enum="Param">
The minimum rotation. only active if [member angular_limit/enable] is [code]true[/code].
</constant>
<constant name="PARAM_LIMIT_BIAS" value="3">
<constant name="PARAM_LIMIT_BIAS" value="3" enum="Param">
The speed with which the rotation across the axis perpendicular to the hinge gets corrected.
</constant>
<constant name="PARAM_LIMIT_SOFTNESS" value="4">
<constant name="PARAM_LIMIT_SOFTNESS" value="4" enum="Param">
</constant>
<constant name="PARAM_LIMIT_RELAXATION" value="5">
<constant name="PARAM_LIMIT_RELAXATION" value="5" enum="Param">
The lower this value, the more the rotation gets slowed down.
</constant>
<constant name="PARAM_MOTOR_TARGET_VELOCITY" value="6">
<constant name="PARAM_MOTOR_TARGET_VELOCITY" value="6" enum="Param">
Target speed for the motor.
</constant>
<constant name="PARAM_MOTOR_MAX_IMPULSE" value="7">
<constant name="PARAM_MOTOR_MAX_IMPULSE" value="7" enum="Param">
Maximum acceleration for the motor.
</constant>
<constant name="PARAM_MAX" value="8">
<constant name="PARAM_MAX" value="8" enum="Param">
End flag of PARAM_* constants, used internally.
</constant>
<constant name="FLAG_USE_LIMIT" value="0">
<constant name="FLAG_USE_LIMIT" value="0" enum="Flag">
If [code]true[/code] the hinges maximum and minimum rotation, defined by [member angular_limit/lower] and [member angular_limit/upper] has effects.
</constant>
<constant name="FLAG_ENABLE_MOTOR" value="1">
<constant name="FLAG_ENABLE_MOTOR" value="1" enum="Flag">
When activated, a motor turns the hinge.
</constant>
<constant name="FLAG_MAX" value="2">
<constant name="FLAG_MAX" value="2" enum="Flag">
End flag of FLAG_* constants, used internally.
</constant>
</constants>

20
doc/classes/IP.xml
View file

@ -78,25 +78,25 @@
</method>
</methods>
<constants>
<constant name="RESOLVER_STATUS_NONE" value="0">
<constant name="RESOLVER_STATUS_NONE" value="0" enum="ResolverStatus">
</constant>
<constant name="RESOLVER_STATUS_WAITING" value="1">
<constant name="RESOLVER_STATUS_WAITING" value="1" enum="ResolverStatus">
</constant>
<constant name="RESOLVER_STATUS_DONE" value="2">
<constant name="RESOLVER_STATUS_DONE" value="2" enum="ResolverStatus">
</constant>
<constant name="RESOLVER_STATUS_ERROR" value="3">
<constant name="RESOLVER_STATUS_ERROR" value="3" enum="ResolverStatus">
</constant>
<constant name="RESOLVER_MAX_QUERIES" value="32" enum="">
<constant name="RESOLVER_MAX_QUERIES" value="32">
</constant>
<constant name="RESOLVER_INVALID_ID" value="-1" enum="">
<constant name="RESOLVER_INVALID_ID" value="-1">
</constant>
<constant name="TYPE_NONE" value="0">
<constant name="TYPE_NONE" value="0" enum="Type">
</constant>
<constant name="TYPE_IPV4" value="1">
<constant name="TYPE_IPV4" value="1" enum="Type">
</constant>
<constant name="TYPE_IPV6" value="2">
<constant name="TYPE_IPV6" value="2" enum="Type">
</constant>
<constant name="TYPE_ANY" value="3">
<constant name="TYPE_ANY" value="3" enum="Type">
</constant>
</constants>
</class>

104
doc/classes/Image.xml
View file

@ -414,109 +414,109 @@
</member>
</members>
<constants>
<constant name="FORMAT_L8" value="0">
<constant name="FORMAT_L8" value="0" enum="Format">
</constant>
<constant name="FORMAT_LA8" value="1">
<constant name="FORMAT_LA8" value="1" enum="Format">
</constant>
<constant name="FORMAT_R8" value="2">
<constant name="FORMAT_R8" value="2" enum="Format">
</constant>
<constant name="FORMAT_RG8" value="3">
<constant name="FORMAT_RG8" value="3" enum="Format">
</constant>
<constant name="FORMAT_RGB8" value="4">
<constant name="FORMAT_RGB8" value="4" enum="Format">
</constant>
<constant name="FORMAT_RGBA8" value="5">
<constant name="FORMAT_RGBA8" value="5" enum="Format">
</constant>
<constant name="FORMAT_RGBA4444" value="6">
<constant name="FORMAT_RGBA4444" value="6" enum="Format">
</constant>
<constant name="FORMAT_RGBA5551" value="7">
<constant name="FORMAT_RGBA5551" value="7" enum="Format">
</constant>
<constant name="FORMAT_RF" value="8">
<constant name="FORMAT_RF" value="8" enum="Format">
</constant>
<constant name="FORMAT_RGF" value="9">
<constant name="FORMAT_RGF" value="9" enum="Format">
</constant>
<constant name="FORMAT_RGBF" value="10">
<constant name="FORMAT_RGBF" value="10" enum="Format">
</constant>
<constant name="FORMAT_RGBAF" value="11">
<constant name="FORMAT_RGBAF" value="11" enum="Format">
</constant>
<constant name="FORMAT_RH" value="12">
<constant name="FORMAT_RH" value="12" enum="Format">
</constant>
<constant name="FORMAT_RGH" value="13">
<constant name="FORMAT_RGH" value="13" enum="Format">
</constant>
<constant name="FORMAT_RGBH" value="14">
<constant name="FORMAT_RGBH" value="14" enum="Format">
</constant>
<constant name="FORMAT_RGBAH" value="15">
<constant name="FORMAT_RGBAH" value="15" enum="Format">
</constant>
<constant name="FORMAT_RGBE9995" value="16">
<constant name="FORMAT_RGBE9995" value="16" enum="Format">
</constant>
<constant name="FORMAT_DXT1" value="17">
<constant name="FORMAT_DXT1" value="17" enum="Format">
</constant>
<constant name="FORMAT_DXT3" value="18">
<constant name="FORMAT_DXT3" value="18" enum="Format">
</constant>
<constant name="FORMAT_DXT5" value="19">
<constant name="FORMAT_DXT5" value="19" enum="Format">
</constant>
<constant name="FORMAT_RGTC_R" value="20">
<constant name="FORMAT_RGTC_R" value="20" enum="Format">
</constant>
<constant name="FORMAT_RGTC_RG" value="21">
<constant name="FORMAT_RGTC_RG" value="21" enum="Format">
</constant>
<constant name="FORMAT_BPTC_RGBA" value="22">
<constant name="FORMAT_BPTC_RGBA" value="22" enum="Format">
</constant>
<constant name="FORMAT_BPTC_RGBF" value="23">
<constant name="FORMAT_BPTC_RGBF" value="23" enum="Format">
</constant>
<constant name="FORMAT_BPTC_RGBFU" value="24">
<constant name="FORMAT_BPTC_RGBFU" value="24" enum="Format">
</constant>
<constant name="FORMAT_PVRTC2" value="25">
<constant name="FORMAT_PVRTC2" value="25" enum="Format">
</constant>
<constant name="FORMAT_PVRTC2A" value="26">
<constant name="FORMAT_PVRTC2A" value="26" enum="Format">
</constant>
<constant name="FORMAT_PVRTC4" value="27">
<constant name="FORMAT_PVRTC4" value="27" enum="Format">
</constant>
<constant name="FORMAT_PVRTC4A" value="28">
<constant name="FORMAT_PVRTC4A" value="28" enum="Format">
</constant>
<constant name="FORMAT_ETC" value="29">
<constant name="FORMAT_ETC" value="29" enum="Format">
</constant>
<constant name="FORMAT_ETC2_R11" value="30">
<constant name="FORMAT_ETC2_R11" value="30" enum="Format">
</constant>
<constant name="FORMAT_ETC2_R11S" value="31">
<constant name="FORMAT_ETC2_R11S" value="31" enum="Format">
</constant>
<constant name="FORMAT_ETC2_RG11" value="32">
<constant name="FORMAT_ETC2_RG11" value="32" enum="Format">
</constant>
<constant name="FORMAT_ETC2_RG11S" value="33">
<constant name="FORMAT_ETC2_RG11S" value="33" enum="Format">
</constant>
<constant name="FORMAT_ETC2_RGB8" value="34">
<constant name="FORMAT_ETC2_RGB8" value="34" enum="Format">
</constant>
<constant name="FORMAT_ETC2_RGBA8" value="35">
<constant name="FORMAT_ETC2_RGBA8" value="35" enum="Format">
</constant>
<constant name="FORMAT_ETC2_RGB8A1" value="36">
<constant name="FORMAT_ETC2_RGB8A1" value="36" enum="Format">
</constant>
<constant name="FORMAT_MAX" value="37">
<constant name="FORMAT_MAX" value="37" enum="Format">
</constant>
<constant name="INTERPOLATE_NEAREST" value="0">
<constant name="INTERPOLATE_NEAREST" value="0" enum="Interpolation">
</constant>
<constant name="INTERPOLATE_BILINEAR" value="1">
<constant name="INTERPOLATE_BILINEAR" value="1" enum="Interpolation">
</constant>
<constant name="INTERPOLATE_CUBIC" value="2">
<constant name="INTERPOLATE_CUBIC" value="2" enum="Interpolation">
</constant>
<constant name="ALPHA_NONE" value="0">
<constant name="ALPHA_NONE" value="0" enum="AlphaMode">
</constant>
<constant name="ALPHA_BIT" value="1">
<constant name="ALPHA_BIT" value="1" enum="AlphaMode">
</constant>
<constant name="ALPHA_BLEND" value="2">
<constant name="ALPHA_BLEND" value="2" enum="AlphaMode">
</constant>
<constant name="COMPRESS_S3TC" value="0">
<constant name="COMPRESS_S3TC" value="0" enum="CompressMode">
</constant>
<constant name="COMPRESS_PVRTC2" value="1">
<constant name="COMPRESS_PVRTC2" value="1" enum="CompressMode">
</constant>
<constant name="COMPRESS_PVRTC4" value="2">
<constant name="COMPRESS_PVRTC4" value="2" enum="CompressMode">
</constant>
<constant name="COMPRESS_ETC" value="3">
<constant name="COMPRESS_ETC" value="3" enum="CompressMode">
</constant>
<constant name="COMPRESS_ETC2" value="4">
<constant name="COMPRESS_ETC2" value="4" enum="CompressMode">
</constant>
<constant name="COMPRESS_SOURCE_GENERIC" value="0">
<constant name="COMPRESS_SOURCE_GENERIC" value="0" enum="CompressSource">
</constant>
<constant name="COMPRESS_SOURCE_SRGB" value="1">
<constant name="COMPRESS_SOURCE_SRGB" value="1" enum="CompressSource">
</constant>
<constant name="COMPRESS_SOURCE_NORMAL" value="2">
<constant name="COMPRESS_SOURCE_NORMAL" value="2" enum="CompressSource">
</constant>
</constants>
</class>

6
doc/classes/ImageTexture.xml
View file

@ -107,13 +107,13 @@
</method>
</methods>
<constants>
<constant name="STORAGE_RAW" value="0">
<constant name="STORAGE_RAW" value="0" enum="Storage">
[Image] data is stored raw and unaltered.
</constant>
<constant name="STORAGE_COMPRESS_LOSSY" value="1">
<constant name="STORAGE_COMPRESS_LOSSY" value="1" enum="Storage">
[Image] data is compressed with a lossy algorithm. You can set the storage quality with [method set_lossy_storage_quality].
</constant>
<constant name="STORAGE_COMPRESS_LOSSLESS" value="2">
<constant name="STORAGE_COMPRESS_LOSSLESS" value="2" enum="Storage">
[Image] data is compressed with a lossless algorithm.
</constant>
</constants>

8
doc/classes/Input.xml
View file

@ -336,16 +336,16 @@
</signal>
</signals>
<constants>
<constant name="MOUSE_MODE_VISIBLE" value="0">
<constant name="MOUSE_MODE_VISIBLE" value="0" enum="MouseMode">
Makes the mouse cursor visible if it is hidden.
</constant>
<constant name="MOUSE_MODE_HIDDEN" value="1">
<constant name="MOUSE_MODE_HIDDEN" value="1" enum="MouseMode">
Makes the mouse cursor hidden if it is visible.
</constant>
<constant name="MOUSE_MODE_CAPTURED" value="2">
<constant name="MOUSE_MODE_CAPTURED" value="2" enum="MouseMode">
Captures the mouse. The mouse will be hidden and unable to leave the game window. But it will still register movement and mouse button presses.
</constant>
<constant name="MOUSE_MODE_CONFINED" value="3">
<constant name="MOUSE_MODE_CONFINED" value="3" enum="MouseMode">
</constant>
</constants>
</class>

19
doc/classes/InputEventGesture.xml Normal file
View file

@ -0,0 +1,19 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="InputEventGesture" inherits="InputEventWithModifiers" category="Core" version="3.0-beta">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<demos>
</demos>
<methods>
</methods>
<members>
<member name="position" type="Vector2" setter="set_position" getter="get_position">
</member>
</members>
<constants>
</constants>
</class>

19
doc/classes/InputEventMagnifyGesture.xml Normal file
View file

@ -0,0 +1,19 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="InputEventMagnifyGesture" inherits="InputEventGesture" category="Core" version="3.0-beta">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<demos>
</demos>
<methods>
</methods>
<members>
<member name="factor" type="float" setter="set_factor" getter="get_factor">
</member>
</members>
<constants>
</constants>
</class>

19
doc/classes/InputEventPanGesture.xml Normal file
View file

@ -0,0 +1,19 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="InputEventPanGesture" inherits="InputEventGesture" category="Core" version="3.0-beta">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<demos>
</demos>
<methods>
</methods>
<members>
<member name="delta" type="Vector2" setter="set_delta" getter="get_delta">
</member>
</members>
<constants>
</constants>
</class>

8
doc/classes/ItemList.xml
View file

@ -386,13 +386,13 @@
</signal>
</signals>
<constants>
<constant name="ICON_MODE_TOP" value="0">
<constant name="ICON_MODE_TOP" value="0" enum="IconMode">
</constant>
<constant name="ICON_MODE_LEFT" value="1">
<constant name="ICON_MODE_LEFT" value="1" enum="IconMode">
</constant>
<constant name="SELECT_SINGLE" value="0">
<constant name="SELECT_SINGLE" value="0" enum="SelectMode">
</constant>
<constant name="SELECT_MULTI" value="1">
<constant name="SELECT_MULTI" value="1" enum="SelectMode">
</constant>
</constants>
<theme_items>

16
doc/classes/Label.xml
View file

@ -86,28 +86,28 @@
</member>
</members>
<constants>
<constant name="ALIGN_LEFT" value="0">
<constant name="ALIGN_LEFT" value="0" enum="Align">
Align rows to the left (default).
</constant>
<constant name="ALIGN_CENTER" value="1">
<constant name="ALIGN_CENTER" value="1" enum="Align">
Align rows centered.
</constant>
<constant name="ALIGN_RIGHT" value="2">
<constant name="ALIGN_RIGHT" value="2" enum="Align">
Align rows to the right (default).
</constant>
<constant name="ALIGN_FILL" value="3">
<constant name="ALIGN_FILL" value="3" enum="Align">
Expand row whitespaces to fit the width.
</constant>
<constant name="VALIGN_TOP" value="0">
<constant name="VALIGN_TOP" value="0" enum="VAlign">
Align the whole text to the top.
</constant>
<constant name="VALIGN_CENTER" value="1">
<constant name="VALIGN_CENTER" value="1" enum="VAlign">
Align the whole text to the center.
</constant>
<constant name="VALIGN_BOTTOM" value="2">
<constant name="VALIGN_BOTTOM" value="2" enum="VAlign">
Align the whole text to the bottom.
</constant>
<constant name="VALIGN_FILL" value="3">
<constant name="VALIGN_FILL" value="3" enum="VAlign">
Align the whole text by spreading the rows.
</constant>
</constants>

32
doc/classes/Light.xml
View file

@ -39,37 +39,37 @@
</member>
</members>
<constants>
<constant name="PARAM_ENERGY" value="0">
<constant name="PARAM_ENERGY" value="0" enum="Param">
</constant>
<constant name="PARAM_INDIRECT_ENERGY" value="1">
<constant name="PARAM_INDIRECT_ENERGY" value="1" enum="Param">
</constant>
<constant name="PARAM_SPECULAR" value="2">
<constant name="PARAM_SPECULAR" value="2" enum="Param">
</constant>
<constant name="PARAM_RANGE" value="3">
<constant name="PARAM_RANGE" value="3" enum="Param">
</constant>
<constant name="PARAM_ATTENUATION" value="4">
<constant name="PARAM_ATTENUATION" value="4" enum="Param">
</constant>
<constant name="PARAM_SPOT_ANGLE" value="5">
<constant name="PARAM_SPOT_ANGLE" value="5" enum="Param">
</constant>
<constant name="PARAM_SPOT_ATTENUATION" value="6">
<constant name="PARAM_SPOT_ATTENUATION" value="6" enum="Param">
</constant>
<constant name="PARAM_CONTACT_SHADOW_SIZE" value="7">
<constant name="PARAM_CONTACT_SHADOW_SIZE" value="7" enum="Param">
</constant>
<constant name="PARAM_SHADOW_MAX_DISTANCE" value="8">
<constant name="PARAM_SHADOW_MAX_DISTANCE" value="8" enum="Param">
</constant>
<constant name="PARAM_SHADOW_SPLIT_1_OFFSET" value="9">
<constant name="PARAM_SHADOW_SPLIT_1_OFFSET" value="9" enum="Param">
</constant>
<constant name="PARAM_SHADOW_SPLIT_2_OFFSET" value="10">
<constant name="PARAM_SHADOW_SPLIT_2_OFFSET" value="10" enum="Param">
</constant>
<constant name="PARAM_SHADOW_SPLIT_3_OFFSET" value="11">
<constant name="PARAM_SHADOW_SPLIT_3_OFFSET" value="11" enum="Param">
</constant>
<constant name="PARAM_SHADOW_NORMAL_BIAS" value="12">
<constant name="PARAM_SHADOW_NORMAL_BIAS" value="12" enum="Param">
</constant>
<constant name="PARAM_SHADOW_BIAS" value="13">
<constant name="PARAM_SHADOW_BIAS" value="13" enum="Param">
</constant>
<constant name="PARAM_SHADOW_BIAS_SPLIT_SCALE" value="14">
<constant name="PARAM_SHADOW_BIAS_SPLIT_SCALE" value="14" enum="Param">
</constant>
<constant name="PARAM_MAX" value="15">
<constant name="PARAM_MAX" value="15" enum="Param">
</constant>
</constants>
</class>

20
doc/classes/Light2D.xml
View file

@ -78,34 +78,34 @@
</member>
</members>
<constants>
<constant name="MODE_ADD" value="0">
<constant name="MODE_ADD" value="0" enum="Mode">
Adds the value of pixels corresponding to the Light2D to the values of pixels under it. This is the common behaviour of a light.
</constant>
<constant name="MODE_SUB" value="1">
<constant name="MODE_SUB" value="1" enum="Mode">
Subtracts the value of pixels corresponding to the Light2D to the values of pixels under it, resulting in inversed light effect.
</constant>
<constant name="MODE_MIX" value="2">
<constant name="MODE_MIX" value="2" enum="Mode">
Mix the value of pixels corresponding to the Light2D to the values of pixels under it by linear interpolation.
</constant>
<constant name="MODE_MASK" value="3">
<constant name="MODE_MASK" value="3" enum="Mode">
The light texture of the Light2D is used as a mask, hiding or revealing parts of the screen underneath depending on the value of each pixel of the light (mask) texture.
</constant>
<constant name="SHADOW_FILTER_NONE" value="0">
<constant name="SHADOW_FILTER_NONE" value="0" enum="ShadowFilter">
No filter applies to the shadow map. See [method shadow_filter].
</constant>
<constant name="SHADOW_FILTER_PCF3" value="1">
<constant name="SHADOW_FILTER_PCF3" value="1" enum="ShadowFilter">
Percentage closer filtering (3 samples) applies to the shadow map. See [method shadow_filter].
</constant>
<constant name="SHADOW_FILTER_PCF5" value="2">
<constant name="SHADOW_FILTER_PCF5" value="2" enum="ShadowFilter">
Percentage closer filtering (5 samples) applies to the shadow map. See [method shadow_filter].
</constant>
<constant name="SHADOW_FILTER_PCF7" value="3">
<constant name="SHADOW_FILTER_PCF7" value="3" enum="ShadowFilter">
Percentage closer filtering (7 samples) applies to the shadow map. See [method shadow_filter].
</constant>
<constant name="SHADOW_FILTER_PCF9" value="4">
<constant name="SHADOW_FILTER_PCF9" value="4" enum="ShadowFilter">
Percentage closer filtering (9 samples) applies to the shadow map. See [method shadow_filter].
</constant>
<constant name="SHADOW_FILTER_PCF13" value="5">
<constant name="SHADOW_FILTER_PCF13" value="5" enum="ShadowFilter">
Percentage closer filtering (13 samples) applies to the shadow map. See [method shadow_filter].
</constant>
</constants>

16
doc/classes/Line2D.xml
View file

@ -93,28 +93,28 @@
</member>
</members>
<constants>
<constant name="LINE_JOINT_SHARP" value="0">
<constant name="LINE_JOINT_SHARP" value="0" enum="LineJointMode">
The line's joints will be pointy. If [code]sharp_limit[/code] is greater than the rotation of a joint, it becomes a bevel joint instead.
</constant>
<constant name="LINE_JOINT_BEVEL" value="1">
<constant name="LINE_JOINT_BEVEL" value="1" enum="LineJointMode">
The line's joints will be bevelled/chamfered.
</constant>
<constant name="LINE_JOINT_ROUND" value="2">
<constant name="LINE_JOINT_ROUND" value="2" enum="LineJointMode">
The line's joints will be rounded.
</constant>
<constant name="LINE_CAP_NONE" value="0">
<constant name="LINE_CAP_NONE" value="0" enum="LineCapMode">
Don't have a line cap.
</constant>
<constant name="LINE_CAP_BOX" value="1">
<constant name="LINE_CAP_BOX" value="1" enum="LineCapMode">
Draws the line cap as a box.
</constant>
<constant name="LINE_CAP_ROUND" value="2">
<constant name="LINE_CAP_ROUND" value="2" enum="LineCapMode">
Draws the line cap as a circle.
</constant>
<constant name="LINE_TEXTURE_NONE" value="0">
<constant name="LINE_TEXTURE_NONE" value="0" enum="LineTextureMode">
Takes the left pixels of the texture and renders it over the whole line.
</constant>
<constant name="LINE_TEXTURE_TILE" value="1">
<constant name="LINE_TEXTURE_TILE" value="1" enum="LineTextureMode">
Tiles the texture over the line. The texture need to be imported with Repeat Enabled for it to work properly.
</constant>
</constants>

24
doc/classes/LineEdit.xml
View file

@ -139,39 +139,39 @@
</signal>
</signals>
<constants>
<constant name="ALIGN_LEFT" value="0">
<constant name="ALIGN_LEFT" value="0" enum="Align">
Aligns the text on the left hand side of the [LineEdit].
</constant>
<constant name="ALIGN_CENTER" value="1">
<constant name="ALIGN_CENTER" value="1" enum="Align">
Centers the text in the middle of the [LineEdit].
</constant>
<constant name="ALIGN_RIGHT" value="2">
<constant name="ALIGN_RIGHT" value="2" enum="Align">
Aligns the text on the right hand side of the [LineEdit].
</constant>
<constant name="ALIGN_FILL" value="3">
<constant name="ALIGN_FILL" value="3" enum="Align">
Stretches whitespaces to fit the [LineEdit]'s width.
</constant>
<constant name="MENU_CUT" value="0">
<constant name="MENU_CUT" value="0" enum="MenuItems">
Cuts (Copies and clears) the selected text.
</constant>
<constant name="MENU_COPY" value="1">
<constant name="MENU_COPY" value="1" enum="MenuItems">
Copies the selected text.
</constant>
<constant name="MENU_PASTE" value="2">
<constant name="MENU_PASTE" value="2" enum="MenuItems">
Pastes the clipboard text over the selected text (or at the cursor's position).
</constant>
<constant name="MENU_CLEAR" value="3">
<constant name="MENU_CLEAR" value="3" enum="MenuItems">
Erases the whole [Linedit] text.
</constant>
<constant name="MENU_SELECT_ALL" value="4">
<constant name="MENU_SELECT_ALL" value="4" enum="MenuItems">
Selects the whole [Linedit] text.
</constant>
<constant name="MENU_UNDO" value="5">
<constant name="MENU_UNDO" value="5" enum="MenuItems">
Undoes the previous action.
</constant>
<constant name="MENU_REDO" value="6">
<constant name="MENU_REDO" value="6" enum="MenuItems">
</constant>
<constant name="MENU_MAX" value="7">
<constant name="MENU_MAX" value="7" enum="MenuItems">
</constant>
</constants>
<theme_items>

6
doc/classes/LinkButton.xml
View file

@ -19,13 +19,13 @@
</member>
</members>
<constants>
<constant name="UNDERLINE_MODE_ALWAYS" value="0">
<constant name="UNDERLINE_MODE_ALWAYS" value="0" enum="UnderlineMode">
The LinkButton will always show an underline at the bottom of its text
</constant>
<constant name="UNDERLINE_MODE_ON_HOVER" value="1">
<constant name="UNDERLINE_MODE_ON_HOVER" value="1" enum="UnderlineMode">
The LinkButton will show an underline at the bottom of its text when the mouse cursor is over it.
</constant>
<constant name="UNDERLINE_MODE_NEVER" value="2">
<constant name="UNDERLINE_MODE_NEVER" value="2" enum="UnderlineMode">
The LinkButton will never show an underline at the bottom of its text.
</constant>
</constants>

20
doc/classes/MainLoop.xml
View file

@ -114,25 +114,25 @@
</method>
</methods>
<constants>
<constant name="NOTIFICATION_WM_MOUSE_ENTER" value="2" enum="">
<constant name="NOTIFICATION_WM_MOUSE_ENTER" value="2">
</constant>
<constant name="NOTIFICATION_WM_MOUSE_EXIT" value="3" enum="">
<constant name="NOTIFICATION_WM_MOUSE_EXIT" value="3">
</constant>
<constant name="NOTIFICATION_WM_FOCUS_IN" value="4" enum="">
<constant name="NOTIFICATION_WM_FOCUS_IN" value="4">
</constant>
<constant name="NOTIFICATION_WM_FOCUS_OUT" value="5" enum="">
<constant name="NOTIFICATION_WM_FOCUS_OUT" value="5">
</constant>
<constant name="NOTIFICATION_WM_QUIT_REQUEST" value="6" enum="">
<constant name="NOTIFICATION_WM_QUIT_REQUEST" value="6">
</constant>
<constant name="NOTIFICATION_WM_GO_BACK_REQUEST" value="7" enum="">
<constant name="NOTIFICATION_WM_GO_BACK_REQUEST" value="7">
</constant>
<constant name="NOTIFICATION_WM_UNFOCUS_REQUEST" value="8" enum="">
<constant name="NOTIFICATION_WM_UNFOCUS_REQUEST" value="8">
</constant>
<constant name="NOTIFICATION_OS_MEMORY_WARNING" value="9" enum="">
<constant name="NOTIFICATION_OS_MEMORY_WARNING" value="9">
</constant>
<constant name="NOTIFICATION_TRANSLATION_CHANGED" value="90" enum="">
<constant name="NOTIFICATION_TRANSLATION_CHANGED" value="90">
</constant>
<constant name="NOTIFICATION_WM_ABOUT" value="91" enum="">
<constant name="NOTIFICATION_WM_ABOUT" value="91">
</constant>
</constants>
</class>

4
doc/classes/Material.xml
View file

@ -19,9 +19,9 @@
</member>
</members>
<constants>
<constant name="RENDER_PRIORITY_MAX" value="127" enum="">
<constant name="RENDER_PRIORITY_MAX" value="127">
</constant>
<constant name="RENDER_PRIORITY_MIN" value="-128" enum="">
<constant name="RENDER_PRIORITY_MIN" value="-128">
</constant>
</constants>
</class>

82
doc/classes/Mesh.xml
View file

@ -50,94 +50,94 @@
</method>
</methods>
<constants>
<constant name="PRIMITIVE_POINTS" value="0">
<constant name="PRIMITIVE_POINTS" value="0" enum="PrimitiveType">
Render array as points (one vertex equals one point).
</constant>
<constant name="PRIMITIVE_LINES" value="1">
<constant name="PRIMITIVE_LINES" value="1" enum="PrimitiveType">
Render array as lines (every two vertices a line is created).
</constant>
<constant name="PRIMITIVE_LINE_STRIP" value="2">
<constant name="PRIMITIVE_LINE_STRIP" value="2" enum="PrimitiveType">
Render array as line strip.
</constant>
<constant name="PRIMITIVE_LINE_LOOP" value="3">
<constant name="PRIMITIVE_LINE_LOOP" value="3" enum="PrimitiveType">
Render array as line loop (like line strip, but closed).
</constant>
<constant name="PRIMITIVE_TRIANGLES" value="4">
<constant name="PRIMITIVE_TRIANGLES" value="4" enum="PrimitiveType">
Render array as triangles (every three vertices a triangle is created).
</constant>
<constant name="PRIMITIVE_TRIANGLE_STRIP" value="5">
<constant name="PRIMITIVE_TRIANGLE_STRIP" value="5" enum="PrimitiveType">
Render array as triangle strips.
</constant>
<constant name="PRIMITIVE_TRIANGLE_FAN" value="6">
<constant name="PRIMITIVE_TRIANGLE_FAN" value="6" enum="PrimitiveType">
Render array as triangle fans.
</constant>
<constant name="BLEND_SHAPE_MODE_NORMALIZED" value="0">
<constant name="BLEND_SHAPE_MODE_NORMALIZED" value="0" enum="BlendShapeMode">
</constant>
<constant name="BLEND_SHAPE_MODE_RELATIVE" value="1">
<constant name="BLEND_SHAPE_MODE_RELATIVE" value="1" enum="BlendShapeMode">
</constant>
<constant name="ARRAY_FORMAT_VERTEX" value="1">
<constant name="ARRAY_FORMAT_VERTEX" value="1" enum="ArrayFormat">
</constant>
<constant name="ARRAY_FORMAT_NORMAL" value="2">
<constant name="ARRAY_FORMAT_NORMAL" value="2" enum="ArrayFormat">
</constant>
<constant name="ARRAY_FORMAT_TANGENT" value="4">
<constant name="ARRAY_FORMAT_TANGENT" value="4" enum="ArrayFormat">
</constant>
<constant name="ARRAY_FORMAT_COLOR" value="8">
<constant name="ARRAY_FORMAT_COLOR" value="8" enum="ArrayFormat">
</constant>
<constant name="ARRAY_FORMAT_TEX_UV" value="16">
<constant name="ARRAY_FORMAT_TEX_UV" value="16" enum="ArrayFormat">
</constant>
<constant name="ARRAY_FORMAT_TEX_UV2" value="32">
<constant name="ARRAY_FORMAT_TEX_UV2" value="32" enum="ArrayFormat">
</constant>
<constant name="ARRAY_FORMAT_BONES" value="64">
<constant name="ARRAY_FORMAT_BONES" value="64" enum="ArrayFormat">
</constant>
<constant name="ARRAY_FORMAT_WEIGHTS" value="128">
<constant name="ARRAY_FORMAT_WEIGHTS" value="128" enum="ArrayFormat">
</constant>
<constant name="ARRAY_FORMAT_INDEX" value="256">
<constant name="ARRAY_FORMAT_INDEX" value="256" enum="ArrayFormat">
</constant>
<constant name="ARRAY_COMPRESS_BASE" value="9">
<constant name="ARRAY_COMPRESS_BASE" value="9" enum="ArrayFormat">
</constant>
<constant name="ARRAY_COMPRESS_VERTEX" value="512">
<constant name="ARRAY_COMPRESS_VERTEX" value="512" enum="ArrayFormat">
</constant>
<constant name="ARRAY_COMPRESS_NORMAL" value="1024">
<constant name="ARRAY_COMPRESS_NORMAL" value="1024" enum="ArrayFormat">
</constant>
<constant name="ARRAY_COMPRESS_TANGENT" value="2048">
<constant name="ARRAY_COMPRESS_TANGENT" value="2048" enum="ArrayFormat">
</constant>
<constant name="ARRAY_COMPRESS_COLOR" value="4096">
<constant name="ARRAY_COMPRESS_COLOR" value="4096" enum="ArrayFormat">
</constant>
<constant name="ARRAY_COMPRESS_TEX_UV" value="8192">
<constant name="ARRAY_COMPRESS_TEX_UV" value="8192" enum="ArrayFormat">
</constant>
<constant name="ARRAY_COMPRESS_TEX_UV2" value="16384">
<constant name="ARRAY_COMPRESS_TEX_UV2" value="16384" enum="ArrayFormat">
</constant>
<constant name="ARRAY_COMPRESS_BONES" value="32768">
<constant name="ARRAY_COMPRESS_BONES" value="32768" enum="ArrayFormat">
</constant>
<constant name="ARRAY_COMPRESS_WEIGHTS" value="65536">
<constant name="ARRAY_COMPRESS_WEIGHTS" value="65536" enum="ArrayFormat">
</constant>
<constant name="ARRAY_COMPRESS_INDEX" value="131072">
<constant name="ARRAY_COMPRESS_INDEX" value="131072" enum="ArrayFormat">
</constant>
<constant name="ARRAY_FLAG_USE_2D_VERTICES" value="262144">
<constant name="ARRAY_FLAG_USE_2D_VERTICES" value="262144" enum="ArrayFormat">
</constant>
<constant name="ARRAY_FLAG_USE_16_BIT_BONES" value="524288">
<constant name="ARRAY_FLAG_USE_16_BIT_BONES" value="524288" enum="ArrayFormat">
</constant>
<constant name="ARRAY_COMPRESS_DEFAULT" value="97792">
<constant name="ARRAY_COMPRESS_DEFAULT" value="97792" enum="ArrayFormat">
</constant>
<constant name="ARRAY_VERTEX" value="0">
<constant name="ARRAY_VERTEX" value="0" enum="ArrayType">
</constant>
<constant name="ARRAY_NORMAL" value="1">
<constant name="ARRAY_NORMAL" value="1" enum="ArrayType">
</constant>
<constant name="ARRAY_TANGENT" value="2">
<constant name="ARRAY_TANGENT" value="2" enum="ArrayType">
</constant>
<constant name="ARRAY_COLOR" value="3">
<constant name="ARRAY_COLOR" value="3" enum="ArrayType">
</constant>
<constant name="ARRAY_TEX_UV" value="4">
<constant name="ARRAY_TEX_UV" value="4" enum="ArrayType">
</constant>
<constant name="ARRAY_TEX_UV2" value="5">
<constant name="ARRAY_TEX_UV2" value="5" enum="ArrayType">
</constant>
<constant name="ARRAY_BONES" value="6">
<constant name="ARRAY_BONES" value="6" enum="ArrayType">
</constant>
<constant name="ARRAY_WEIGHTS" value="7">
<constant name="ARRAY_WEIGHTS" value="7" enum="ArrayType">
</constant>
<constant name="ARRAY_INDEX" value="8">
<constant name="ARRAY_INDEX" value="8" enum="ArrayType">
</constant>
<constant name="ARRAY_MAX" value="9">
<constant name="ARRAY_MAX" value="9" enum="ArrayType">
</constant>
</constants>
</class>

10
doc/classes/MultiMesh.xml
View file

@ -77,15 +77,15 @@
</member>
</members>
<constants>
<constant name="TRANSFORM_2D" value="0">
<constant name="TRANSFORM_2D" value="0" enum="TransformFormat">
</constant>
<constant name="TRANSFORM_3D" value="1">
<constant name="TRANSFORM_3D" value="1" enum="TransformFormat">
</constant>
<constant name="COLOR_NONE" value="0">
<constant name="COLOR_NONE" value="0" enum="ColorFormat">
</constant>
<constant name="COLOR_8BIT" value="1">
<constant name="COLOR_8BIT" value="1" enum="ColorFormat">
</constant>
<constant name="COLOR_FLOAT" value="2">
<constant name="COLOR_FLOAT" value="2" enum="ColorFormat">
</constant>
</constants>
</class>

6
doc/classes/NavigationMesh.xml
View file

@ -87,11 +87,11 @@
</member>
</members>
<constants>
<constant name="SAMPLE_PARTITION_WATERSHED" value="0" enum="">
<constant name="SAMPLE_PARTITION_WATERSHED" value="0">
</constant>
<constant name="SAMPLE_PARTITION_MONOTONE" value="1" enum="">
<constant name="SAMPLE_PARTITION_MONOTONE" value="1">
</constant>
<constant name="SAMPLE_PARTITION_LAYERS" value="2" enum="">
<constant name="SAMPLE_PARTITION_LAYERS" value="2">
</constant>
</constants>
</class>

16
doc/classes/NetworkedMultiplayerPeer.xml
View file

@ -98,21 +98,21 @@
</signal>
</signals>
<constants>
<constant name="TRANSFER_MODE_UNRELIABLE" value="0">
<constant name="TRANSFER_MODE_UNRELIABLE" value="0" enum="TransferMode">
</constant>
<constant name="TRANSFER_MODE_UNRELIABLE_ORDERED" value="1">
<constant name="TRANSFER_MODE_UNRELIABLE_ORDERED" value="1" enum="TransferMode">
</constant>
<constant name="TRANSFER_MODE_RELIABLE" value="2">
<constant name="TRANSFER_MODE_RELIABLE" value="2" enum="TransferMode">
</constant>
<constant name="CONNECTION_DISCONNECTED" value="0">
<constant name="CONNECTION_DISCONNECTED" value="0" enum="ConnectionStatus">
</constant>
<constant name="CONNECTION_CONNECTING" value="1">
<constant name="CONNECTION_CONNECTING" value="1" enum="ConnectionStatus">
</constant>
<constant name="CONNECTION_CONNECTED" value="2">
<constant name="CONNECTION_CONNECTED" value="2" enum="ConnectionStatus">
</constant>
<constant name="TARGET_PEER_BROADCAST" value="0" enum="">
<constant name="TARGET_PEER_BROADCAST" value="0">
</constant>
<constant name="TARGET_PEER_SERVER" value="1" enum="">
<constant name="TARGET_PEER_SERVER" value="1">
</constant>
</constants>
</class>

6
doc/classes/NinePatchRect.xml
View file

@ -49,13 +49,13 @@
</signal>
</signals>
<constants>
<constant name="AXIS_STRETCH_MODE_STRETCH" value="0">
<constant name="AXIS_STRETCH_MODE_STRETCH" value="0" enum="AxisStretchMode">
Doesn't do anything at the time of writing. Default value for [code]axis_stretch_horizontal[/code] and [code]axis_stretch_vertical[/code].
</constant>
<constant name="AXIS_STRETCH_MODE_TILE" value="1">
<constant name="AXIS_STRETCH_MODE_TILE" value="1" enum="AxisStretchMode">
Doesn't do anything at the time of writing.
</constant>
<constant name="AXIS_STRETCH_MODE_TILE_FIT" value="2">
<constant name="AXIS_STRETCH_MODE_TILE_FIT" value="2" enum="AxisStretchMode">
Doesn't do anything at the time of writing.
</constant>
</constants>

58
doc/classes/Node.xml
View file

@ -768,74 +768,74 @@
</signal>
</signals>
<constants>
<constant name="NOTIFICATION_ENTER_TREE" value="10" enum="">
<constant name="NOTIFICATION_ENTER_TREE" value="10">
</constant>
<constant name="NOTIFICATION_EXIT_TREE" value="11" enum="">
<constant name="NOTIFICATION_EXIT_TREE" value="11">
</constant>
<constant name="NOTIFICATION_MOVED_IN_PARENT" value="12" enum="">
<constant name="NOTIFICATION_MOVED_IN_PARENT" value="12">
</constant>
<constant name="NOTIFICATION_READY" value="13" enum="">
<constant name="NOTIFICATION_READY" value="13">
</constant>
<constant name="NOTIFICATION_PAUSED" value="14" enum="">
<constant name="NOTIFICATION_PAUSED" value="14">
</constant>
<constant name="NOTIFICATION_UNPAUSED" value="15" enum="">
<constant name="NOTIFICATION_UNPAUSED" value="15">
</constant>
<constant name="NOTIFICATION_PHYSICS_PROCESS" value="16" enum="">
<constant name="NOTIFICATION_PHYSICS_PROCESS" value="16">
Notification received every frame when the physics process flag is set (see [method set_physics_process]).
</constant>
<constant name="NOTIFICATION_PROCESS" value="17" enum="">
<constant name="NOTIFICATION_PROCESS" value="17">
Notification received every frame when the process flag is set (see [method set_process]).
</constant>
<constant name="NOTIFICATION_PARENTED" value="18" enum="">
<constant name="NOTIFICATION_PARENTED" value="18">
Notification received when a node is set as a child of another node. Note that this doesn't mean that a node entered the Scene Tree.
</constant>
<constant name="NOTIFICATION_UNPARENTED" value="19" enum="">
<constant name="NOTIFICATION_UNPARENTED" value="19">
Notification received when a node is unparented (parent removed it from the list of children).
</constant>
<constant name="NOTIFICATION_INSTANCED" value="20" enum="">
<constant name="NOTIFICATION_INSTANCED" value="20">
</constant>
<constant name="NOTIFICATION_DRAG_BEGIN" value="21" enum="">
<constant name="NOTIFICATION_DRAG_BEGIN" value="21">
</constant>
<constant name="NOTIFICATION_DRAG_END" value="22" enum="">
<constant name="NOTIFICATION_DRAG_END" value="22">
</constant>
<constant name="NOTIFICATION_PATH_CHANGED" value="23" enum="">
<constant name="NOTIFICATION_PATH_CHANGED" value="23">
</constant>
<constant name="NOTIFICATION_TRANSLATION_CHANGED" value="24" enum="">
<constant name="NOTIFICATION_TRANSLATION_CHANGED" value="24">
</constant>
<constant name="NOTIFICATION_INTERNAL_PROCESS" value="25" enum="">
<constant name="NOTIFICATION_INTERNAL_PROCESS" value="25">
</constant>
<constant name="NOTIFICATION_INTERNAL_PHYSICS_PROCESS" value="26" enum="">
<constant name="NOTIFICATION_INTERNAL_PHYSICS_PROCESS" value="26">
</constant>
<constant name="RPC_MODE_DISABLED" value="0">
<constant name="RPC_MODE_DISABLED" value="0" enum="RPCMode">
</constant>
<constant name="RPC_MODE_REMOTE" value="1">
<constant name="RPC_MODE_REMOTE" value="1" enum="RPCMode">
Call a method remotely.
</constant>
<constant name="RPC_MODE_SYNC" value="2">
<constant name="RPC_MODE_SYNC" value="2" enum="RPCMode">
Call a method both remotely and locally.
</constant>
<constant name="RPC_MODE_MASTER" value="3">
<constant name="RPC_MODE_MASTER" value="3" enum="RPCMode">
Call a method if the Node is Master.
</constant>
<constant name="RPC_MODE_SLAVE" value="4">
<constant name="RPC_MODE_SLAVE" value="4" enum="RPCMode">
Call a method if the Node is Slave.
</constant>
<constant name="PAUSE_MODE_INHERIT" value="0">
<constant name="PAUSE_MODE_INHERIT" value="0" enum="PauseMode">
Inherits pause mode from parent. For root node, it is equivalent to PAUSE_MODE_STOP.
</constant>
<constant name="PAUSE_MODE_STOP" value="1">
<constant name="PAUSE_MODE_STOP" value="1" enum="PauseMode">
Stop processing when SceneTree is paused.
</constant>
<constant name="PAUSE_MODE_PROCESS" value="2">
<constant name="PAUSE_MODE_PROCESS" value="2" enum="PauseMode">
Continue to process regardless of SceneTree pause state.
</constant>
<constant name="DUPLICATE_SIGNALS" value="1">
<constant name="DUPLICATE_SIGNALS" value="1" enum="DuplicateFlags">
</constant>
<constant name="DUPLICATE_GROUPS" value="2">
<constant name="DUPLICATE_GROUPS" value="2" enum="DuplicateFlags">
</constant>
<constant name="DUPLICATE_SCRIPTS" value="4">
<constant name="DUPLICATE_SCRIPTS" value="4" enum="DuplicateFlags">
</constant>
<constant name="DUPLICATE_USE_INSTANCING" value="8">
<constant name="DUPLICATE_USE_INSTANCING" value="8" enum="DuplicateFlags">
</constant>
</constants>
</class>

78
doc/classes/OS.xml
View file

@ -828,83 +828,83 @@
</method>
</methods>
<constants>
<constant name="DAY_SUNDAY" value="0">
<constant name="DAY_SUNDAY" value="0" enum="Weekday">
</constant>
<constant name="DAY_MONDAY" value="1">
<constant name="DAY_MONDAY" value="1" enum="Weekday">
</constant>
<constant name="DAY_TUESDAY" value="2">
<constant name="DAY_TUESDAY" value="2" enum="Weekday">
</constant>
<constant name="DAY_WEDNESDAY" value="3">
<constant name="DAY_WEDNESDAY" value="3" enum="Weekday">
</constant>
<constant name="DAY_THURSDAY" value="4">
<constant name="DAY_THURSDAY" value="4" enum="Weekday">
</constant>
<constant name="DAY_FRIDAY" value="5">
<constant name="DAY_FRIDAY" value="5" enum="Weekday">
</constant>
<constant name="DAY_SATURDAY" value="6">
<constant name="DAY_SATURDAY" value="6" enum="Weekday">
</constant>
<constant name="MONTH_JANUARY" value="1">
<constant name="MONTH_JANUARY" value="1" enum="Month">
</constant>
<constant name="MONTH_FEBRUARY" value="2">
<constant name="MONTH_FEBRUARY" value="2" enum="Month">
</constant>
<constant name="MONTH_MARCH" value="3">
<constant name="MONTH_MARCH" value="3" enum="Month">
</constant>
<constant name="MONTH_APRIL" value="4">
<constant name="MONTH_APRIL" value="4" enum="Month">
</constant>
<constant name="MONTH_MAY" value="5">
<constant name="MONTH_MAY" value="5" enum="Month">
</constant>
<constant name="MONTH_JUNE" value="6">
<constant name="MONTH_JUNE" value="6" enum="Month">
</constant>
<constant name="MONTH_JULY" value="7">
<constant name="MONTH_JULY" value="7" enum="Month">
</constant>
<constant name="MONTH_AUGUST" value="8">
<constant name="MONTH_AUGUST" value="8" enum="Month">
</constant>
<constant name="MONTH_SEPTEMBER" value="9">
<constant name="MONTH_SEPTEMBER" value="9" enum="Month">
</constant>
<constant name="MONTH_OCTOBER" value="10">
<constant name="MONTH_OCTOBER" value="10" enum="Month">
</constant>
<constant name="MONTH_NOVEMBER" value="11">
<constant name="MONTH_NOVEMBER" value="11" enum="Month">
</constant>
<constant name="MONTH_DECEMBER" value="12">
<constant name="MONTH_DECEMBER" value="12" enum="Month">
</constant>
<constant name="SCREEN_ORIENTATION_LANDSCAPE" value="0">
<constant name="SCREEN_ORIENTATION_LANDSCAPE" value="0" enum="ScreenOrientation">
</constant>
<constant name="SCREEN_ORIENTATION_PORTRAIT" value="1">
<constant name="SCREEN_ORIENTATION_PORTRAIT" value="1" enum="ScreenOrientation">
</constant>
<constant name="SCREEN_ORIENTATION_REVERSE_LANDSCAPE" value="2">
<constant name="SCREEN_ORIENTATION_REVERSE_LANDSCAPE" value="2" enum="ScreenOrientation">
</constant>
<constant name="SCREEN_ORIENTATION_REVERSE_PORTRAIT" value="3">
<constant name="SCREEN_ORIENTATION_REVERSE_PORTRAIT" value="3" enum="ScreenOrientation">
</constant>
<constant name="SCREEN_ORIENTATION_SENSOR_LANDSCAPE" value="4">
<constant name="SCREEN_ORIENTATION_SENSOR_LANDSCAPE" value="4" enum="ScreenOrientation">
</constant>
<constant name="SCREEN_ORIENTATION_SENSOR_PORTRAIT" value="5">
<constant name="SCREEN_ORIENTATION_SENSOR_PORTRAIT" value="5" enum="ScreenOrientation">
</constant>
<constant name="SCREEN_ORIENTATION_SENSOR" value="6">
<constant name="SCREEN_ORIENTATION_SENSOR" value="6" enum="ScreenOrientation">
</constant>
<constant name="SYSTEM_DIR_DESKTOP" value="0">
<constant name="SYSTEM_DIR_DESKTOP" value="0" enum="SystemDir">
</constant>
<constant name="SYSTEM_DIR_DCIM" value="1">
<constant name="SYSTEM_DIR_DCIM" value="1" enum="SystemDir">
</constant>
<constant name="SYSTEM_DIR_DOCUMENTS" value="2">
<constant name="SYSTEM_DIR_DOCUMENTS" value="2" enum="SystemDir">
</constant>
<constant name="SYSTEM_DIR_DOWNLOADS" value="3">
<constant name="SYSTEM_DIR_DOWNLOADS" value="3" enum="SystemDir">
</constant>
<constant name="SYSTEM_DIR_MOVIES" value="4">
<constant name="SYSTEM_DIR_MOVIES" value="4" enum="SystemDir">
</constant>
<constant name="SYSTEM_DIR_MUSIC" value="5">
<constant name="SYSTEM_DIR_MUSIC" value="5" enum="SystemDir">
</constant>
<constant name="SYSTEM_DIR_PICTURES" value="6">
<constant name="SYSTEM_DIR_PICTURES" value="6" enum="SystemDir">
</constant>
<constant name="SYSTEM_DIR_RINGTONES" value="7">
<constant name="SYSTEM_DIR_RINGTONES" value="7" enum="SystemDir">
</constant>
<constant name="POWERSTATE_UNKNOWN" value="0">
<constant name="POWERSTATE_UNKNOWN" value="0" enum="PowerState">
</constant>
<constant name="POWERSTATE_ON_BATTERY" value="1">
<constant name="POWERSTATE_ON_BATTERY" value="1" enum="PowerState">
</constant>
<constant name="POWERSTATE_NO_BATTERY" value="2">
<constant name="POWERSTATE_NO_BATTERY" value="2" enum="PowerState">
</constant>
<constant name="POWERSTATE_CHARGING" value="3">
<constant name="POWERSTATE_CHARGING" value="3" enum="PowerState">
</constant>
<constant name="POWERSTATE_CHARGED" value="4">
<constant name="POWERSTATE_CHARGED" value="4" enum="PowerState">
</constant>
</constants>
</class>

10
doc/classes/Object.xml
View file

@ -402,19 +402,19 @@
</signal>
</signals>
<constants>
<constant name="NOTIFICATION_POSTINITIALIZE" value="0" enum="">
<constant name="NOTIFICATION_POSTINITIALIZE" value="0">
Called right when the object is initialized. Not available in script.
</constant>
<constant name="NOTIFICATION_PREDELETE" value="1" enum="">
<constant name="NOTIFICATION_PREDELETE" value="1">
Called before the object is about to be deleted.
</constant>
<constant name="CONNECT_DEFERRED" value="1">
<constant name="CONNECT_DEFERRED" value="1" enum="ConnectFlags">
Connect a signal in deferred mode. This way, signal emissions are stored in a queue, then set on idle time.
</constant>
<constant name="CONNECT_PERSIST" value="2">
<constant name="CONNECT_PERSIST" value="2" enum="ConnectFlags">
Persisting connections are saved when the object is serialized to file.
</constant>
<constant name="CONNECT_ONESHOT" value="4">
<constant name="CONNECT_ONESHOT" value="4" enum="ConnectFlags">
One shot connections disconnect themselves after emission.
</constant>
</constants>

6
doc/classes/OccluderPolygon2D.xml
View file

@ -24,13 +24,13 @@
</member>
</members>
<constants>
<constant name="CULL_DISABLED" value="0">
<constant name="CULL_DISABLED" value="0" enum="CullMode">
Culling mode for the occlusion. Disabled means no culling. See [member cull_mode].
</constant>
<constant name="CULL_CLOCKWISE" value="1">
<constant name="CULL_CLOCKWISE" value="1" enum="CullMode">
Culling mode for the occlusion. Sets the culling to be in clockwise direction. See [member cull_mode].
</constant>
<constant name="CULL_COUNTER_CLOCKWISE" value="2">
<constant name="CULL_COUNTER_CLOCKWISE" value="2" enum="CullMode">
Culling mode for the occlusion. Sets the culling to be in counter clockwise direction. See [member cull_mode].
</constant>
</constants>

8
doc/classes/OmniLight.xml
View file

@ -23,13 +23,13 @@
</member>
</members>
<constants>
<constant name="SHADOW_DUAL_PARABOLOID" value="0">
<constant name="SHADOW_DUAL_PARABOLOID" value="0" enum="ShadowMode">
</constant>
<constant name="SHADOW_CUBE" value="1">
<constant name="SHADOW_CUBE" value="1" enum="ShadowMode">
</constant>
<constant name="SHADOW_DETAIL_VERTICAL" value="0">
<constant name="SHADOW_DETAIL_VERTICAL" value="0" enum="ShadowDetail">
</constant>
<constant name="SHADOW_DETAIL_HORIZONTAL" value="1">
<constant name="SHADOW_DETAIL_HORIZONTAL" value="1" enum="ShadowDetail">
</constant>
</constants>
</class>

6
doc/classes/PackedScene.xml
View file

@ -45,11 +45,11 @@
</member>
</members>
<constants>
<constant name="GEN_EDIT_STATE_DISABLED" value="0">
<constant name="GEN_EDIT_STATE_DISABLED" value="0" enum="GenEditState">
</constant>
<constant name="GEN_EDIT_STATE_INSTANCE" value="1">
<constant name="GEN_EDIT_STATE_INSTANCE" value="1" enum="GenEditState">
</constant>
<constant name="GEN_EDIT_STATE_MAIN" value="2">
<constant name="GEN_EDIT_STATE_MAIN" value="2" enum="GenEditState">
</constant>
</constants>
</class>

8
doc/classes/Particles.xml
View file

@ -76,16 +76,16 @@
</member>
</members>
<constants>
<constant name="DRAW_ORDER_INDEX" value="0">
<constant name="DRAW_ORDER_INDEX" value="0" enum="DrawOrder">
Particles are drawn in the order emitted.
</constant>
<constant name="DRAW_ORDER_LIFETIME" value="1">
<constant name="DRAW_ORDER_LIFETIME" value="1" enum="DrawOrder">
Particles are drawn in order of remaining lifetime.
</constant>
<constant name="DRAW_ORDER_VIEW_DEPTH" value="2">
<constant name="DRAW_ORDER_VIEW_DEPTH" value="2" enum="DrawOrder">
Particles are drawn in order of depth.
</constant>
<constant name="MAX_DRAW_PASSES" value="4" enum="">
<constant name="MAX_DRAW_PASSES" value="4">
</constant>
</constants>
</class>

4
doc/classes/Particles2D.xml
View file

@ -79,10 +79,10 @@
</member>
</members>
<constants>
<constant name="DRAW_ORDER_INDEX" value="0">
<constant name="DRAW_ORDER_INDEX" value="0" enum="DrawOrder">
Particles are drawn in the order emitted.
</constant>
<constant name="DRAW_ORDER_LIFETIME" value="1">
<constant name="DRAW_ORDER_LIFETIME" value="1" enum="DrawOrder">
Particles are drawn in order of remaining lifetime.
</constant>
</constants>

42
doc/classes/ParticlesMaterial.xml
View file

@ -172,64 +172,64 @@
</member>
</members>
<constants>
<constant name="PARAM_INITIAL_LINEAR_VELOCITY" value="0">
<constant name="PARAM_INITIAL_LINEAR_VELOCITY" value="0" enum="Parameter">
Use with [method set_param], [method set_param_randomness], and [method set_param_texture] to set initial velocity properties.
</constant>
<constant name="PARAM_ANGULAR_VELOCITY" value="1">
<constant name="PARAM_ANGULAR_VELOCITY" value="1" enum="Parameter">
Use with [method set_param], [method set_param_randomness], and [method set_param_texture] to set angular velocity properties.
</constant>
<constant name="PARAM_ORBIT_VELOCITY" value="2">
<constant name="PARAM_ORBIT_VELOCITY" value="2" enum="Parameter">
Use with [method set_param], [method set_param_randomness], and [method set_param_texture] to set orbital_velocity properties.
</constant>
<constant name="PARAM_LINEAR_ACCEL" value="3">
<constant name="PARAM_LINEAR_ACCEL" value="3" enum="Parameter">
Use with [method set_param], [method set_param_randomness], and [method set_param_texture] to set linear acceleration properties.
</constant>
<constant name="PARAM_RADIAL_ACCEL" value="4">
<constant name="PARAM_RADIAL_ACCEL" value="4" enum="Parameter">
Use with [method set_param], [method set_param_randomness], and [method set_param_texture] to set radial acceleration properties.
</constant>
<constant name="PARAM_TANGENTIAL_ACCEL" value="5">
<constant name="PARAM_TANGENTIAL_ACCEL" value="5" enum="Parameter">
Use with [method set_param], [method set_param_randomness], and [method set_param_texture] to set tangential acceleration properties.
</constant>
<constant name="PARAM_DAMPING" value="6">
<constant name="PARAM_DAMPING" value="6" enum="Parameter">
Use with [method set_param], [method set_param_randomness], and [method set_param_texture] to set damping properties.
</constant>
<constant name="PARAM_ANGLE" value="7">
<constant name="PARAM_ANGLE" value="7" enum="Parameter">
Use with [method set_param], [method set_param_randomness], and [method set_param_texture] to set angle properties.
</constant>
<constant name="PARAM_SCALE" value="8">
<constant name="PARAM_SCALE" value="8" enum="Parameter">
Use with [method set_param], [method set_param_randomness], and [method set_param_texture] to set scale properties.
</constant>
<constant name="PARAM_HUE_VARIATION" value="9">
<constant name="PARAM_HUE_VARIATION" value="9" enum="Parameter">
Use with [method set_param], [method set_param_randomness], and [method set_param_texture] to set hue_variation properties.
</constant>
<constant name="PARAM_ANIM_SPEED" value="10">
<constant name="PARAM_ANIM_SPEED" value="10" enum="Parameter">
Use with [method set_param], [method set_param_randomness], and [method set_param_texture] to set animation speed properties.
</constant>
<constant name="PARAM_ANIM_OFFSET" value="11">
<constant name="PARAM_ANIM_OFFSET" value="11" enum="Parameter">
Use with [method set_param], [method set_param_randomness], and [method set_param_texture] to set animation offset properties.
</constant>
<constant name="PARAM_MAX" value="12">
<constant name="PARAM_MAX" value="12" enum="Parameter">
</constant>
<constant name="FLAG_ALIGN_Y_TO_VELOCITY" value="0">
<constant name="FLAG_ALIGN_Y_TO_VELOCITY" value="0" enum="Flags">
Use with [method set_flag] to set [member flag_align_y].
</constant>
<constant name="FLAG_ROTATE_Y" value="1">
<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">
<constant name="FLAG_MAX" value="4" enum="Flags">
</constant>
<constant name="EMISSION_SHAPE_POINT" value="0">
<constant name="EMISSION_SHAPE_POINT" value="0" enum="EmissionShape">
All particles will be emitted from a single point.
</constant>
<constant name="EMISSION_SHAPE_SPHERE" value="1">
<constant name="EMISSION_SHAPE_SPHERE" value="1" enum="EmissionShape">
Particles will be emitted in the volume of a sphere.
</constant>
<constant name="EMISSION_SHAPE_BOX" value="2">
<constant name="EMISSION_SHAPE_BOX" value="2" enum="EmissionShape">
Particles will be emitted in the volume of a box.
</constant>
<constant name="EMISSION_SHAPE_POINTS" value="3">
<constant name="EMISSION_SHAPE_POINTS" value="3" enum="EmissionShape">
</constant>
<constant name="EMISSION_SHAPE_DIRECTED_POINTS" value="4">
<constant name="EMISSION_SHAPE_DIRECTED_POINTS" value="4" enum="EmissionShape">
</constant>
</constants>
</class>

8
doc/classes/PathFollow.xml
View file

@ -129,16 +129,16 @@
</method>
</methods>
<constants>
<constant name="ROTATION_NONE" value="0">
<constant name="ROTATION_NONE" value="0" enum="RotationMode">
Forbids the PathFollow to rotate.
</constant>
<constant name="ROTATION_Y" value="1">
<constant name="ROTATION_Y" value="1" enum="RotationMode">
Allows the PathFollow to rotate in the Y axis only.
</constant>
<constant name="ROTATION_XY" value="2">
<constant name="ROTATION_XY" value="2" enum="RotationMode">
Allows the PathFollow to rotate in both the X, and Y axes.
</constant>
<constant name="ROTATION_XYZ" value="3">
<constant name="ROTATION_XYZ" value="3" enum="RotationMode">
Allows the PathFollow to rotate in any axis.
</constant>
</constants>

56
doc/classes/Performance.xml
View file

@ -26,87 +26,87 @@
</method>
</methods>
<constants>
<constant name="TIME_FPS" value="0">
<constant name="TIME_FPS" value="0" enum="Monitor">
Frames per second.
</constant>
<constant name="TIME_PROCESS" value="1">
<constant name="TIME_PROCESS" value="1" enum="Monitor">
Time it took to complete one frame.
</constant>
<constant name="TIME_PHYSICS_PROCESS" value="2">
<constant name="TIME_PHYSICS_PROCESS" value="2" enum="Monitor">
Time it took to complete one physics frame.
</constant>
<constant name="MEMORY_STATIC" value="3">
<constant name="MEMORY_STATIC" value="3" enum="Monitor">
Static memory currently used, in bytes. Not available in release builds.
</constant>
<constant name="MEMORY_DYNAMIC" value="4">
<constant name="MEMORY_DYNAMIC" value="4" enum="Monitor">
Dynamic memory currently used, in bytes. Not available in release builds.
</constant>
<constant name="MEMORY_STATIC_MAX" value="5">
<constant name="MEMORY_STATIC_MAX" value="5" enum="Monitor">
Available static memory. Not available in release builds.
</constant>
<constant name="MEMORY_DYNAMIC_MAX" value="6">
<constant name="MEMORY_DYNAMIC_MAX" value="6" enum="Monitor">
Available dynamic memory. Not available in release builds.
</constant>
<constant name="MEMORY_MESSAGE_BUFFER_MAX" value="7">
<constant name="MEMORY_MESSAGE_BUFFER_MAX" value="7" enum="Monitor">
Largest amount of memory the message queue buffer has used, in bytes. The message queue is used for deferred functions calls and notifications.
</constant>
<constant name="OBJECT_COUNT" value="8">
<constant name="OBJECT_COUNT" value="8" enum="Monitor">
Number of objects currently instanced (including nodes).
</constant>
<constant name="OBJECT_RESOURCE_COUNT" value="9">
<constant name="OBJECT_RESOURCE_COUNT" value="9" enum="Monitor">
Number of resources currently used.
</constant>
<constant name="OBJECT_NODE_COUNT" value="10">
<constant name="OBJECT_NODE_COUNT" value="10" enum="Monitor">
Number of nodes currently instanced. This also includes the root node, as well as any nodes not in the scene tree.
</constant>
<constant name="RENDER_OBJECTS_IN_FRAME" value="11">
<constant name="RENDER_OBJECTS_IN_FRAME" value="11" enum="Monitor">
3D objects drawn per frame.
</constant>
<constant name="RENDER_VERTICES_IN_FRAME" value="12">
<constant name="RENDER_VERTICES_IN_FRAME" value="12" enum="Monitor">
Vertices drawn per frame. 3D only.
</constant>
<constant name="RENDER_MATERIAL_CHANGES_IN_FRAME" value="13">
<constant name="RENDER_MATERIAL_CHANGES_IN_FRAME" value="13" enum="Monitor">
Material changes per frame. 3D only
</constant>
<constant name="RENDER_SHADER_CHANGES_IN_FRAME" value="14">
<constant name="RENDER_SHADER_CHANGES_IN_FRAME" value="14" enum="Monitor">
Shader changes per frame. 3D only.
</constant>
<constant name="RENDER_SURFACE_CHANGES_IN_FRAME" value="15">
<constant name="RENDER_SURFACE_CHANGES_IN_FRAME" value="15" enum="Monitor">
Render surface changes per frame. 3D only.
</constant>
<constant name="RENDER_DRAW_CALLS_IN_FRAME" value="16">
<constant name="RENDER_DRAW_CALLS_IN_FRAME" value="16" enum="Monitor">
Draw calls per frame. 3D only.
</constant>
<constant name="RENDER_VIDEO_MEM_USED" value="17">
<constant name="RENDER_VIDEO_MEM_USED" value="17" enum="Monitor">
Video memory used. Includes both texture and vertex memory.
</constant>
<constant name="RENDER_TEXTURE_MEM_USED" value="18">
<constant name="RENDER_TEXTURE_MEM_USED" value="18" enum="Monitor">
Texture memory used.
</constant>
<constant name="RENDER_VERTEX_MEM_USED" value="19">
<constant name="RENDER_VERTEX_MEM_USED" value="19" enum="Monitor">
Vertex memory used.
</constant>
<constant name="RENDER_USAGE_VIDEO_MEM_TOTAL" value="20">
<constant name="RENDER_USAGE_VIDEO_MEM_TOTAL" value="20" enum="Monitor">
</constant>
<constant name="PHYSICS_2D_ACTIVE_OBJECTS" value="21">
<constant name="PHYSICS_2D_ACTIVE_OBJECTS" value="21" enum="Monitor">
Number of active [RigidBody2D] nodes in the game.
</constant>
<constant name="PHYSICS_2D_COLLISION_PAIRS" value="22">
<constant name="PHYSICS_2D_COLLISION_PAIRS" value="22" enum="Monitor">
Number of collision pairs in the 2D physics engine.
</constant>
<constant name="PHYSICS_2D_ISLAND_COUNT" value="23">
<constant name="PHYSICS_2D_ISLAND_COUNT" value="23" enum="Monitor">
Number of islands in the 2D physics engine.
</constant>
<constant name="PHYSICS_3D_ACTIVE_OBJECTS" value="24">
<constant name="PHYSICS_3D_ACTIVE_OBJECTS" value="24" enum="Monitor">
Number of active [RigidBody] and [VehicleBody] nodes in the game.
</constant>
<constant name="PHYSICS_3D_COLLISION_PAIRS" value="25">
<constant name="PHYSICS_3D_COLLISION_PAIRS" value="25" enum="Monitor">
Number of collision pairs in the 3D physics engine.
</constant>
<constant name="PHYSICS_3D_ISLAND_COUNT" value="26">
<constant name="PHYSICS_3D_ISLAND_COUNT" value="26" enum="Monitor">
Number of islands in the 3D physics engine.
</constant>
<constant name="MONITOR_MAX" value="27">
<constant name="MONITOR_MAX" value="27" enum="Monitor">
</constant>
</constants>
</class>

120
doc/classes/Physics2DServer.xml
View file

@ -989,183 +989,183 @@
</method>
</methods>
<constants>
<constant name="SPACE_PARAM_CONTACT_RECYCLE_RADIUS" value="0">
<constant name="SPACE_PARAM_CONTACT_RECYCLE_RADIUS" value="0" enum="SpaceParameter">
Constant to set/get the maximum distance a pair of bodies has to move before their collision status has to be recalculated.
</constant>
<constant name="SPACE_PARAM_CONTACT_MAX_SEPARATION" value="1">
<constant name="SPACE_PARAM_CONTACT_MAX_SEPARATION" value="1" enum="SpaceParameter">
Constant to set/get the maximum distance a shape can be from another before they are considered separated.
</constant>
<constant name="SPACE_PARAM_BODY_MAX_ALLOWED_PENETRATION" value="2">
<constant name="SPACE_PARAM_BODY_MAX_ALLOWED_PENETRATION" value="2" enum="SpaceParameter">
Constant to set/get the maximum distance a shape can penetrate another shape before it is considered a collision.
</constant>
<constant name="SPACE_PARAM_BODY_LINEAR_VELOCITY_SLEEP_THRESHOLD" value="3">
<constant name="SPACE_PARAM_BODY_LINEAR_VELOCITY_SLEEP_THRESHOLD" value="3" enum="SpaceParameter">
Constant to set/get the threshold linear velocity of activity. A body marked as potentially inactive for both linear and angular velocity will be put to sleep after the time given.
</constant>
<constant name="SPACE_PARAM_BODY_ANGULAR_VELOCITY_SLEEP_THRESHOLD" value="4">
<constant name="SPACE_PARAM_BODY_ANGULAR_VELOCITY_SLEEP_THRESHOLD" value="4" enum="SpaceParameter">
Constant to set/get the threshold angular velocity of activity. A body marked as potentially inactive for both linear and angular velocity will be put to sleep after the time given.
</constant>
<constant name="SPACE_PARAM_BODY_TIME_TO_SLEEP" value="5">
<constant name="SPACE_PARAM_BODY_TIME_TO_SLEEP" value="5" enum="SpaceParameter">
Constant to set/get the maximum time of activity. A body marked as potentially inactive for both linear and angular velocity will be put to sleep after this time.
</constant>
<constant name="SPACE_PARAM_CONSTRAINT_DEFAULT_BIAS" value="6">
<constant name="SPACE_PARAM_CONSTRAINT_DEFAULT_BIAS" value="6" enum="SpaceParameter">
Constant to set/get the default solver bias for all physics constraints. A solver bias is a factor controlling how much two objects "rebound", after violating a constraint, to avoid leaving them in that state because of numerical imprecision.
</constant>
<constant name="SHAPE_LINE" value="0">
<constant name="SHAPE_LINE" value="0" enum="ShapeType">
This is the constant for creating line shapes. A line shape is an infinite line with an origin point, and a normal. Thus, it can be used for front/behind checks.
</constant>
<constant name="SHAPE_RAY" value="1">
<constant name="SHAPE_RAY" value="1" enum="ShapeType">
</constant>
<constant name="SHAPE_SEGMENT" value="2">
<constant name="SHAPE_SEGMENT" value="2" enum="ShapeType">
This is the constant for creating segment shapes. A segment shape is a line from a point A to a point B. It can be checked for intersections.
</constant>
<constant name="SHAPE_CIRCLE" value="3">
<constant name="SHAPE_CIRCLE" value="3" enum="ShapeType">
This is the constant for creating circle shapes. A circle shape only has a radius. It can be used for intersections and inside/outside checks.
</constant>
<constant name="SHAPE_RECTANGLE" value="4">
<constant name="SHAPE_RECTANGLE" value="4" enum="ShapeType">
This is the constant for creating rectangle shapes. A rectangle shape is defined by a width and a height. It can be used for intersections and inside/outside checks.
</constant>
<constant name="SHAPE_CAPSULE" value="5">
<constant name="SHAPE_CAPSULE" value="5" enum="ShapeType">
This is the constant for creating capsule shapes. A capsule shape is defined by a radius and a length. It can be used for intersections and inside/outside checks.
</constant>
<constant name="SHAPE_CONVEX_POLYGON" value="6">
<constant name="SHAPE_CONVEX_POLYGON" value="6" enum="ShapeType">
This is the constant for creating convex polygon shapes. A polygon is defined by a list of points. It can be used for intersections and inside/outside checks. Unlike the method [method CollisionPolygon2D.set_polygon], polygons modified with [method shape_set_data] do not verify that the points supplied form is a convex polygon.
</constant>
<constant name="SHAPE_CONCAVE_POLYGON" value="7">
<constant name="SHAPE_CONCAVE_POLYGON" value="7" enum="ShapeType">
This is the constant for creating concave polygon shapes. A polygon is defined by a list of points. It can be used for intersections checks, but not for inside/outside checks.
</constant>
<constant name="SHAPE_CUSTOM" value="8">
<constant name="SHAPE_CUSTOM" value="8" enum="ShapeType">
This constant is used internally by the engine. Any attempt to create this kind of shape results in an error.
</constant>
<constant name="AREA_PARAM_GRAVITY" value="0">
<constant name="AREA_PARAM_GRAVITY" value="0" enum="AreaParameter">
Constant to set/get gravity strength in an area.
</constant>
<constant name="AREA_PARAM_GRAVITY_VECTOR" value="1">
<constant name="AREA_PARAM_GRAVITY_VECTOR" value="1" enum="AreaParameter">
Constant to set/get gravity vector/center in an area.
</constant>
<constant name="AREA_PARAM_GRAVITY_IS_POINT" value="2">
<constant name="AREA_PARAM_GRAVITY_IS_POINT" value="2" enum="AreaParameter">
Constant to set/get whether the gravity vector of an area is a direction, or a center point.
</constant>
<constant name="AREA_PARAM_GRAVITY_DISTANCE_SCALE" value="3">
<constant name="AREA_PARAM_GRAVITY_DISTANCE_SCALE" value="3" enum="AreaParameter">
Constant to set/get the falloff factor for point gravity of an area. The greater this value is, the faster the strength of gravity decreases with the square of distance.
</constant>
<constant name="AREA_PARAM_GRAVITY_POINT_ATTENUATION" value="4">
<constant name="AREA_PARAM_GRAVITY_POINT_ATTENUATION" value="4" enum="AreaParameter">
This constant was used to set/get the falloff factor for point gravity. It has been superseded by AREA_PARAM_GRAVITY_DISTANCE_SCALE.
</constant>
<constant name="AREA_PARAM_LINEAR_DAMP" value="5">
<constant name="AREA_PARAM_LINEAR_DAMP" value="5" enum="AreaParameter">
Constant to set/get the linear dampening factor of an area.
</constant>
<constant name="AREA_PARAM_ANGULAR_DAMP" value="6">
<constant name="AREA_PARAM_ANGULAR_DAMP" value="6" enum="AreaParameter">
Constant to set/get the angular dampening factor of an area.
</constant>
<constant name="AREA_PARAM_PRIORITY" value="7">
<constant name="AREA_PARAM_PRIORITY" value="7" enum="AreaParameter">
Constant to set/get the priority (order of processing) of an area.
</constant>
<constant name="AREA_SPACE_OVERRIDE_DISABLED" value="0">
<constant name="AREA_SPACE_OVERRIDE_DISABLED" value="0" enum="AreaSpaceOverrideMode">
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">
<constant name="AREA_SPACE_OVERRIDE_COMBINE" value="1" enum="AreaSpaceOverrideMode">
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_COMBINE_REPLACE" value="2">
<constant name="AREA_SPACE_OVERRIDE_COMBINE_REPLACE" value="2" enum="AreaSpaceOverrideMode">
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">
<constant name="AREA_SPACE_OVERRIDE_REPLACE" value="3" enum="AreaSpaceOverrideMode">
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_COMBINE" value="4">
<constant name="AREA_SPACE_OVERRIDE_REPLACE_COMBINE" value="4" enum="AreaSpaceOverrideMode">
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 name="BODY_MODE_STATIC" value="0" enum="BodyMode">
Constant for static bodies.
</constant>
<constant name="BODY_MODE_KINEMATIC" value="1">
<constant name="BODY_MODE_KINEMATIC" value="1" enum="BodyMode">
Constant for kinematic bodies.
</constant>
<constant name="BODY_MODE_RIGID" value="2">
<constant name="BODY_MODE_RIGID" value="2" enum="BodyMode">
Constant for rigid bodies.
</constant>
<constant name="BODY_MODE_CHARACTER" value="3">
<constant name="BODY_MODE_CHARACTER" value="3" enum="BodyMode">
Constant for rigid bodies in character mode. In this mode, a body can not rotate, and only its linear velocity is affected by physics.
</constant>
<constant name="BODY_PARAM_BOUNCE" value="0">
<constant name="BODY_PARAM_BOUNCE" value="0" enum="BodyParameter">
Constant to set/get a body's bounce factor.
</constant>
<constant name="BODY_PARAM_FRICTION" value="1">
<constant name="BODY_PARAM_FRICTION" value="1" enum="BodyParameter">
Constant to set/get a body's friction.
</constant>
<constant name="BODY_PARAM_MASS" value="2">
<constant name="BODY_PARAM_MASS" value="2" enum="BodyParameter">
Constant to set/get a body's mass.
</constant>
<constant name="BODY_PARAM_INERTIA" value="3">
<constant name="BODY_PARAM_INERTIA" value="3" enum="BodyParameter">
Constant to set/get a body's inertia.
</constant>
<constant name="BODY_PARAM_GRAVITY_SCALE" value="4">
<constant name="BODY_PARAM_GRAVITY_SCALE" value="4" enum="BodyParameter">
Constant to set/get a body's gravity multiplier.
</constant>
<constant name="BODY_PARAM_LINEAR_DAMP" value="5">
<constant name="BODY_PARAM_LINEAR_DAMP" value="5" enum="BodyParameter">
Constant to set/get a body's linear dampening factor.
</constant>
<constant name="BODY_PARAM_ANGULAR_DAMP" value="6">
<constant name="BODY_PARAM_ANGULAR_DAMP" value="6" enum="BodyParameter">
Constant to set/get a body's angular dampening factor.
</constant>
<constant name="BODY_PARAM_MAX" value="7">
<constant name="BODY_PARAM_MAX" value="7" enum="BodyParameter">
This is the last ID for body parameters. Any attempt to set this property is ignored. Any attempt to get it returns 0.
</constant>
<constant name="BODY_STATE_TRANSFORM" value="0">
<constant name="BODY_STATE_TRANSFORM" value="0" enum="BodyState">
Constant to set/get the current transform matrix of the body.
</constant>
<constant name="BODY_STATE_LINEAR_VELOCITY" value="1">
<constant name="BODY_STATE_LINEAR_VELOCITY" value="1" enum="BodyState">
Constant to set/get the current linear velocity of the body.
</constant>
<constant name="BODY_STATE_ANGULAR_VELOCITY" value="2">
<constant name="BODY_STATE_ANGULAR_VELOCITY" value="2" enum="BodyState">
Constant to set/get the current angular velocity of the body.
</constant>
<constant name="BODY_STATE_SLEEPING" value="3">
<constant name="BODY_STATE_SLEEPING" value="3" enum="BodyState">
Constant to sleep/wake up a body, or to get whether it is sleeping.
</constant>
<constant name="BODY_STATE_CAN_SLEEP" value="4">
<constant name="BODY_STATE_CAN_SLEEP" value="4" enum="BodyState">
Constant to set/get whether the body can sleep.
</constant>
<constant name="JOINT_PIN" value="0">
<constant name="JOINT_PIN" value="0" enum="JointType">
Constant to create pin joints.
</constant>
<constant name="JOINT_GROOVE" value="1">
<constant name="JOINT_GROOVE" value="1" enum="JointType">
Constant to create groove joints.
</constant>
<constant name="JOINT_DAMPED_SPRING" value="2">
<constant name="JOINT_DAMPED_SPRING" value="2" enum="JointType">
Constant to create damped spring joints.
</constant>
<constant name="DAMPED_STRING_REST_LENGTH" value="0">
<constant name="DAMPED_STRING_REST_LENGTH" value="0" enum="DampedStringParam">
Set the resting length of the spring joint. The joint will always try to go to back this length when pulled apart.
</constant>
<constant name="DAMPED_STRING_STIFFNESS" value="1">
<constant name="DAMPED_STRING_STIFFNESS" value="1" enum="DampedStringParam">
Set the stiffness of the spring joint. The joint applies a force equal to the stiffness times the distance from its resting length.
</constant>
<constant name="DAMPED_STRING_DAMPING" value="2">
<constant name="DAMPED_STRING_DAMPING" value="2" enum="DampedStringParam">
Set the damping ratio of the spring joint. A value of 0 indicates an undamped spring, while 1 causes the system to reach equilibrium as fast as possible (critical damping).
</constant>
<constant name="CCD_MODE_DISABLED" value="0">
<constant name="CCD_MODE_DISABLED" value="0" enum="CCDMode">
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">
<constant name="CCD_MODE_CAST_RAY" value="1" enum="CCDMode">
Enables continuous collision detection by raycasting. It is faster than shapecasting, but less precise.
</constant>
<constant name="CCD_MODE_CAST_SHAPE" value="2">
<constant name="CCD_MODE_CAST_SHAPE" value="2" enum="CCDMode">
Enables continuous collision detection by shapecasting. It is the slowest CCD method, and the most precise.
</constant>
<constant name="AREA_BODY_ADDED" value="0">
<constant name="AREA_BODY_ADDED" value="0" enum="AreaBodyStatus">
The value of the first parameter and area callback function receives, when an object enters one of its shapes.
</constant>
<constant name="AREA_BODY_REMOVED" value="1">
<constant name="AREA_BODY_REMOVED" value="1" enum="AreaBodyStatus">
The value of the first parameter and area callback function receives, when an object exits one of its shapes.
</constant>
<constant name="INFO_ACTIVE_OBJECTS" value="0">
<constant name="INFO_ACTIVE_OBJECTS" value="0" enum="ProcessInfo">
Constant to get the number of objects that are not sleeping.
</constant>
<constant name="INFO_COLLISION_PAIRS" value="1">
<constant name="INFO_COLLISION_PAIRS" value="1" enum="ProcessInfo">
Constant to get the number of possible collisions.
</constant>
<constant name="INFO_ISLAND_COUNT" value="2">
<constant name="INFO_ISLAND_COUNT" value="2" enum="ProcessInfo">
Constant to get the number of space regions where a collision could occur.
</constant>
</constants>

238
doc/classes/PhysicsServer.xml
View file

@ -1170,365 +1170,365 @@
</method>
</methods>
<constants>
<constant name="JOINT_PIN" value="0">
<constant name="JOINT_PIN" value="0" enum="JointType">
The [Joint] is a [PinJoint].
</constant>
<constant name="JOINT_HINGE" value="1">
<constant name="JOINT_HINGE" value="1" enum="JointType">
The [Joint] is a [HingeJoint].
</constant>
<constant name="JOINT_SLIDER" value="2">
<constant name="JOINT_SLIDER" value="2" enum="JointType">
The [Joint] is a [SliderJoint].
</constant>
<constant name="JOINT_CONE_TWIST" value="3">
<constant name="JOINT_CONE_TWIST" value="3" enum="JointType">
The [Joint] is a [ConeTwistJoint].
</constant>
<constant name="JOINT_6DOF" value="4">
<constant name="JOINT_6DOF" value="4" enum="JointType">
The [Joint] is a [Generic6DOFJoint].
</constant>
<constant name="PIN_JOINT_BIAS" value="0">
<constant name="PIN_JOINT_BIAS" value="0" enum="PinJointParam">
The strength with which the pinned objects try to stay in positional relation to each other.
The higher, the stronger.
</constant>
<constant name="PIN_JOINT_DAMPING" value="1">
<constant name="PIN_JOINT_DAMPING" value="1" enum="PinJointParam">
The strength with which the pinned objects try to stay in velocity relation to each other.
The higher, the stronger.
</constant>
<constant name="PIN_JOINT_IMPULSE_CLAMP" value="2">
<constant name="PIN_JOINT_IMPULSE_CLAMP" value="2" enum="PinJointParam">
If above 0, this value is the maximum value for an impulse that this Joint puts on it's ends.
</constant>
<constant name="HINGE_JOINT_BIAS" value="0">
<constant name="HINGE_JOINT_BIAS" value="0" enum="HingeJointParam">
The speed with wich the two bodies get pulled together when they move in different directions.
</constant>
<constant name="HINGE_JOINT_LIMIT_UPPER" value="1">
<constant name="HINGE_JOINT_LIMIT_UPPER" value="1" enum="HingeJointParam">
The maximum rotation across the Hinge.
</constant>
<constant name="HINGE_JOINT_LIMIT_LOWER" value="2">
<constant name="HINGE_JOINT_LIMIT_LOWER" value="2" enum="HingeJointParam">
The minimum rotation across the Hinge.
</constant>
<constant name="HINGE_JOINT_LIMIT_BIAS" value="3">
<constant name="HINGE_JOINT_LIMIT_BIAS" value="3" enum="HingeJointParam">
The speed with which the rotation across the axis perpendicular to the hinge gets corrected.
</constant>
<constant name="HINGE_JOINT_LIMIT_SOFTNESS" value="4">
<constant name="HINGE_JOINT_LIMIT_SOFTNESS" value="4" enum="HingeJointParam">
</constant>
<constant name="HINGE_JOINT_LIMIT_RELAXATION" value="5">
<constant name="HINGE_JOINT_LIMIT_RELAXATION" value="5" enum="HingeJointParam">
The lower this value, the more the rotation gets slowed down.
</constant>
<constant name="HINGE_JOINT_MOTOR_TARGET_VELOCITY" value="6">
<constant name="HINGE_JOINT_MOTOR_TARGET_VELOCITY" value="6" enum="HingeJointParam">
Target speed for the motor.
</constant>
<constant name="HINGE_JOINT_MOTOR_MAX_IMPULSE" value="7">
<constant name="HINGE_JOINT_MOTOR_MAX_IMPULSE" value="7" enum="HingeJointParam">
Maximum acceleration for the motor.
</constant>
<constant name="HINGE_JOINT_FLAG_USE_LIMIT" value="0">
<constant name="HINGE_JOINT_FLAG_USE_LIMIT" value="0" enum="HingeJointFlag">
If [code]true[/code] the Hinge has a maximum and a minimum rotation.
</constant>
<constant name="HINGE_JOINT_FLAG_ENABLE_MOTOR" value="1">
<constant name="HINGE_JOINT_FLAG_ENABLE_MOTOR" value="1" enum="HingeJointFlag">
If [code]true[/code] a motor turns the Hinge
</constant>
<constant name="SLIDER_JOINT_LINEAR_LIMIT_UPPER" value="0">
<constant name="SLIDER_JOINT_LINEAR_LIMIT_UPPER" value="0" enum="SliderJointParam">
The maximum difference between the pivot points on their x-axis before damping happens.
</constant>
<constant name="SLIDER_JOINT_LINEAR_LIMIT_LOWER" value="1">
<constant name="SLIDER_JOINT_LINEAR_LIMIT_LOWER" value="1" enum="SliderJointParam">
The minimum difference between the pivot points on their x-axis before damping happens.
</constant>
<constant name="SLIDER_JOINT_LINEAR_LIMIT_SOFTNESS" value="2">
<constant name="SLIDER_JOINT_LINEAR_LIMIT_SOFTNESS" value="2" enum="SliderJointParam">
A factor applied to the movement accross the slider axis once the limits get surpassed. The lower, the slower the movement.
</constant>
<constant name="SLIDER_JOINT_LINEAR_LIMIT_RESTITUTION" value="3">
<constant name="SLIDER_JOINT_LINEAR_LIMIT_RESTITUTION" value="3" enum="SliderJointParam">
The amount of restitution once the limits are surpassed. The lower, the more velocityenergy gets lost.
</constant>
<constant name="SLIDER_JOINT_LINEAR_LIMIT_DAMPING" value="4">
<constant name="SLIDER_JOINT_LINEAR_LIMIT_DAMPING" value="4" enum="SliderJointParam">
The amount of damping once the slider limits are surpassed.
</constant>
<constant name="SLIDER_JOINT_LINEAR_MOTION_SOFTNESS" value="5">
<constant name="SLIDER_JOINT_LINEAR_MOTION_SOFTNESS" value="5" enum="SliderJointParam">
A factor applied to the movement accross the slider axis as long as the slider is in the limits. The lower, the slower the movement.
</constant>
<constant name="SLIDER_JOINT_LINEAR_MOTION_RESTITUTION" value="6">
<constant name="SLIDER_JOINT_LINEAR_MOTION_RESTITUTION" value="6" enum="SliderJointParam">
The amount of restitution inside the slider limits.
</constant>
<constant name="SLIDER_JOINT_LINEAR_MOTION_DAMPING" value="7">
<constant name="SLIDER_JOINT_LINEAR_MOTION_DAMPING" value="7" enum="SliderJointParam">
The amount of damping inside the slider limits.
</constant>
<constant name="SLIDER_JOINT_LINEAR_ORTHOGONAL_SOFTNESS" value="8">
<constant name="SLIDER_JOINT_LINEAR_ORTHOGONAL_SOFTNESS" value="8" enum="SliderJointParam">
A factor applied to the movement accross axes orthogonal to the slider.
</constant>
<constant name="SLIDER_JOINT_LINEAR_ORTHOGONAL_RESTITUTION" value="9">
<constant name="SLIDER_JOINT_LINEAR_ORTHOGONAL_RESTITUTION" value="9" enum="SliderJointParam">
The amount of restitution when movement is accross axes orthogonal to the slider.
</constant>
<constant name="SLIDER_JOINT_LINEAR_ORTHOGONAL_DAMPING" value="10">
<constant name="SLIDER_JOINT_LINEAR_ORTHOGONAL_DAMPING" value="10" enum="SliderJointParam">
The amount of damping when movement is accross axes orthogonal to the slider.
</constant>
<constant name="SLIDER_JOINT_ANGULAR_LIMIT_UPPER" value="11">
<constant name="SLIDER_JOINT_ANGULAR_LIMIT_UPPER" value="11" enum="SliderJointParam">
The upper limit of rotation in the slider.
</constant>
<constant name="SLIDER_JOINT_ANGULAR_LIMIT_LOWER" value="12">
<constant name="SLIDER_JOINT_ANGULAR_LIMIT_LOWER" value="12" enum="SliderJointParam">
The lower limit of rotation in the slider.
</constant>
<constant name="SLIDER_JOINT_ANGULAR_LIMIT_SOFTNESS" value="13">
<constant name="SLIDER_JOINT_ANGULAR_LIMIT_SOFTNESS" value="13" enum="SliderJointParam">
A factor applied to the all rotation once the limit is surpassed.
</constant>
<constant name="SLIDER_JOINT_ANGULAR_LIMIT_RESTITUTION" value="14">
<constant name="SLIDER_JOINT_ANGULAR_LIMIT_RESTITUTION" value="14" enum="SliderJointParam">
The amount of restitution of the rotation when the limit is surpassed.
</constant>
<constant name="SLIDER_JOINT_ANGULAR_LIMIT_DAMPING" value="15">
<constant name="SLIDER_JOINT_ANGULAR_LIMIT_DAMPING" value="15" enum="SliderJointParam">
The amount of damping of the rotation when the limit is surpassed.
</constant>
<constant name="SLIDER_JOINT_ANGULAR_MOTION_SOFTNESS" value="16">
<constant name="SLIDER_JOINT_ANGULAR_MOTION_SOFTNESS" value="16" enum="SliderJointParam">
A factor that gets applied to the all rotation in the limits.
</constant>
<constant name="SLIDER_JOINT_ANGULAR_MOTION_RESTITUTION" value="17">
<constant name="SLIDER_JOINT_ANGULAR_MOTION_RESTITUTION" value="17" enum="SliderJointParam">
The amount of restitution of the rotation in the limits.
</constant>
<constant name="SLIDER_JOINT_ANGULAR_MOTION_DAMPING" value="18">
<constant name="SLIDER_JOINT_ANGULAR_MOTION_DAMPING" value="18" enum="SliderJointParam">
The amount of damping of the rotation in the limits.
</constant>
<constant name="SLIDER_JOINT_ANGULAR_ORTHOGONAL_SOFTNESS" value="19">
<constant name="SLIDER_JOINT_ANGULAR_ORTHOGONAL_SOFTNESS" value="19" enum="SliderJointParam">
A factor that gets applied to the all rotation across axes orthogonal to the slider.
</constant>
<constant name="SLIDER_JOINT_ANGULAR_ORTHOGONAL_RESTITUTION" value="20">
<constant name="SLIDER_JOINT_ANGULAR_ORTHOGONAL_RESTITUTION" value="20" enum="SliderJointParam">
The amount of restitution of the rotation across axes orthogonal to the slider.
</constant>
<constant name="SLIDER_JOINT_ANGULAR_ORTHOGONAL_DAMPING" value="21">
<constant name="SLIDER_JOINT_ANGULAR_ORTHOGONAL_DAMPING" value="21" enum="SliderJointParam">
The amount of damping of the rotation across axes orthogonal to the slider.
</constant>
<constant name="SLIDER_JOINT_MAX" value="22">
<constant name="SLIDER_JOINT_MAX" value="22" enum="SliderJointParam">
End flag of SLIDER_JOINT_* constants, used internally.
</constant>
<constant name="CONE_TWIST_JOINT_SWING_SPAN" value="0">
<constant name="CONE_TWIST_JOINT_SWING_SPAN" value="0" enum="ConeTwistJointParam">
Swing is rotation from side to side, around the axis perpendicular to the twist axis.
The swing span defines, how much rotation will not get corrected allong the swing axis.
Could be defined as looseness in the [ConeTwistJoint].
If below 0.05, this behaviour is locked. Default value: [code]PI/4[/code].
</constant>
<constant name="CONE_TWIST_JOINT_TWIST_SPAN" value="1">
<constant name="CONE_TWIST_JOINT_TWIST_SPAN" value="1" enum="ConeTwistJointParam">
Twist is the rotation around the twist axis, this value defined how far the joint can twist.
Twist is locked if below 0.05.
</constant>
<constant name="CONE_TWIST_JOINT_BIAS" value="2">
<constant name="CONE_TWIST_JOINT_BIAS" value="2" enum="ConeTwistJointParam">
The speed with which the swing or twist will take place.
The higher, the faster.
</constant>
<constant name="CONE_TWIST_JOINT_SOFTNESS" value="3">
<constant name="CONE_TWIST_JOINT_SOFTNESS" value="3" enum="ConeTwistJointParam">
The ease with which the Joint twists, if it's too low, it takes more force to twist the joint.
</constant>
<constant name="CONE_TWIST_JOINT_RELAXATION" value="4">
<constant name="CONE_TWIST_JOINT_RELAXATION" value="4" enum="ConeTwistJointParam">
Defines, how fast the swing- and twist-speed-difference on both sides gets synced.
</constant>
<constant name="G6DOF_JOINT_LINEAR_LOWER_LIMIT" value="0">
<constant name="G6DOF_JOINT_LINEAR_LOWER_LIMIT" value="0" enum="G6DOFJointAxisParam">
The minimum difference between the pivot points' axes.
</constant>
<constant name="G6DOF_JOINT_LINEAR_UPPER_LIMIT" value="1">
<constant name="G6DOF_JOINT_LINEAR_UPPER_LIMIT" value="1" enum="G6DOFJointAxisParam">
The maximum difference between the pivot points' axes.
</constant>
<constant name="G6DOF_JOINT_LINEAR_LIMIT_SOFTNESS" value="2">
<constant name="G6DOF_JOINT_LINEAR_LIMIT_SOFTNESS" value="2" enum="G6DOFJointAxisParam">
A factor that gets applied to the movement accross the axes. The lower, the slower the movement.
</constant>
<constant name="G6DOF_JOINT_LINEAR_RESTITUTION" value="3">
<constant name="G6DOF_JOINT_LINEAR_RESTITUTION" value="3" enum="G6DOFJointAxisParam">
The amount of restitution on the axes movement. The lower, the more velocity-energy gets lost.
</constant>
<constant name="G6DOF_JOINT_LINEAR_DAMPING" value="4">
<constant name="G6DOF_JOINT_LINEAR_DAMPING" value="4" enum="G6DOFJointAxisParam">
The amount of damping that happens at the linear motion across the axes.
</constant>
<constant name="G6DOF_JOINT_ANGULAR_LOWER_LIMIT" value="5">
<constant name="G6DOF_JOINT_ANGULAR_LOWER_LIMIT" value="5" enum="G6DOFJointAxisParam">
The minimum rotation in negative direction to break loose and rotate arround the axes.
</constant>
<constant name="G6DOF_JOINT_ANGULAR_UPPER_LIMIT" value="6">
<constant name="G6DOF_JOINT_ANGULAR_UPPER_LIMIT" value="6" enum="G6DOFJointAxisParam">
The minimum rotation in positive direction to break loose and rotate arround the axes.
</constant>
<constant name="G6DOF_JOINT_ANGULAR_LIMIT_SOFTNESS" value="7">
<constant name="G6DOF_JOINT_ANGULAR_LIMIT_SOFTNESS" value="7" enum="G6DOFJointAxisParam">
A factor that gets multiplied onto all rotations accross the axes.
</constant>
<constant name="G6DOF_JOINT_ANGULAR_DAMPING" value="8">
<constant name="G6DOF_JOINT_ANGULAR_DAMPING" value="8" enum="G6DOFJointAxisParam">
The amount of rotational damping accross the axes. The lower, the more dampening occurs.
</constant>
<constant name="G6DOF_JOINT_ANGULAR_RESTITUTION" value="9">
<constant name="G6DOF_JOINT_ANGULAR_RESTITUTION" value="9" enum="G6DOFJointAxisParam">
The amount of rotational restitution accross the axes. The lower, the more restitution occurs.
</constant>
<constant name="G6DOF_JOINT_ANGULAR_FORCE_LIMIT" value="10">
<constant name="G6DOF_JOINT_ANGULAR_FORCE_LIMIT" value="10" enum="G6DOFJointAxisParam">
The maximum amount of force that can occur, when rotating arround the axes.
</constant>
<constant name="G6DOF_JOINT_ANGULAR_ERP" value="11">
<constant name="G6DOF_JOINT_ANGULAR_ERP" value="11" enum="G6DOFJointAxisParam">
When correcting the crossing of limits in rotation accross the axes, this error tolerance factor defines how much the correction gets slowed down. The lower, the slower.
</constant>
<constant name="G6DOF_JOINT_ANGULAR_MOTOR_TARGET_VELOCITY" value="12">
<constant name="G6DOF_JOINT_ANGULAR_MOTOR_TARGET_VELOCITY" value="12" enum="G6DOFJointAxisParam">
Target speed for the motor at the axes.
</constant>
<constant name="G6DOF_JOINT_ANGULAR_MOTOR_FORCE_LIMIT" value="13">
<constant name="G6DOF_JOINT_ANGULAR_MOTOR_FORCE_LIMIT" value="13" enum="G6DOFJointAxisParam">
Maximum acceleration for the motor at the axes.
</constant>
<constant name="G6DOF_JOINT_FLAG_ENABLE_LINEAR_LIMIT" value="0">
<constant name="G6DOF_JOINT_FLAG_ENABLE_LINEAR_LIMIT" value="0" enum="G6DOFJointAxisFlag">
If [code]set[/code] there is linear motion possible within the given limits.
</constant>
<constant name="G6DOF_JOINT_FLAG_ENABLE_ANGULAR_LIMIT" value="1">
<constant name="G6DOF_JOINT_FLAG_ENABLE_ANGULAR_LIMIT" value="1" enum="G6DOFJointAxisFlag">
If [code]set[/code] there is rotational motion possible.
</constant>
<constant name="G6DOF_JOINT_FLAG_ENABLE_MOTOR" value="2">
<constant name="G6DOF_JOINT_FLAG_ENABLE_MOTOR" value="2" enum="G6DOFJointAxisFlag">
If [code]set[/code] there is a rotational motor across these axes.
</constant>
<constant name="SHAPE_PLANE" value="0">
<constant name="SHAPE_PLANE" value="0" enum="ShapeType">
The [Shape] is a [PlaneShape].
</constant>
<constant name="SHAPE_RAY" value="1">
<constant name="SHAPE_RAY" value="1" enum="ShapeType">
The [Shape] is a [RayShape].
</constant>
<constant name="SHAPE_SPHERE" value="2">
<constant name="SHAPE_SPHERE" value="2" enum="ShapeType">
The [Shape] is a [SphereShape].
</constant>
<constant name="SHAPE_BOX" value="3">
<constant name="SHAPE_BOX" value="3" enum="ShapeType">
The [Shape] is a [BoxShape].
</constant>
<constant name="SHAPE_CAPSULE" value="4">
<constant name="SHAPE_CAPSULE" value="4" enum="ShapeType">
The [Shape] is a [CapsuleShape].
</constant>
<constant name="SHAPE_CONVEX_POLYGON" value="5">
<constant name="SHAPE_CONVEX_POLYGON" value="5" enum="ShapeType">
The [Shape] is a [ConvexPolygonShape].
</constant>
<constant name="SHAPE_CONCAVE_POLYGON" value="6">
<constant name="SHAPE_CONCAVE_POLYGON" value="6" enum="ShapeType">
The [Shape] is a [ConcavePolygonShape].
</constant>
<constant name="SHAPE_HEIGHTMAP" value="7">
<constant name="SHAPE_HEIGHTMAP" value="7" enum="ShapeType">
The [Shape] is a [HeightMapShape].
</constant>
<constant name="SHAPE_CUSTOM" value="8">
<constant name="SHAPE_CUSTOM" value="8" enum="ShapeType">
This constant is used internally by the engine. Any attempt to create this kind of shape results in an error.
</constant>
<constant name="AREA_PARAM_GRAVITY" value="0">
<constant name="AREA_PARAM_GRAVITY" value="0" enum="AreaParameter">
Constant to set/get gravity strength in an area.
</constant>
<constant name="AREA_PARAM_GRAVITY_VECTOR" value="1">
<constant name="AREA_PARAM_GRAVITY_VECTOR" value="1" enum="AreaParameter">
Constant to set/get gravity vector/center in an area.
</constant>
<constant name="AREA_PARAM_GRAVITY_IS_POINT" value="2">
<constant name="AREA_PARAM_GRAVITY_IS_POINT" value="2" enum="AreaParameter">
Constant to set/get whether the gravity vector of an area is a direction, or a center point.
</constant>
<constant name="AREA_PARAM_GRAVITY_DISTANCE_SCALE" value="3">
<constant name="AREA_PARAM_GRAVITY_DISTANCE_SCALE" value="3" enum="AreaParameter">
Constant to set/get the falloff factor for point gravity of an area. The greater this value is, the faster the strength of gravity decreases with the square of distance.
</constant>
<constant name="AREA_PARAM_GRAVITY_POINT_ATTENUATION" value="4">
<constant name="AREA_PARAM_GRAVITY_POINT_ATTENUATION" value="4" enum="AreaParameter">
This constant was used to set/get the falloff factor for point gravity. It has been superseded by AREA_PARAM_GRAVITY_DISTANCE_SCALE.
</constant>
<constant name="AREA_PARAM_LINEAR_DAMP" value="5">
<constant name="AREA_PARAM_LINEAR_DAMP" value="5" enum="AreaParameter">
Constant to set/get the linear dampening factor of an area.
</constant>
<constant name="AREA_PARAM_ANGULAR_DAMP" value="6">
<constant name="AREA_PARAM_ANGULAR_DAMP" value="6" enum="AreaParameter">
Constant to set/get the angular dampening factor of an area.
</constant>
<constant name="AREA_PARAM_PRIORITY" value="7">
<constant name="AREA_PARAM_PRIORITY" value="7" enum="AreaParameter">
Constant to set/get the priority (order of processing) of an area.
</constant>
<constant name="AREA_SPACE_OVERRIDE_DISABLED" value="0">
<constant name="AREA_SPACE_OVERRIDE_DISABLED" value="0" enum="AreaSpaceOverrideMode">
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">
<constant name="AREA_SPACE_OVERRIDE_COMBINE" value="1" enum="AreaSpaceOverrideMode">
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_COMBINE_REPLACE" value="2">
<constant name="AREA_SPACE_OVERRIDE_COMBINE_REPLACE" value="2" enum="AreaSpaceOverrideMode">
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">
<constant name="AREA_SPACE_OVERRIDE_REPLACE" value="3" enum="AreaSpaceOverrideMode">
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_COMBINE" value="4">
<constant name="AREA_SPACE_OVERRIDE_REPLACE_COMBINE" value="4" enum="AreaSpaceOverrideMode">
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 name="BODY_MODE_STATIC" value="0" enum="BodyMode">
Constant for static bodies.
</constant>
<constant name="BODY_MODE_KINEMATIC" value="1">
<constant name="BODY_MODE_KINEMATIC" value="1" enum="BodyMode">
Constant for kinematic bodies.
</constant>
<constant name="BODY_MODE_RIGID" value="2">
<constant name="BODY_MODE_RIGID" value="2" enum="BodyMode">
Constant for rigid bodies.
</constant>
<constant name="BODY_MODE_SOFT" value="3">
<constant name="BODY_MODE_SOFT" value="3" enum="BodyMode">
</constant>
<constant name="BODY_MODE_CHARACTER" value="4">
<constant name="BODY_MODE_CHARACTER" value="4" enum="BodyMode">
Constant for rigid bodies in character mode. In this mode, a body can not rotate, and only its linear velocity is affected by physics.
</constant>
<constant name="BODY_PARAM_BOUNCE" value="0">
<constant name="BODY_PARAM_BOUNCE" value="0" enum="BodyParameter">
Constant to set/get a body's bounce factor.
</constant>
<constant name="BODY_PARAM_FRICTION" value="1">
<constant name="BODY_PARAM_FRICTION" value="1" enum="BodyParameter">
Constant to set/get a body's friction.
</constant>
<constant name="BODY_PARAM_MASS" value="2">
<constant name="BODY_PARAM_MASS" value="2" enum="BodyParameter">
Constant to set/get a body's mass.
</constant>
<constant name="BODY_PARAM_GRAVITY_SCALE" value="3">
<constant name="BODY_PARAM_GRAVITY_SCALE" value="3" enum="BodyParameter">
Constant to set/get a body's gravity multiplier.
</constant>
<constant name="BODY_PARAM_LINEAR_DAMP" value="4">
<constant name="BODY_PARAM_LINEAR_DAMP" value="4" enum="BodyParameter">
Constant to set/get a body's linear dampening factor.
</constant>
<constant name="BODY_PARAM_ANGULAR_DAMP" value="5">
<constant name="BODY_PARAM_ANGULAR_DAMP" value="5" enum="BodyParameter">
Constant to set/get a body's angular dampening factor.
</constant>
<constant name="BODY_PARAM_MAX" value="6">
<constant name="BODY_PARAM_MAX" value="6" enum="BodyParameter">
This is the last ID for body parameters. Any attempt to set this property is ignored. Any attempt to get it returns 0.
</constant>
<constant name="BODY_STATE_TRANSFORM" value="0">
<constant name="BODY_STATE_TRANSFORM" value="0" enum="BodyState">
Constant to set/get the current transform matrix of the body.
</constant>
<constant name="BODY_STATE_LINEAR_VELOCITY" value="1">
<constant name="BODY_STATE_LINEAR_VELOCITY" value="1" enum="BodyState">
Constant to set/get the current linear velocity of the body.
</constant>
<constant name="BODY_STATE_ANGULAR_VELOCITY" value="2">
<constant name="BODY_STATE_ANGULAR_VELOCITY" value="2" enum="BodyState">
Constant to set/get the current angular velocity of the body.
</constant>
<constant name="BODY_STATE_SLEEPING" value="3">
<constant name="BODY_STATE_SLEEPING" value="3" enum="BodyState">
Constant to sleep/wake up a body, or to get whether it is sleeping.
</constant>
<constant name="BODY_STATE_CAN_SLEEP" value="4">
<constant name="BODY_STATE_CAN_SLEEP" value="4" enum="BodyState">
Constant to set/get whether the body can sleep.
</constant>
<constant name="AREA_BODY_ADDED" value="0">
<constant name="AREA_BODY_ADDED" value="0" enum="AreaBodyStatus">
The value of the first parameter and area callback function receives, when an object enters one of its shapes.
</constant>
<constant name="AREA_BODY_REMOVED" value="1">
<constant name="AREA_BODY_REMOVED" value="1" enum="AreaBodyStatus">
The value of the first parameter and area callback function receives, when an object exits one of its shapes.
</constant>
<constant name="INFO_ACTIVE_OBJECTS" value="0">
<constant name="INFO_ACTIVE_OBJECTS" value="0" enum="ProcessInfo">
Constant to get the number of objects that are not sleeping.
</constant>
<constant name="INFO_COLLISION_PAIRS" value="1">
<constant name="INFO_COLLISION_PAIRS" value="1" enum="ProcessInfo">
Constant to get the number of possible collisions.
</constant>
<constant name="INFO_ISLAND_COUNT" value="2">
<constant name="INFO_ISLAND_COUNT" value="2" enum="ProcessInfo">
Constant to get the number of space regions where a collision could occur.
</constant>
<constant name="SPACE_PARAM_CONTACT_RECYCLE_RADIUS" value="0">
<constant name="SPACE_PARAM_CONTACT_RECYCLE_RADIUS" value="0" enum="SpaceParameter">
Constant to set/get the maximum distance a pair of bodies has to move before their collision status has to be recalculated.
</constant>
<constant name="SPACE_PARAM_CONTACT_MAX_SEPARATION" value="1">
<constant name="SPACE_PARAM_CONTACT_MAX_SEPARATION" value="1" enum="SpaceParameter">
Constant to set/get the maximum distance a shape can be from another before they are considered separated.
</constant>
<constant name="SPACE_PARAM_BODY_MAX_ALLOWED_PENETRATION" value="2">
<constant name="SPACE_PARAM_BODY_MAX_ALLOWED_PENETRATION" value="2" enum="SpaceParameter">
Constant to set/get the maximum distance a shape can penetrate another shape before it is considered a collision.
</constant>
<constant name="SPACE_PARAM_BODY_LINEAR_VELOCITY_SLEEP_THRESHOLD" value="3">
<constant name="SPACE_PARAM_BODY_LINEAR_VELOCITY_SLEEP_THRESHOLD" value="3" enum="SpaceParameter">
Constant to set/get the threshold linear velocity of activity. A body marked as potentially inactive for both linear and angular velocity will be put to sleep after the time given.
</constant>
<constant name="SPACE_PARAM_BODY_ANGULAR_VELOCITY_SLEEP_THRESHOLD" value="4">
<constant name="SPACE_PARAM_BODY_ANGULAR_VELOCITY_SLEEP_THRESHOLD" value="4" enum="SpaceParameter">
Constant to set/get the threshold angular velocity of activity. A body marked as potentially inactive for both linear and angular velocity will be put to sleep after the time given.
</constant>
<constant name="SPACE_PARAM_BODY_TIME_TO_SLEEP" value="5">
<constant name="SPACE_PARAM_BODY_TIME_TO_SLEEP" value="5" enum="SpaceParameter">
Constant to set/get the maximum time of activity. A body marked as potentially inactive for both linear and angular velocity will be put to sleep after this time.
</constant>
<constant name="SPACE_PARAM_BODY_ANGULAR_VELOCITY_DAMP_RATIO" value="6">
<constant name="SPACE_PARAM_BODY_ANGULAR_VELOCITY_DAMP_RATIO" value="6" enum="SpaceParameter">
</constant>
<constant name="SPACE_PARAM_CONSTRAINT_DEFAULT_BIAS" value="7">
<constant name="SPACE_PARAM_CONSTRAINT_DEFAULT_BIAS" value="7" enum="SpaceParameter">
Constant to set/get the default solver bias for all physics constraints. A solver bias is a factor controlling how much two objects "rebound", after violating a constraint, to avoid leaving them in that state because of numerical imprecision.
</constant>
<constant name="BODY_AXIS_LOCK_DISABLED" value="0">
<constant name="BODY_AXIS_LOCK_DISABLED" value="0" enum="BodyAxisLock">
The [Body] can rotate and move freely.
</constant>
<constant name="BODY_AXIS_LOCK_X" value="1">
<constant name="BODY_AXIS_LOCK_X" value="1" enum="BodyAxisLock">
The [Body] cannot move across x axis can only rotate across x axis.
</constant>
<constant name="BODY_AXIS_LOCK_Y" value="2">
<constant name="BODY_AXIS_LOCK_Y" value="2" enum="BodyAxisLock">
The [Body] cannot move across y axis can only rotate across y axis.
</constant>
<constant name="BODY_AXIS_LOCK_Z" value="3">
<constant name="BODY_AXIS_LOCK_Z" value="3" enum="BodyAxisLock">
The [Body] cannot move across z axis can only rotate across z axis.
</constant>
</constants>

6
doc/classes/PinJoint.xml
View file

@ -26,15 +26,15 @@
</member>
</members>
<constants>
<constant name="PARAM_BIAS" value="0">
<constant name="PARAM_BIAS" value="0" enum="Param">
The force with wich the pinned objects stay in positional relation to each other.
The higher, the stronger.
</constant>
<constant name="PARAM_DAMPING" value="1">
<constant name="PARAM_DAMPING" value="1" enum="Param">
The force with wich the pinned objects stay in velocity relation to each other.
The higher, the stronger.
</constant>
<constant name="PARAM_IMPULSE_CLAMP" value="2">
<constant name="PARAM_IMPULSE_CLAMP" value="2" enum="Param">
If above 0, this value is the maximum value for an impulse that this Joint produces.
</constant>
</constants>

4
doc/classes/Popup.xml
View file

@ -65,10 +65,10 @@
</signal>
</signals>
<constants>
<constant name="NOTIFICATION_POST_POPUP" value="80" enum="">
<constant name="NOTIFICATION_POST_POPUP" value="80">
Notification sent right after the popup is shown.
</constant>
<constant name="NOTIFICATION_POPUP_HIDE" value="81" enum="">
<constant name="NOTIFICATION_POPUP_HIDE" value="81">
Notification sent right after the popup is hidden.
</constant>
</constants>

12
doc/classes/ProceduralSky.xml
View file

@ -45,17 +45,17 @@
</member>
</members>
<constants>
<constant name="TEXTURE_SIZE_256" value="0">
<constant name="TEXTURE_SIZE_256" value="0" enum="TextureSize">
</constant>
<constant name="TEXTURE_SIZE_512" value="1">
<constant name="TEXTURE_SIZE_512" value="1" enum="TextureSize">
</constant>
<constant name="TEXTURE_SIZE_1024" value="2">
<constant name="TEXTURE_SIZE_1024" value="2" enum="TextureSize">
</constant>
<constant name="TEXTURE_SIZE_2048" value="3">
<constant name="TEXTURE_SIZE_2048" value="3" enum="TextureSize">
</constant>
<constant name="TEXTURE_SIZE_4096" value="4">
<constant name="TEXTURE_SIZE_4096" value="4" enum="TextureSize">
</constant>
<constant name="TEXTURE_SIZE_MAX" value="5">
<constant name="TEXTURE_SIZE_MAX" value="5" enum="TextureSize">
</constant>
</constants>
</class>

4
doc/classes/ReflectionProbe.xml
View file

@ -37,9 +37,9 @@
</member>
</members>
<constants>
<constant name="UPDATE_ONCE" value="0">
<constant name="UPDATE_ONCE" value="0" enum="UpdateMode">
</constant>
<constant name="UPDATE_ALWAYS" value="1">
<constant name="UPDATE_ALWAYS" value="1" enum="UpdateMode">
</constant>
</constants>
</class>

12
doc/classes/ResourceSaver.xml
View file

@ -35,17 +35,17 @@
</method>
</methods>
<constants>
<constant name="FLAG_RELATIVE_PATHS" value="1">
<constant name="FLAG_RELATIVE_PATHS" value="1" enum="SaverFlags">
</constant>
<constant name="FLAG_BUNDLE_RESOURCES" value="2">
<constant name="FLAG_BUNDLE_RESOURCES" value="2" enum="SaverFlags">
</constant>
<constant name="FLAG_CHANGE_PATH" value="4">
<constant name="FLAG_CHANGE_PATH" value="4" enum="SaverFlags">
</constant>
<constant name="FLAG_OMIT_EDITOR_PROPERTIES" value="8">
<constant name="FLAG_OMIT_EDITOR_PROPERTIES" value="8" enum="SaverFlags">
</constant>
<constant name="FLAG_SAVE_BIG_ENDIAN" value="16">
<constant name="FLAG_SAVE_BIG_ENDIAN" value="16" enum="SaverFlags">
</constant>
<constant name="FLAG_COMPRESS" value="32">
<constant name="FLAG_COMPRESS" value="32" enum="SaverFlags">
</constant>
</constants>
</class>

38
doc/classes/RichTextLabel.xml
View file

@ -345,43 +345,43 @@
</signal>
</signals>
<constants>
<constant name="ALIGN_LEFT" value="0">
<constant name="ALIGN_LEFT" value="0" enum="Align">
</constant>
<constant name="ALIGN_CENTER" value="1">
<constant name="ALIGN_CENTER" value="1" enum="Align">
</constant>
<constant name="ALIGN_RIGHT" value="2">
<constant name="ALIGN_RIGHT" value="2" enum="Align">
</constant>
<constant name="ALIGN_FILL" value="3">
<constant name="ALIGN_FILL" value="3" enum="Align">
</constant>
<constant name="LIST_NUMBERS" value="0">
<constant name="LIST_NUMBERS" value="0" enum="ListType">
</constant>
<constant name="LIST_LETTERS" value="1">
<constant name="LIST_LETTERS" value="1" enum="ListType">
</constant>
<constant name="LIST_DOTS" value="2">
<constant name="LIST_DOTS" value="2" enum="ListType">
</constant>
<constant name="ITEM_FRAME" value="0">
<constant name="ITEM_FRAME" value="0" enum="ItemType">
</constant>
<constant name="ITEM_TEXT" value="1">
<constant name="ITEM_TEXT" value="1" enum="ItemType">
</constant>
<constant name="ITEM_IMAGE" value="2">
<constant name="ITEM_IMAGE" value="2" enum="ItemType">
</constant>
<constant name="ITEM_NEWLINE" value="3">
<constant name="ITEM_NEWLINE" value="3" enum="ItemType">
</constant>
<constant name="ITEM_FONT" value="4">
<constant name="ITEM_FONT" value="4" enum="ItemType">
</constant>
<constant name="ITEM_COLOR" value="5">
<constant name="ITEM_COLOR" value="5" enum="ItemType">
</constant>
<constant name="ITEM_UNDERLINE" value="6">
<constant name="ITEM_UNDERLINE" value="6" enum="ItemType">
</constant>
<constant name="ITEM_ALIGN" value="7">
<constant name="ITEM_ALIGN" value="7" enum="ItemType">
</constant>
<constant name="ITEM_INDENT" value="8">
<constant name="ITEM_INDENT" value="8" enum="ItemType">
</constant>
<constant name="ITEM_LIST" value="9">
<constant name="ITEM_LIST" value="9" enum="ItemType">
</constant>
<constant name="ITEM_TABLE" value="10">
<constant name="ITEM_TABLE" value="10" enum="ItemType">
</constant>
<constant name="ITEM_META" value="11">
<constant name="ITEM_META" value="11" enum="ItemType">
</constant>
</constants>
<theme_items>

16
doc/classes/RigidBody.xml
View file

@ -156,25 +156,25 @@
</signal>
</signals>
<constants>
<constant name="MODE_RIGID" value="0">
<constant name="MODE_RIGID" value="0" enum="Mode">
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_STATIC" value="1">
<constant name="MODE_STATIC" value="1" enum="Mode">
Static mode. The body behaves like a [StaticBody], and can only move by user code.
</constant>
<constant name="MODE_CHARACTER" value="2">
<constant name="MODE_CHARACTER" value="2" enum="Mode">
Character body. This behaves like a rigid body, but can not rotate.
</constant>
<constant name="MODE_KINEMATIC" value="3">
<constant name="MODE_KINEMATIC" value="3" enum="Mode">
Kinematic body. The body behaves like a [KinematicBody], and can only move by user code.
</constant>
<constant name="AXIS_LOCK_DISABLED" value="0">
<constant name="AXIS_LOCK_DISABLED" value="0" enum="AxisLock">
</constant>
<constant name="AXIS_LOCK_X" value="1">
<constant name="AXIS_LOCK_X" value="1" enum="AxisLock">
</constant>
<constant name="AXIS_LOCK_Y" value="2">
<constant name="AXIS_LOCK_Y" value="2" enum="AxisLock">
</constant>
<constant name="AXIS_LOCK_Z" value="3">
<constant name="AXIS_LOCK_Z" value="3" enum="AxisLock">
</constant>
</constants>
</class>

14
doc/classes/RigidBody2D.xml
View file

@ -226,25 +226,25 @@
</signal>
</signals>
<constants>
<constant name="MODE_RIGID" value="0">
<constant name="MODE_RIGID" value="0" enum="Mode">
Rigid mode. The body behaves as a physical object. It collides with other bodies and responds to forces applied to it. This is the default mode.
</constant>
<constant name="MODE_STATIC" value="1">
<constant name="MODE_STATIC" value="1" enum="Mode">
Static mode. The body behaves like a [StaticBody2D] and does not move.
</constant>
<constant name="MODE_CHARACTER" value="2">
<constant name="MODE_CHARACTER" value="2" enum="Mode">
Character mode. Similar to [code]MODE_RIGID[/code], but the body can not rotate.
</constant>
<constant name="MODE_KINEMATIC" value="3">
<constant name="MODE_KINEMATIC" value="3" enum="Mode">
Kinematic mode. The body behaves like a [KinematicBody2D], and must be moved by code.
</constant>
<constant name="CCD_MODE_DISABLED" value="0">
<constant name="CCD_MODE_DISABLED" value="0" enum="CCDMode">
Continuous collision detection disabled. 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">
<constant name="CCD_MODE_CAST_RAY" value="1" enum="CCDMode">
Continuous collision detection enabled using raycasting. This is faster than shapecasting but less precise.
</constant>
<constant name="CCD_MODE_CAST_SHAPE" value="2">
<constant name="CCD_MODE_CAST_SHAPE" value="2" enum="CCDMode">
Continuous collision detection enabled using shapecasting. This is the slowest CCD method and the most precise.
</constant>
</constants>

6
doc/classes/SceneState.xml
View file

@ -165,11 +165,11 @@
</method>
</methods>
<constants>
<constant name="GEN_EDIT_STATE_DISABLED" value="0">
<constant name="GEN_EDIT_STATE_DISABLED" value="0" enum="GenEditState">
</constant>
<constant name="GEN_EDIT_STATE_INSTANCE" value="1">
<constant name="GEN_EDIT_STATE_INSTANCE" value="1" enum="GenEditState">
</constant>
<constant name="GEN_EDIT_STATE_MAIN" value="2">
<constant name="GEN_EDIT_STATE_MAIN" value="2" enum="GenEditState">
</constant>
</constants>
</class>

24
doc/classes/SceneTree.xml
View file

@ -388,29 +388,29 @@
</signal>
</signals>
<constants>
<constant name="GROUP_CALL_DEFAULT" value="0">
<constant name="GROUP_CALL_DEFAULT" value="0" enum="CallGroupFlags">
</constant>
<constant name="GROUP_CALL_REVERSE" value="1">
<constant name="GROUP_CALL_REVERSE" value="1" enum="CallGroupFlags">
</constant>
<constant name="GROUP_CALL_REALTIME" value="2">
<constant name="GROUP_CALL_REALTIME" value="2" enum="CallGroupFlags">
</constant>
<constant name="GROUP_CALL_UNIQUE" value="4">
<constant name="GROUP_CALL_UNIQUE" value="4" enum="CallGroupFlags">
</constant>
<constant name="STRETCH_MODE_DISABLED" value="0">
<constant name="STRETCH_MODE_DISABLED" value="0" enum="StretchMode">
</constant>
<constant name="STRETCH_MODE_2D" value="1">
<constant name="STRETCH_MODE_2D" value="1" enum="StretchMode">
</constant>
<constant name="STRETCH_MODE_VIEWPORT" value="2">
<constant name="STRETCH_MODE_VIEWPORT" value="2" enum="StretchMode">
</constant>
<constant name="STRETCH_ASPECT_IGNORE" value="0">
<constant name="STRETCH_ASPECT_IGNORE" value="0" enum="StretchAspect">
</constant>
<constant name="STRETCH_ASPECT_KEEP" value="1">
<constant name="STRETCH_ASPECT_KEEP" value="1" enum="StretchAspect">
</constant>
<constant name="STRETCH_ASPECT_KEEP_WIDTH" value="2">
<constant name="STRETCH_ASPECT_KEEP_WIDTH" value="2" enum="StretchAspect">
</constant>
<constant name="STRETCH_ASPECT_KEEP_HEIGHT" value="3">
<constant name="STRETCH_ASPECT_KEEP_HEIGHT" value="3" enum="StretchAspect">
</constant>
<constant name="STRETCH_ASPECT_EXPAND" value="4">
<constant name="STRETCH_ASPECT_EXPAND" value="4" enum="StretchAspect">
</constant>
</constants>
</class>

6
doc/classes/Shader.xml
View file

@ -49,11 +49,11 @@
</member>
</members>
<constants>
<constant name="MODE_SPATIAL" value="0">
<constant name="MODE_SPATIAL" value="0" enum="Mode">
</constant>
<constant name="MODE_CANVAS_ITEM" value="1">
<constant name="MODE_CANVAS_ITEM" value="1" enum="Mode">
</constant>
<constant name="MODE_PARTICLES" value="2">
<constant name="MODE_PARTICLES" value="2" enum="Mode">
</constant>
</constants>
</class>

2
doc/classes/Skeleton.xml
View file

@ -215,7 +215,7 @@
</method>
</methods>
<constants>
<constant name="NOTIFICATION_UPDATE_SKELETON" value="50" enum="">
<constant name="NOTIFICATION_UPDATE_SKELETON" value="50">
</constant>
</constants>
</class>

16
doc/classes/Sky.xml
View file

@ -15,21 +15,21 @@
</member>
</members>
<constants>
<constant name="RADIANCE_SIZE_32" value="0">
<constant name="RADIANCE_SIZE_32" value="0" enum="RadianceSize">
</constant>
<constant name="RADIANCE_SIZE_64" value="1">
<constant name="RADIANCE_SIZE_64" value="1" enum="RadianceSize">
</constant>
<constant name="RADIANCE_SIZE_128" value="2">
<constant name="RADIANCE_SIZE_128" value="2" enum="RadianceSize">
</constant>
<constant name="RADIANCE_SIZE_256" value="3">
<constant name="RADIANCE_SIZE_256" value="3" enum="RadianceSize">
</constant>
<constant name="RADIANCE_SIZE_512" value="4">
<constant name="RADIANCE_SIZE_512" value="4" enum="RadianceSize">
</constant>
<constant name="RADIANCE_SIZE_1024" value="5">
<constant name="RADIANCE_SIZE_1024" value="5" enum="RadianceSize">
</constant>
<constant name="RADIANCE_SIZE_2048" value="6">
<constant name="RADIANCE_SIZE_2048" value="6" enum="RadianceSize">
</constant>
<constant name="RADIANCE_SIZE_MAX" value="7">
<constant name="RADIANCE_SIZE_MAX" value="7" enum="RadianceSize">
</constant>
</constants>
</class>

46
doc/classes/SliderJoint.xml
View file

@ -84,73 +84,73 @@
</member>
</members>
<constants>
<constant name="PARAM_LINEAR_LIMIT_UPPER" value="0">
<constant name="PARAM_LINEAR_LIMIT_UPPER" value="0" enum="Param">
The maximum difference between the pivot points on their x-axis before damping happens.
</constant>
<constant name="PARAM_LINEAR_LIMIT_LOWER" value="1">
<constant name="PARAM_LINEAR_LIMIT_LOWER" value="1" enum="Param">
The minimum difference between the pivot points on their x-axis before damping happens.
</constant>
<constant name="PARAM_LINEAR_LIMIT_SOFTNESS" value="2">
<constant name="PARAM_LINEAR_LIMIT_SOFTNESS" value="2" enum="Param">
A factor applied to the movement accross the slider axis once the limits get surpassed. The lower, the slower the movement.
</constant>
<constant name="PARAM_LINEAR_LIMIT_RESTITUTION" value="3">
<constant name="PARAM_LINEAR_LIMIT_RESTITUTION" value="3" enum="Param">
The amount of restitution once the limits are surpassed. The lower, the more velocityenergy gets lost.
</constant>
<constant name="PARAM_LINEAR_LIMIT_DAMPING" value="4">
<constant name="PARAM_LINEAR_LIMIT_DAMPING" value="4" enum="Param">
The amount of damping once the slider limits are surpassed.
</constant>
<constant name="PARAM_LINEAR_MOTION_SOFTNESS" value="5">
<constant name="PARAM_LINEAR_MOTION_SOFTNESS" value="5" enum="Param">
A factor applied to the movement accross the slider axis as long as the slider is in the limits. The lower, the slower the movement.
</constant>
<constant name="PARAM_LINEAR_MOTION_RESTITUTION" value="6">
<constant name="PARAM_LINEAR_MOTION_RESTITUTION" value="6" enum="Param">
The amount of restitution inside the slider limits.
</constant>
<constant name="PARAM_LINEAR_MOTION_DAMPING" value="7">
<constant name="PARAM_LINEAR_MOTION_DAMPING" value="7" enum="Param">
The amount of damping inside the slider limits.
</constant>
<constant name="PARAM_LINEAR_ORTHOGONAL_SOFTNESS" value="8">
<constant name="PARAM_LINEAR_ORTHOGONAL_SOFTNESS" value="8" enum="Param">
A factor applied to the movement accross axes orthogonal to the slider.
</constant>
<constant name="PARAM_LINEAR_ORTHOGONAL_RESTITUTION" value="9">
<constant name="PARAM_LINEAR_ORTHOGONAL_RESTITUTION" value="9" enum="Param">
The amount of restitution when movement is accross axes orthogonal to the slider.
</constant>
<constant name="PARAM_LINEAR_ORTHOGONAL_DAMPING" value="10">
<constant name="PARAM_LINEAR_ORTHOGONAL_DAMPING" value="10" enum="Param">
The amount of damping when movement is accross axes orthogonal to the slider.
</constant>
<constant name="PARAM_ANGULAR_LIMIT_UPPER" value="11">
<constant name="PARAM_ANGULAR_LIMIT_UPPER" value="11" enum="Param">
The upper limit of rotation in the slider.
</constant>
<constant name="PARAM_ANGULAR_LIMIT_LOWER" value="12">
<constant name="PARAM_ANGULAR_LIMIT_LOWER" value="12" enum="Param">
The lower limit of rotation in the slider.
</constant>
<constant name="PARAM_ANGULAR_LIMIT_SOFTNESS" value="13">
<constant name="PARAM_ANGULAR_LIMIT_SOFTNESS" value="13" enum="Param">
A factor applied to the all rotation once the limit is surpassed.
</constant>
<constant name="PARAM_ANGULAR_LIMIT_RESTITUTION" value="14">
<constant name="PARAM_ANGULAR_LIMIT_RESTITUTION" value="14" enum="Param">
The amount of restitution of the rotation when the limit is surpassed.
</constant>
<constant name="PARAM_ANGULAR_LIMIT_DAMPING" value="15">
<constant name="PARAM_ANGULAR_LIMIT_DAMPING" value="15" enum="Param">
The amount of damping of the rotation when the limit is surpassed.
</constant>
<constant name="PARAM_ANGULAR_MOTION_SOFTNESS" value="16">
<constant name="PARAM_ANGULAR_MOTION_SOFTNESS" value="16" enum="Param">
A factor applied to the all rotation in the limits.
</constant>
<constant name="PARAM_ANGULAR_MOTION_RESTITUTION" value="17">
<constant name="PARAM_ANGULAR_MOTION_RESTITUTION" value="17" enum="Param">
The amount of restitution of the rotation in the limits.
</constant>
<constant name="PARAM_ANGULAR_MOTION_DAMPING" value="18">
<constant name="PARAM_ANGULAR_MOTION_DAMPING" value="18" enum="Param">
The amount of damping of the rotation in the limits.
</constant>
<constant name="PARAM_ANGULAR_ORTHOGONAL_SOFTNESS" value="19">
<constant name="PARAM_ANGULAR_ORTHOGONAL_SOFTNESS" value="19" enum="Param">
A factor applied to the all rotation across axes orthogonal to the slider.
</constant>
<constant name="PARAM_ANGULAR_ORTHOGONAL_RESTITUTION" value="20">
<constant name="PARAM_ANGULAR_ORTHOGONAL_RESTITUTION" value="20" enum="Param">
The amount of restitution of the rotation across axes orthogonal to the slider.
</constant>
<constant name="PARAM_ANGULAR_ORTHOGONAL_DAMPING" value="21">
<constant name="PARAM_ANGULAR_ORTHOGONAL_DAMPING" value="21" enum="Param">
The amount of damping of the rotation across axes orthogonal to the slider.
</constant>
<constant name="PARAM_MAX" value="22">
<constant name="PARAM_MAX" value="22" enum="Param">
End flag of PARAM_* constants, used internally.
</constant>
</constants>

8
doc/classes/Spatial.xml
View file

@ -281,17 +281,17 @@
</signal>
</signals>
<constants>
<constant name="NOTIFICATION_TRANSFORM_CHANGED" value="29" enum="">
<constant name="NOTIFICATION_TRANSFORM_CHANGED" value="29">
Spatial nodes receives this notification when their global transform changes. This means that either the current or a parent node changed its transform.
In order for NOTIFICATION_TRANSFORM_CHANGED to work user first needs to ask for it, with set_notify_transform(true).
</constant>
<constant name="NOTIFICATION_ENTER_WORLD" value="41" enum="">
<constant name="NOTIFICATION_ENTER_WORLD" value="41">
Spatial nodes receives this notification when they are registered to new [World] resource.
</constant>
<constant name="NOTIFICATION_EXIT_WORLD" value="42" enum="">
<constant name="NOTIFICATION_EXIT_WORLD" value="42">
Spatial nodes receives this notification when they are unregistered from current [World] resource.
</constant>
<constant name="NOTIFICATION_VISIBILITY_CHANGED" value="43" enum="">
<constant name="NOTIFICATION_VISIBILITY_CHANGED" value="43">
Spatial nodes receives this notification when their visibility changes.
</constant>
</constants>

154
doc/classes/SpatialMaterial.xml
View file

@ -197,159 +197,159 @@
</member>
</members>
<constants>
<constant name="TEXTURE_ALBEDO" value="0">
<constant name="TEXTURE_ALBEDO" value="0" enum="TextureParam">
</constant>
<constant name="TEXTURE_METALLIC" value="1">
<constant name="TEXTURE_METALLIC" value="1" enum="TextureParam">
</constant>
<constant name="TEXTURE_ROUGHNESS" value="2">
<constant name="TEXTURE_ROUGHNESS" value="2" enum="TextureParam">
</constant>
<constant name="TEXTURE_EMISSION" value="3">
<constant name="TEXTURE_EMISSION" value="3" enum="TextureParam">
</constant>
<constant name="TEXTURE_NORMAL" value="4">
<constant name="TEXTURE_NORMAL" value="4" enum="TextureParam">
</constant>
<constant name="TEXTURE_RIM" value="5">
<constant name="TEXTURE_RIM" value="5" enum="TextureParam">
</constant>
<constant name="TEXTURE_CLEARCOAT" value="6">
<constant name="TEXTURE_CLEARCOAT" value="6" enum="TextureParam">
</constant>
<constant name="TEXTURE_FLOWMAP" value="7">
<constant name="TEXTURE_FLOWMAP" value="7" enum="TextureParam">
</constant>
<constant name="TEXTURE_AMBIENT_OCCLUSION" value="8">
<constant name="TEXTURE_AMBIENT_OCCLUSION" value="8" enum="TextureParam">
</constant>
<constant name="TEXTURE_DEPTH" value="9">
<constant name="TEXTURE_DEPTH" value="9" enum="TextureParam">
</constant>
<constant name="TEXTURE_SUBSURFACE_SCATTERING" value="10">
<constant name="TEXTURE_SUBSURFACE_SCATTERING" value="10" enum="TextureParam">
</constant>
<constant name="TEXTURE_TRANSMISSION" value="11">
<constant name="TEXTURE_TRANSMISSION" value="11" enum="TextureParam">
</constant>
<constant name="TEXTURE_REFRACTION" value="12">
<constant name="TEXTURE_REFRACTION" value="12" enum="TextureParam">
</constant>
<constant name="TEXTURE_DETAIL_MASK" value="13">
<constant name="TEXTURE_DETAIL_MASK" value="13" enum="TextureParam">
</constant>
<constant name="TEXTURE_DETAIL_ALBEDO" value="14">
<constant name="TEXTURE_DETAIL_ALBEDO" value="14" enum="TextureParam">
</constant>
<constant name="TEXTURE_DETAIL_NORMAL" value="15">
<constant name="TEXTURE_DETAIL_NORMAL" value="15" enum="TextureParam">
</constant>
<constant name="TEXTURE_MAX" value="16">
<constant name="TEXTURE_MAX" value="16" enum="TextureParam">
</constant>
<constant name="DETAIL_UV_1" value="0">
<constant name="DETAIL_UV_1" value="0" enum="DetailUV">
</constant>
<constant name="DETAIL_UV_2" value="1">
<constant name="DETAIL_UV_2" value="1" enum="DetailUV">
</constant>
<constant name="FEATURE_TRANSPARENT" value="0">
<constant name="FEATURE_TRANSPARENT" value="0" enum="Feature">
</constant>
<constant name="FEATURE_EMISSION" value="1">
<constant name="FEATURE_EMISSION" value="1" enum="Feature">
</constant>
<constant name="FEATURE_NORMAL_MAPPING" value="2">
<constant name="FEATURE_NORMAL_MAPPING" value="2" enum="Feature">
</constant>
<constant name="FEATURE_RIM" value="3">
<constant name="FEATURE_RIM" value="3" enum="Feature">
</constant>
<constant name="FEATURE_CLEARCOAT" value="4">
<constant name="FEATURE_CLEARCOAT" value="4" enum="Feature">
</constant>
<constant name="FEATURE_ANISOTROPY" value="5">
<constant name="FEATURE_ANISOTROPY" value="5" enum="Feature">
</constant>
<constant name="FEATURE_AMBIENT_OCCLUSION" value="6">
<constant name="FEATURE_AMBIENT_OCCLUSION" value="6" enum="Feature">
</constant>
<constant name="FEATURE_DEPTH_MAPPING" value="7">
<constant name="FEATURE_DEPTH_MAPPING" value="7" enum="Feature">
</constant>
<constant name="FEATURE_SUBSURACE_SCATTERING" value="8">
<constant name="FEATURE_SUBSURACE_SCATTERING" value="8" enum="Feature">
</constant>
<constant name="FEATURE_TRANSMISSION" value="9">
<constant name="FEATURE_TRANSMISSION" value="9" enum="Feature">
</constant>
<constant name="FEATURE_REFRACTION" value="10">
<constant name="FEATURE_REFRACTION" value="10" enum="Feature">
</constant>
<constant name="FEATURE_DETAIL" value="11">
<constant name="FEATURE_DETAIL" value="11" enum="Feature">
</constant>
<constant name="FEATURE_MAX" value="12">
<constant name="FEATURE_MAX" value="12" enum="Feature">
</constant>
<constant name="BLEND_MODE_MIX" value="0">
<constant name="BLEND_MODE_MIX" value="0" enum="BlendMode">
</constant>
<constant name="BLEND_MODE_ADD" value="1">
<constant name="BLEND_MODE_ADD" value="1" enum="BlendMode">
</constant>
<constant name="BLEND_MODE_SUB" value="2">
<constant name="BLEND_MODE_SUB" value="2" enum="BlendMode">
</constant>
<constant name="BLEND_MODE_MUL" value="3">
<constant name="BLEND_MODE_MUL" value="3" enum="BlendMode">
</constant>
<constant name="DEPTH_DRAW_OPAQUE_ONLY" value="0">
<constant name="DEPTH_DRAW_OPAQUE_ONLY" value="0" enum="DepthDrawMode">
</constant>
<constant name="DEPTH_DRAW_ALWAYS" value="1">
<constant name="DEPTH_DRAW_ALWAYS" value="1" enum="DepthDrawMode">
</constant>
<constant name="DEPTH_DRAW_DISABLED" value="2">
<constant name="DEPTH_DRAW_DISABLED" value="2" enum="DepthDrawMode">
</constant>
<constant name="DEPTH_DRAW_ALPHA_OPAQUE_PREPASS" value="3">
<constant name="DEPTH_DRAW_ALPHA_OPAQUE_PREPASS" value="3" enum="DepthDrawMode">
</constant>
<constant name="CULL_BACK" value="0">
<constant name="CULL_BACK" value="0" enum="CullMode">
</constant>
<constant name="CULL_FRONT" value="1">
<constant name="CULL_FRONT" value="1" enum="CullMode">
</constant>
<constant name="CULL_DISABLED" value="2">
<constant name="CULL_DISABLED" value="2" enum="CullMode">
</constant>
<constant name="FLAG_UNSHADED" value="0">
<constant name="FLAG_UNSHADED" value="0" enum="Flags">
</constant>
<constant name="FLAG_USE_VERTEX_LIGHTING" value="1">
<constant name="FLAG_USE_VERTEX_LIGHTING" value="1" enum="Flags">
</constant>
<constant name="FLAG_DISABLE_DEPTH_TEST" value="2">
<constant name="FLAG_DISABLE_DEPTH_TEST" value="2" enum="Flags">
</constant>
<constant name="FLAG_ALBEDO_FROM_VERTEX_COLOR" value="3">
<constant name="FLAG_ALBEDO_FROM_VERTEX_COLOR" value="3" enum="Flags">
</constant>
<constant name="FLAG_SRGB_VERTEX_COLOR" value="4">
<constant name="FLAG_SRGB_VERTEX_COLOR" value="4" enum="Flags">
</constant>
<constant name="FLAG_USE_POINT_SIZE" value="5">
<constant name="FLAG_USE_POINT_SIZE" value="5" enum="Flags">
</constant>
<constant name="FLAG_FIXED_SIZE" value="6">
<constant name="FLAG_FIXED_SIZE" value="6" enum="Flags">
</constant>
<constant name="FLAG_UV1_USE_TRIPLANAR" value="7">
<constant name="FLAG_UV1_USE_TRIPLANAR" value="7" enum="Flags">
</constant>
<constant name="FLAG_UV2_USE_TRIPLANAR" value="8">
<constant name="FLAG_UV2_USE_TRIPLANAR" value="8" enum="Flags">
</constant>
<constant name="FLAG_AO_ON_UV2" value="10">
<constant name="FLAG_AO_ON_UV2" value="10" enum="Flags">
</constant>
<constant name="FLAG_USE_ALPHA_SCISSOR" value="11">
<constant name="FLAG_USE_ALPHA_SCISSOR" value="11" enum="Flags">
</constant>
<constant name="FLAG_TRIPLANAR_USE_WORLD" value="9">
<constant name="FLAG_TRIPLANAR_USE_WORLD" value="9" enum="Flags">
</constant>
<constant name="FLAG_MAX" value="12">
<constant name="FLAG_MAX" value="12" enum="Flags">
</constant>
<constant name="DIFFUSE_BURLEY" value="0">
<constant name="DIFFUSE_BURLEY" value="0" enum="DiffuseMode">
</constant>
<constant name="DIFFUSE_LAMBERT" value="1">
<constant name="DIFFUSE_LAMBERT" value="1" enum="DiffuseMode">
</constant>
<constant name="DIFFUSE_LAMBERT_WRAP" value="2">
<constant name="DIFFUSE_LAMBERT_WRAP" value="2" enum="DiffuseMode">
</constant>
<constant name="DIFFUSE_OREN_NAYAR" value="3">
<constant name="DIFFUSE_OREN_NAYAR" value="3" enum="DiffuseMode">
</constant>
<constant name="DIFFUSE_TOON" value="4">
<constant name="DIFFUSE_TOON" value="4" enum="DiffuseMode">
</constant>
<constant name="SPECULAR_SCHLICK_GGX" value="0">
<constant name="SPECULAR_SCHLICK_GGX" value="0" enum="SpecularMode">
</constant>
<constant name="SPECULAR_BLINN" value="1">
<constant name="SPECULAR_BLINN" value="1" enum="SpecularMode">
</constant>
<constant name="SPECULAR_PHONG" value="2">
<constant name="SPECULAR_PHONG" value="2" enum="SpecularMode">
</constant>
<constant name="SPECULAR_TOON" value="3">
<constant name="SPECULAR_TOON" value="3" enum="SpecularMode">
</constant>
<constant name="SPECULAR_DISABLED" value="4">
<constant name="SPECULAR_DISABLED" value="4" enum="SpecularMode">
</constant>
<constant name="BILLBOARD_DISABLED" value="0">
<constant name="BILLBOARD_DISABLED" value="0" enum="BillboardMode">
</constant>
<constant name="BILLBOARD_ENABLED" value="1">
<constant name="BILLBOARD_ENABLED" value="1" enum="BillboardMode">
</constant>
<constant name="BILLBOARD_FIXED_Y" value="2">
<constant name="BILLBOARD_FIXED_Y" value="2" enum="BillboardMode">
</constant>
<constant name="BILLBOARD_PARTICLES" value="3">
<constant name="BILLBOARD_PARTICLES" value="3" enum="BillboardMode">
</constant>
<constant name="TEXTURE_CHANNEL_RED" value="0">
<constant name="TEXTURE_CHANNEL_RED" value="0" enum="TextureChannel">
</constant>
<constant name="TEXTURE_CHANNEL_GREEN" value="1">
<constant name="TEXTURE_CHANNEL_GREEN" value="1" enum="TextureChannel">
</constant>
<constant name="TEXTURE_CHANNEL_BLUE" value="2">
<constant name="TEXTURE_CHANNEL_BLUE" value="2" enum="TextureChannel">
</constant>
<constant name="TEXTURE_CHANNEL_ALPHA" value="3">
<constant name="TEXTURE_CHANNEL_ALPHA" value="3" enum="TextureChannel">
</constant>
<constant name="TEXTURE_CHANNEL_GRAYSCALE" value="4">
<constant name="TEXTURE_CHANNEL_GRAYSCALE" value="4" enum="TextureChannel">
</constant>
<constant name="EMISSION_OP_ADD" value="0">
<constant name="EMISSION_OP_ADD" value="0" enum="EmissionOperator">
</constant>
<constant name="EMISSION_OP_MULTIPLY" value="1">
<constant name="EMISSION_OP_MULTIPLY" value="1" enum="EmissionOperator">
</constant>
</constants>
</class>

6
doc/classes/SplitContainer.xml
View file

@ -30,13 +30,13 @@
</signal>
</signals>
<constants>
<constant name="DRAGGER_VISIBLE" value="0">
<constant name="DRAGGER_VISIBLE" value="0" enum="DraggerVisibility">
The split dragger is visible.
</constant>
<constant name="DRAGGER_HIDDEN" value="1">
<constant name="DRAGGER_HIDDEN" value="1" enum="DraggerVisibility">
The split dragger is invisible.
</constant>
<constant name="DRAGGER_HIDDEN_COLLAPSED" value="2">
<constant name="DRAGGER_HIDDEN_COLLAPSED" value="2" enum="DraggerVisibility">
The split dragger is invisible and collapsed.
</constant>
</constants>

14
doc/classes/SpriteBase3D.xml
View file

@ -56,23 +56,23 @@
</member>
</members>
<constants>
<constant name="FLAG_TRANSPARENT" value="0">
<constant name="FLAG_TRANSPARENT" value="0" enum="DrawFlags">
If set, the texture's transparency and the opacity are used to make those parts of the Sprite invisible.
</constant>
<constant name="FLAG_SHADED" value="1">
<constant name="FLAG_SHADED" value="1" enum="DrawFlags">
If set, the Light in the Environment has effects on the Sprite.
</constant>
<constant name="FLAG_DOUBLE_SIDED" value="2">
<constant name="FLAG_DOUBLE_SIDED" value="2" enum="DrawFlags">
If set, texture can be seen from the back as well, if not, it is invisible when looking at it from behind.
</constant>
<constant name="FLAG_MAX" value="3">
<constant name="FLAG_MAX" value="3" enum="DrawFlags">
Used internally to mark the end of the Flags section.
</constant>
<constant name="ALPHA_CUT_DISABLED" value="0">
<constant name="ALPHA_CUT_DISABLED" value="0" enum="AlphaCutMode">
</constant>
<constant name="ALPHA_CUT_DISCARD" value="1">
<constant name="ALPHA_CUT_DISCARD" value="1" enum="AlphaCutMode">
</constant>
<constant name="ALPHA_CUT_OPAQUE_PREPASS" value="2">
<constant name="ALPHA_CUT_OPAQUE_PREPASS" value="2" enum="AlphaCutMode">
</constant>
</constants>
</class>

8
doc/classes/StreamPeerSSL.xml
View file

@ -48,16 +48,16 @@
</method>
</methods>
<constants>
<constant name="STATUS_DISCONNECTED" value="0">
<constant name="STATUS_DISCONNECTED" value="0" enum="Status">
A status representing a [code]StreamPeerSSL[/code] that is disconnected.
</constant>
<constant name="STATUS_CONNECTED" value="1">
<constant name="STATUS_CONNECTED" value="1" enum="Status">
A status representing a [code]StreamPeerSSL[/code] that is connected to a host.
</constant>
<constant name="STATUS_ERROR_NO_CERTIFICATE" value="2">
<constant name="STATUS_ERROR_NO_CERTIFICATE" value="2" enum="Status">
An errot status that shows the peer did not present a SSL certificate and validation was requested.
</constant>
<constant name="STATUS_ERROR_HOSTNAME_MISMATCH" value="3">
<constant name="STATUS_ERROR_HOSTNAME_MISMATCH" value="3" enum="Status">
An error status that shows a mismatch in the SSL certificate domain presented by the host and the domain requested for validation.
</constant>
</constants>

8
doc/classes/StreamPeerTCP.xml
View file

@ -58,16 +58,16 @@
</method>
</methods>
<constants>
<constant name="STATUS_NONE" value="0">
<constant name="STATUS_NONE" value="0" enum="Status">
The initial status of the [code]StreamPeerTCP[/code], also the status after a disconnect.
</constant>
<constant name="STATUS_CONNECTING" value="1">
<constant name="STATUS_CONNECTING" value="1" enum="Status">
A status representing a [code]StreamPeerTCP[/code] that is connecting to a host.
</constant>
<constant name="STATUS_CONNECTED" value="2">
<constant name="STATUS_CONNECTED" value="2" enum="Status">
A status representing a [code]StreamPeerTCP[/code] that is connected to a host.
</constant>
<constant name="STATUS_ERROR" value="3">
<constant name="STATUS_ERROR" value="3" enum="Status">
A staus representing a [code]StreamPeerTCP[/code] in error state.
</constant>
</constants>

6
doc/classes/StyleBoxTexture.xml
View file

@ -73,11 +73,11 @@
</signal>
</signals>
<constants>
<constant name="AXIS_STRETCH_MODE_STRETCH" value="0">
<constant name="AXIS_STRETCH_MODE_STRETCH" value="0" enum="AxisStretchMode">
</constant>
<constant name="AXIS_STRETCH_MODE_TILE" value="1">
<constant name="AXIS_STRETCH_MODE_TILE" value="1" enum="AxisStretchMode">
</constant>
<constant name="AXIS_STRETCH_MODE_TILE_FIT" value="2">
<constant name="AXIS_STRETCH_MODE_TILE_FIT" value="2" enum="AxisStretchMode">
</constant>
</constants>
</class>

Some files were not shown because too many files have changed in this diff Show more