diff options
Diffstat (limited to 'doc/classes')
| -rw-r--r-- | doc/classes/AStar2D.xml | 24 | ||||
| -rw-r--r-- | doc/classes/InputEventMouseMotion.xml | 3 | ||||
| -rw-r--r-- | doc/classes/VisibilityEnabler.xml | 1 | ||||
| -rw-r--r-- | doc/classes/VisibilityEnabler2D.xml | 1 |
4 files changed, 28 insertions, 1 deletions
diff --git a/doc/classes/AStar2D.xml b/doc/classes/AStar2D.xml index 2639f62552..16fa05041e 100644 --- a/doc/classes/AStar2D.xml +++ b/doc/classes/AStar2D.xml @@ -9,6 +9,30 @@ <tutorials> </tutorials> <methods> + <method name="_compute_cost" qualifiers="virtual"> + <return type="float"> + </return> + <argument index="0" name="from_id" type="int"> + </argument> + <argument index="1" name="to_id" type="int"> + </argument> + <description> + Called when computing the cost between two connected points. + Note that this function is hidden in the default [code]AStar2D[/code] class. + </description> + </method> + <method name="_estimate_cost" qualifiers="virtual"> + <return type="float"> + </return> + <argument index="0" name="from_id" type="int"> + </argument> + <argument index="1" name="to_id" type="int"> + </argument> + <description> + Called when estimating the cost between a point and the path's ending point. + Note that this function is hidden in the default [code]AStar2D[/code] class. + </description> + </method> <method name="add_point"> <return type="void"> </return> diff --git a/doc/classes/InputEventMouseMotion.xml b/doc/classes/InputEventMouseMotion.xml index 1549353d45..97b9d5247a 100644 --- a/doc/classes/InputEventMouseMotion.xml +++ b/doc/classes/InputEventMouseMotion.xml @@ -16,7 +16,8 @@ Represents the pressure the user puts on the pen. Ranges from [code]0.0[/code] to [code]1.0[/code]. </member> <member name="relative" type="Vector2" setter="set_relative" getter="get_relative" default="Vector2( 0, 0 )"> - The mouse position relative to the previous position (position at the last frame). + The mouse position relative to the previous position (position at the last frame). + [b]Note:[/b] Since [InputEventMouseMotion] is only emitted when the mouse moves, the last event won't have a relative position of [code]Vector2(0, 0)[/code] when the user stops moving the mouse. </member> <member name="speed" type="Vector2" setter="set_speed" getter="get_speed" default="Vector2( 0, 0 )"> The mouse speed in pixels per second. diff --git a/doc/classes/VisibilityEnabler.xml b/doc/classes/VisibilityEnabler.xml index 82b952fda6..7ab6c52e6c 100644 --- a/doc/classes/VisibilityEnabler.xml +++ b/doc/classes/VisibilityEnabler.xml @@ -5,6 +5,7 @@ </brief_description> <description> The VisibilityEnabler will disable [RigidBody] and [AnimationPlayer] nodes when they are not visible. It will only affect other nodes within the same scene as the VisibilityEnabler itself. + Note that VisibilityEnabler will not affect nodes added after scene initialization. </description> <tutorials> </tutorials> diff --git a/doc/classes/VisibilityEnabler2D.xml b/doc/classes/VisibilityEnabler2D.xml index 98c3e5d78d..3f9bf6887a 100644 --- a/doc/classes/VisibilityEnabler2D.xml +++ b/doc/classes/VisibilityEnabler2D.xml @@ -5,6 +5,7 @@ </brief_description> <description> The VisibilityEnabler2D will disable [RigidBody2D], [AnimationPlayer], and other nodes when they are not visible. It will only affect nodes with the same root node as the VisibilityEnabler2D, and the root node itself. + Note that VisibilityEnabler2D will not affect nodes added after scene initialization. </description> <tutorials> </tutorials> |