[DOCS] Classref updates: Color, RigidBody*
This commit is contained in:
Chris Bradfield
parent
723e2e9654
commit
7bc11505b1
@ -4,8 +4,8 @@
|
||||
Color in RGBA format with some support for ARGB format.
|
||||
</brief_description>
|
||||
<description>
|
||||
A color is represented as red, green and blue (r,g,b) components. Additionally, "a" represents the alpha component, often used for transparency. Values are in floating point and usually range from 0 to 1. Some methods (such as set_modulate(color)) may accept values > 1.
|
||||
You can also create a color from standardised color names with Color.ColorN (e.g. Color.green) or [method @GDScript.ColorN].
|
||||
A color is represented by red, green, and blue [code](r, g, b)[/code] components. Additionally, [code]a[/code] represents the alpha component, often used for transparency. Values are in floating point and usually range from 0 to 1. Some properties (such as [member CanvasItem.modulate]) may accept values > 1.
|
||||
You can also create a color from standardized color names by using [method @GDScript.ColorN].
|
||||
</description>
|
||||
<tutorials>
|
||||
</tutorials>
|
||||
@ -25,7 +25,7 @@
|
||||
[code]"#ff00ff"[/code] - RGB format with '#'
|
||||
[code]"ff00ff"[/code] - RGB format
|
||||
[codeblock]
|
||||
# The following code creates the same color of an RGBA(178, 217, 10, 255)
|
||||
# Each of the following creates the same color RGBA(178, 217, 10, 255)
|
||||
var c1 = Color("#ffb2d90a") # ARGB format with '#'
|
||||
var c2 = Color("ffb2d90a") # ARGB format
|
||||
var c3 = Color("#b2d90a") # RGB format with '#'
|
||||
@ -41,7 +41,7 @@
|
||||
<description>
|
||||
Constructs a color from a 32-bit integer (each byte represents a component of the RGBA profile).
|
||||
[codeblock]
|
||||
var c = Color(274) # a color of an RGBA(0, 0, 1, 18)
|
||||
var c = Color(274) # Equivalent to RGBA(0, 0, 1, 18)
|
||||
[/codeblock]
|
||||
</description>
|
||||
</method>
|
||||
@ -55,9 +55,9 @@
|
||||
<argument index="2" name="b" type="float">
|
||||
</argument>
|
||||
<description>
|
||||
Constructs a color from an RGB profile using values between 0 and 1 (float). Alpha will always be 1.
|
||||
Constructs a color from an RGB profile using values between 0 and 1. Alpha will always be 1.
|
||||
[codeblock]
|
||||
var c = Color(0.2, 1.0, .7) # a color of an RGBA(51, 255, 178, 255)
|
||||
var c = Color(0.2, 1.0, .7) # Equivalent to RGBA(51, 255, 178, 255)
|
||||
[/codeblock]
|
||||
</description>
|
||||
</method>
|
||||
@ -73,9 +73,9 @@
|
||||
<argument index="3" name="a" type="float">
|
||||
</argument>
|
||||
<description>
|
||||
Constructs a color from an RGBA profile using values between 0 and 1 (float).
|
||||
Constructs a color from an RGBA profile using values between 0 and 1.
|
||||
[codeblock]
|
||||
var c = Color(0.2, 1.0, .7, .8) # a color of an RGBA(51, 255, 178, 204)
|
||||
var c = Color(0.2, 1.0, .7, .8) # Equivalent to RGBA(51, 255, 178, 204)
|
||||
[/codeblock]
|
||||
</description>
|
||||
</method>
|
||||
@ -85,7 +85,7 @@
|
||||
<argument index="0" name="over" type="Color">
|
||||
</argument>
|
||||
<description>
|
||||
Returns a new color resulting from blending this color over another color. If the color is opaque, the result would also be opaque. The other color could then take a range of values with different alpha values.
|
||||
Returns a new color resulting from blending this color over another. If the color is opaque, the result is also opaque. The second color may have a range of alpha values.
|
||||
[codeblock]
|
||||
var bg = Color(0.0, 1.0, 0.0, 0.5) # Green with alpha of 50%
|
||||
var fg = Color(1.0, 0.0, 0.0, .5) # Red with alpha of 50%
|
||||
@ -100,7 +100,7 @@
|
||||
Returns the most contrasting color.
|
||||
[codeblock]
|
||||
var c = Color(.3, .4, .9)
|
||||
var contrastedColor = c.contrasted() # a color of an RGBA(204, 229, 102, 255)
|
||||
var contrastedColor = c.contrasted() # Equivalent to RGBA(204, 229, 102, 255)
|
||||
[/codeblock]
|
||||
</description>
|
||||
</method>
|
||||
@ -131,7 +131,7 @@
|
||||
<description>
|
||||
Constructs a color from an HSV profile. [code]h[/code], [code]s[/code], and [code]v[/code] are values between 0 and 1.
|
||||
[codeblock]
|
||||
var c = Color.from_hsv(0.58, 0.5, 0.79, 0.8) # equivalent to HSV(210, 50, 79, 0.8) or Color8(100, 151, 201, 0.8)
|
||||
var c = Color.from_hsv(0.58, 0.5, 0.79, 0.8) # Equivalent to HSV(210, 50, 79, 0.8) or Color8(100, 151, 201, 0.8)
|
||||
[/codeblock]
|
||||
</description>
|
||||
</method>
|
||||
@ -139,8 +139,8 @@
|
||||
<return type="float">
|
||||
</return>
|
||||
<description>
|
||||
Returns the color's grayscale.
|
||||
The gray is calculated by (r + g + b) / 3.
|
||||
Returns the color's grayscale representation.
|
||||
The gray is calculated by [code](r + g + b) / 3[/code].
|
||||
[codeblock]
|
||||
var c = Color(0.2, 0.45, 0.82)
|
||||
var gray = c.gray() # a value of 0.466667
|
||||
@ -151,7 +151,7 @@
|
||||
<return type="Color">
|
||||
</return>
|
||||
<description>
|
||||
Returns the inverted color (1-r, 1-g, 1-b, 1-a).
|
||||
Returns the inverted color [code](1 - r, 1 - g, 1 - b, 1 - a)[/code].
|
||||
[codeblock]
|
||||
var c = Color(.3, .4, .9)
|
||||
var invertedColor = c.inverted() # a color of an RGBA(178, 153, 26, 255)
|
||||
@ -179,7 +179,7 @@
|
||||
<argument index="1" name="t" type="float">
|
||||
</argument>
|
||||
<description>
|
||||
Returns the color of the linear interpolation with another color. The value t is between 0 and 1 (float).
|
||||
Returns the linear interpolation with another color. The value t is between 0 and 1.
|
||||
[codeblock]
|
||||
var c1 = Color(1.0, 0.0, 0.0)
|
||||
var c2 = Color(0.0, 1.0, 0.0)
|
||||
@ -238,7 +238,7 @@
|
||||
</argument>
|
||||
<description>
|
||||
Returns the color's HTML hexadecimal color string in ARGB format (ex: [code]ff34f822[/code]).
|
||||
Optionally flag 'false' to not include alpha in hexadecimal string.
|
||||
Setting [code]with_alpha[/code] to [code]false[/code] excludes alpha from the hexadecimal string.
|
||||
[codeblock]
|
||||
var c = Color(1, 1, 1, .5)
|
||||
var s1 = c.to_html() # Results "7fffffff"
|
||||
@ -250,7 +250,7 @@
|
||||
<return type="int">
|
||||
</return>
|
||||
<description>
|
||||
Returns the color's 32-bit integer in RGBA format (each byte represents a component of the RGBA profile). RGBA is the format that Godot uses by default.
|
||||
Returns the color's 32-bit integer in RGBA format (each byte represents a component of the RGBA profile). RGBA is Godot's default format.
|
||||
[codeblock]
|
||||
var c = Color(1, .5, .2)
|
||||
print(c.to_rgba32()) # Prints 4286526463
|
||||
@ -261,7 +261,7 @@
|
||||
<return type="int">
|
||||
</return>
|
||||
<description>
|
||||
Returns the color's 64-bit integer in RGBA format (each word represents a component of the RGBA profile). RGBA is the format that Godot uses by default.
|
||||
Returns the color's 64-bit integer in RGBA format (each word represents a component of the RGBA profile). RGBA is Godot's default format.
|
||||
[codeblock]
|
||||
var c = Color(1, .5, .2)
|
||||
print(c.to_rgba64()) # Prints -140736629309441
|
||||
@ -271,37 +271,37 @@
|
||||
</methods>
|
||||
<members>
|
||||
<member name="a" type="float" setter="" getter="">
|
||||
Alpha (0 to 1)
|
||||
Alpha value (range 0 to 1).
|
||||
</member>
|
||||
<member name="a8" type="int" setter="" getter="">
|
||||
Alpha (0 to 255)
|
||||
Alpha value (range 0 to 255).
|
||||
</member>
|
||||
<member name="b" type="float" setter="" getter="">
|
||||
Blue (0 to 1)
|
||||
Blue value (range 0 to 1).
|
||||
</member>
|
||||
<member name="b8" type="int" setter="" getter="">
|
||||
Blue (0 to 255)
|
||||
Blue value (range 0 to 255).
|
||||
</member>
|
||||
<member name="g" type="float" setter="" getter="">
|
||||
Green (0 to 1)
|
||||
Green value (range 0 to 1).
|
||||
</member>
|
||||
<member name="g8" type="int" setter="" getter="">
|
||||
Green (0 to 255)
|
||||
Green value (range 0 to 255).
|
||||
</member>
|
||||
<member name="h" type="float" setter="" getter="">
|
||||
Hue (0 to 1)
|
||||
HSV hue value (range 0 to 1).
|
||||
</member>
|
||||
<member name="r" type="float" setter="" getter="">
|
||||
Red (0 to 1)
|
||||
Red value (range 0 to 1).
|
||||
</member>
|
||||
<member name="r8" type="int" setter="" getter="">
|
||||
Red (0 to 255)
|
||||
Red value (range 0 to 255).
|
||||
</member>
|
||||
<member name="s" type="float" setter="" getter="">
|
||||
Saturation (0 to 1)
|
||||
HSV saturation value (range 0 to 1).
|
||||
</member>
|
||||
<member name="v" type="float" setter="" getter="">
|
||||
Value (0 to 1)
|
||||
HSV value (range 0 to 1).
|
||||
</member>
|
||||
</members>
|
||||
<constants>
|
||||
|
||||
@ -60,8 +60,8 @@
|
||||
<argument index="0" name="impulse" type="Vector3">
|
||||
</argument>
|
||||
<description>
|
||||
Applies a single directional impulse without affecting rotation.
|
||||
This is equivalent to ``apply_impulse(Vector3(0,0,0), impulse)``.
|
||||
Applies a directional impulse without affecting rotation.
|
||||
This is equivalent to [code]apply_impulse(Vector3(0,0,0), impulse)[/code].
|
||||
</description>
|
||||
</method>
|
||||
<method name="apply_impulse">
|
||||
@ -72,7 +72,7 @@
|
||||
<argument index="1" name="impulse" type="Vector3">
|
||||
</argument>
|
||||
<description>
|
||||
Apply a positioned impulse (which will be affected by the body mass and shape). This is the equivalent of hitting a billiard ball with a cue: a force that is applied once, and only once. Both the impulse and the position are in global coordinates, and the position is relative to the object's origin.
|
||||
Applies a positioned impulse which will be affected by the body mass and shape. This is the equivalent of hitting a billiard ball with a cue: a force that is applied once, and only once. Both the impulse and the position are in global coordinates, and the position is relative to the object's origin.
|
||||
</description>
|
||||
</method>
|
||||
<method name="apply_torque_impulse">
|
||||
@ -81,7 +81,7 @@
|
||||
<argument index="0" name="impulse" type="Vector3">
|
||||
</argument>
|
||||
<description>
|
||||
Apply a torque impulse (which will be affected by the body mass and shape). This will rotate the body around the passed in vector.
|
||||
Applies a torque impulse which will be affected by the body mass and shape. This will rotate the body around the passed in vector.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_colliding_bodies" qualifiers="const">
|
||||
@ -97,7 +97,7 @@
|
||||
<argument index="0" name="axis_velocity" type="Vector3">
|
||||
</argument>
|
||||
<description>
|
||||
Set an axis velocity. The velocity in the given vector axis will be set as the given vector length. This is useful for jumping behavior.
|
||||
Sets an axis velocity. The velocity in the given vector axis will be set as the given vector length. This is useful for jumping behavior.
|
||||
</description>
|
||||
</method>
|
||||
</methods>
|
||||
@ -109,16 +109,22 @@
|
||||
RigidBody's rotational velocity.
|
||||
</member>
|
||||
<member name="axis_lock_angular_x" type="bool" setter="set_axis_lock" getter="get_axis_lock">
|
||||
Lock the body's rotation in the x-axis.
|
||||
</member>
|
||||
<member name="axis_lock_angular_y" type="bool" setter="set_axis_lock" getter="get_axis_lock">
|
||||
Lock the body's rotation in the y-axis.
|
||||
</member>
|
||||
<member name="axis_lock_angular_z" type="bool" setter="set_axis_lock" getter="get_axis_lock">
|
||||
Lock the body's rotation in the z-axis.
|
||||
</member>
|
||||
<member name="axis_lock_linear_x" type="bool" setter="set_axis_lock" getter="get_axis_lock">
|
||||
Lock the body's movement in the x-axis.
|
||||
</member>
|
||||
<member name="axis_lock_linear_y" type="bool" setter="set_axis_lock" getter="get_axis_lock">
|
||||
Lock the body's movement in the x-axis.
|
||||
</member>
|
||||
<member name="axis_lock_linear_z" type="bool" setter="set_axis_lock" getter="get_axis_lock">
|
||||
Lock the body's movement in the x-axis.
|
||||
</member>
|
||||
<member name="bounce" type="float" setter="set_bounce" getter="get_bounce">
|
||||
RigidBody's bounciness.
|
||||
@ -127,7 +133,7 @@
|
||||
If [code]true[/code] the RigidBody will not calculate forces and will act as a static body while there is no movement. It will wake up when forces are applied through other collisions or when the [code]apply_impulse[/code] method is used.
|
||||
</member>
|
||||
<member name="contact_monitor" type="bool" setter="set_contact_monitor" getter="is_contact_monitor_enabled">
|
||||
If true, the RigidBody will emit signals when it collides with another RigidBody.
|
||||
If [code]true[/code] the RigidBody will emit signals when it collides with another RigidBody.
|
||||
</member>
|
||||
<member name="contacts_reported" type="int" setter="set_max_contacts_reported" getter="get_max_contacts_reported">
|
||||
The maximum contacts to report. Bodies can keep a log of the contacts with other bodies, this is enabled by setting the maximum amount of contacts reported to a number greater than 0.
|
||||
@ -140,19 +146,19 @@
|
||||
If [code]true[/code] internal force integration will be disabled (like gravity or air friction) for this body. Other than collision response, the body will only move as determined by the [method _integrate_forces] function, if defined.
|
||||
</member>
|
||||
<member name="friction" type="float" setter="set_friction" getter="get_friction">
|
||||
The body friction, from 0 (frictionless) to 1 (max friction).
|
||||
The body's friction, from 0 (frictionless) to 1 (max friction).
|
||||
</member>
|
||||
<member name="gravity_scale" type="float" setter="set_gravity_scale" getter="get_gravity_scale">
|
||||
This is multiplied by the global 3D gravity setting found in "Project > Project Settings > Physics > 3d" to produce RigidBody's gravity. E.g. a value of 1 will be normal gravity, 2 will apply double gravity, and 0.5 will apply half gravity to this object.
|
||||
</member>
|
||||
<member name="linear_damp" type="float" setter="set_linear_damp" getter="get_linear_damp">
|
||||
RigidBody's linear damp. Default value: -1, cannot be less than -1. If this value is different from -1, any linear damp derived from the world or areas will be overridden.
|
||||
The body's linear damp. Default value: -1, cannot be less than -1. If this value is different from -1, any linear damp derived from the world or areas will be overridden.
|
||||
</member>
|
||||
<member name="linear_velocity" type="Vector3" setter="set_linear_velocity" getter="get_linear_velocity">
|
||||
RigidBody's linear velocity. Can be used sporadically, but [b]DON'T SET THIS IN EVERY FRAME[/b], because physics may run in another thread and runs at a different granularity. Use [method _integrate_forces] as your process loop for precise control of the body state.
|
||||
The body's linear velocity. Can be used sporadically, but [b]DON'T SET THIS IN EVERY FRAME[/b], because physics may run in another thread and runs at a different granularity. Use [method _integrate_forces] as your process loop for precise control of the body state.
|
||||
</member>
|
||||
<member name="mass" type="float" setter="set_mass" getter="get_mass">
|
||||
RigidBody's mass.
|
||||
The body's mass.
|
||||
</member>
|
||||
<member name="mode" type="int" setter="set_mode" getter="get_mode" enum="RigidBody.Mode">
|
||||
The body mode from the MODE_* enum. Modes include: MODE_STATIC, MODE_KINEMATIC, MODE_RIGID, and MODE_CHARACTER.
|
||||
@ -160,10 +166,10 @@
|
||||
<member name="physics_material_override" type="PhysicsMaterial" setter="set_physics_material_override" getter="get_physics_material_override">
|
||||
</member>
|
||||
<member name="sleeping" type="bool" setter="set_sleeping" getter="is_sleeping">
|
||||
If [code]true[/code] RigidBody is sleeping and will not calculate forces until woken up by a collision or the [code]apply_impulse[/code] method.
|
||||
If [code]true[/code] the body is sleeping and will not calculate forces until woken up by a collision or the [code]apply_impulse[/code] method.
|
||||
</member>
|
||||
<member name="weight" type="float" setter="set_weight" getter="get_weight">
|
||||
RigidBody's weight based on its mass and the global 3D gravity. Global values are set in "Project > Project Settings > Physics > 3d".
|
||||
The body's weight based on its mass and the global 3D gravity. Global values are set in "Project > Project Settings > Physics > 3d".
|
||||
</member>
|
||||
</members>
|
||||
<signals>
|
||||
@ -217,16 +223,16 @@
|
||||
</signals>
|
||||
<constants>
|
||||
<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.
|
||||
Rigid body mode. 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" enum="Mode">
|
||||
Static mode. The body behaves like a [StaticBody], and can only move by user code.
|
||||
</constant>
|
||||
<constant name="MODE_CHARACTER" value="2" enum="Mode">
|
||||
Character body. This behaves like a rigid body, but can not rotate.
|
||||
Character body mode. This behaves like a rigid body, but can not rotate.
|
||||
</constant>
|
||||
<constant name="MODE_KINEMATIC" value="3" enum="Mode">
|
||||
Kinematic body. The body behaves like a [KinematicBody], and can only move by user code.
|
||||
Kinematic body mode. The body behaves like a [KinematicBody], and can only move by user code.
|
||||
</constant>
|
||||
</constants>
|
||||
</class>
|
||||
|
||||
@ -29,6 +29,7 @@
|
||||
<argument index="0" name="force" type="Vector2">
|
||||
</argument>
|
||||
<description>
|
||||
Adds a constant directional force without affecting rotation.
|
||||
</description>
|
||||
</method>
|
||||
<method name="add_force">
|
||||
@ -48,6 +49,7 @@
|
||||
<argument index="0" name="torque" type="float">
|
||||
</argument>
|
||||
<description>
|
||||
Adds a constant rotational force.
|
||||
</description>
|
||||
</method>
|
||||
<method name="apply_central_impulse">
|
||||
@ -56,6 +58,7 @@
|
||||
<argument index="0" name="impulse" type="Vector2">
|
||||
</argument>
|
||||
<description>
|
||||
Applies a directional impulse without affecting rotation.
|
||||
</description>
|
||||
</method>
|
||||
<method name="apply_impulse">
|
||||
@ -75,6 +78,7 @@
|
||||
<argument index="0" name="torque" type="float">
|
||||
</argument>
|
||||
<description>
|
||||
Applies a rotational impulse to the body.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_colliding_bodies" qualifiers="const">
|
||||
|
||||
Loading…
Reference in New Issue
Block a user