diff options
Diffstat (limited to 'doc/classes/RayCast.xml')
| -rw-r--r-- | doc/classes/RayCast.xml | 78 |
1 files changed, 6 insertions, 72 deletions
diff --git a/doc/classes/RayCast.xml b/doc/classes/RayCast.xml index d5f57c43c8..20e262b664 100644 --- a/doc/classes/RayCast.xml +++ b/doc/classes/RayCast.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="RayCast" inherits="Spatial" category="Core" version="3.0-alpha"> +<class name="RayCast" inherits="Spatial" category="Core" version="3.0-beta"> <brief_description> Query the closest object intersecting a ray. </brief_description> @@ -47,13 +47,6 @@ Use this method to update the collision information immediately instead of waiting for the next [code]_physics_process[/code] call, for example if the ray or its parent has changed state. Note: [code]enabled == true[/code] is not required for this to work. </description> </method> - <method name="get_cast_to" qualifiers="const"> - <return type="Vector3"> - </return> - <description> - Return the destination point of this ray object. - </description> - </method> <method name="get_collider" qualifiers="const"> <return type="Object"> </return> @@ -78,19 +71,13 @@ [/codeblock] </description> </method> - <method name="get_collision_mask" qualifiers="const"> - <return type="int"> - </return> - <description> - Returns the collision mask for this ray. - </description> - </method> <method name="get_collision_mask_bit" qualifiers="const"> <return type="bool"> </return> <argument index="0" name="bit" type="int"> </argument> <description> + Returns [code]true[/code] if the bit index passed is turned on. Note that bit indexes range from 0-19. </description> </method> <method name="get_collision_normal" qualifiers="const"> @@ -107,13 +94,6 @@ Returns the collision point at which the ray intersects the closest object. Note: this point is in the [b]global[/b] coordinate system. </description> </method> - <method name="get_type_mask" qualifiers="const"> - <return type="int"> - </return> - <description> - Returns the type mask (types of objects to detect) for this ray. The value is a sum (bitwise OR'd) of constants available for [PhysicsDirectSpaceState]. - </description> - </method> <method name="is_colliding" qualifiers="const"> <return type="bool"> </return> @@ -121,13 +101,6 @@ Return whether the closest object the ray is pointing to is colliding with the vector (considering the vector length). </description> </method> - <method name="is_enabled" qualifiers="const"> - <return type="bool"> - </return> - <description> - Returns whether the ray is enabled or not. - </description> - </method> <method name="remove_exception"> <return type="void"> </return> @@ -146,24 +119,6 @@ Removes a collision exception so the ray does report collisions with the specified [RID]. </description> </method> - <method name="set_cast_to"> - <return type="void"> - </return> - <argument index="0" name="local_point" type="Vector3"> - </argument> - <description> - Sets the ray destination point, so that the ray will test from the ray's origin to [code]local_point[/code]. - </description> - </method> - <method name="set_collision_mask"> - <return type="void"> - </return> - <argument index="0" name="mask" type="int"> - </argument> - <description> - Set the mask to filter objects. Only objects in at least one collision layer enabled in the mask will be detected. - </description> - </method> <method name="set_collision_mask_bit"> <return type="void"> </return> @@ -172,24 +127,7 @@ <argument index="1" name="value" type="bool"> </argument> <description> - </description> - </method> - <method name="set_enabled"> - <return type="void"> - </return> - <argument index="0" name="enabled" type="bool"> - </argument> - <description> - Enables the RayCast2D. Only enabled raycasts will be able to query the space and report collisions. - </description> - </method> - <method name="set_type_mask"> - <return type="void"> - </return> - <argument index="0" name="mask" type="int"> - </argument> - <description> - Set the types of objects to detect. For [code]mask[/code] use a logic sum (OR operation) of constants defined in [PhysicsDirectSpaceState], eg. [code]PhysicsDirectSpaceState.TYPE_MASK_STATIC_BODY | PhysicsDirectSpaceState.TYPE_MASK_KINEMATIC_BODY[/code] to detect only those two types. + Sets the bit index passed to the [code]value[/code] passed. Note that bit indexes range from 0-19. </description> </method> </methods> @@ -201,14 +139,10 @@ The ray's collision mask. Only objects in at least one collision layer enabled in the mask will be detected. </member> <member name="enabled" type="bool" setter="set_enabled" getter="is_enabled"> - If [code]true[/code], collisions will be reported. Default value: [code]false[/code]. + If [code]true[/code] collisions will be reported. Default value: [code]false[/code]. </member> - <member name="type_mask" type="int" setter="set_type_mask" getter="get_type_mask"> - Object types to detect using a logical sum (OR operation) of type constants defined in [Physics2DDirectSpaceState]. - Example: - [codeblock] - RayCast.type_mask = Physics2DDirectSpaceState.TYPE_MASK_STATIC_BODY | Physics2DDirectSpaceState.TYPE_MASK_KINEMATIC_BODY - [/codeblock] + <member name="exclude_parent" type="bool" setter="set_exclude_parent_body" getter="get_exclude_parent_body"> + If [code]true[/code] collisions will be ignored for this RayCast's immediate parent. Default value: [code]true[/code]. </member> </members> <constants> |