Skip to content

Commit

Permalink
chore: updates docs
Browse files Browse the repository at this point in the history
  • Loading branch information
OctoD committed Oct 6, 2023
1 parent 2a3d242 commit 197e401
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ signal new_position_marked(position: Vector2)


@export_category("PointAndClick2D")
## Tells if the [code]PointAndClick2D[/code] is active.
## Activates the [PointAndClick2D].
@export var active: bool = true
## The movement speed
@export var movement_speed: float = 100.0
Expand All @@ -15,7 +15,7 @@ signal new_position_marked(position: Vector2)
## Is the [CharacterBody2D] child [NavigationAgent2D].
## Is used to determine the path in the world.
@export var navigation_agent: NavigationAgent2D = null
## If set to [code]true[/code] the [code]PointAndClick2D[/code] will move the [code]CharacterBody2D[/code] automatically.
## If set to [code]true[/code] the [code]PointAndClick2D[/code] will move the [CharacterBody2D] automatically.
@export var automatic_movement: bool = true


Expand Down Expand Up @@ -82,7 +82,6 @@ func set_new_movement_position() -> void:
new_position_marked.emit(navigation_agent.target_position)



## Stops the [code]navigation_agent[/code] movement.
func stop_movement() -> void:
if can_move():
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ signal new_position_marked(position: Vector3)


@export_category("PointAndClick3D")
## Tells if the [code]PointAndClick3D[/code] is active.
## Activates the [PointAndClick3D].
@export var active: bool = true
## The movement speed
@export var movement_speed: float = 100.0
Expand All @@ -16,7 +16,7 @@ signal new_position_marked(position: Vector3)
## Is the [CharacterBody3D] child [NavigationAgent3D].
## Is used to determine the path in the world.
@export var navigation_agent: NavigationAgent3D = null
## If set to [code]true[/code] the [code]PointAndClick3D[/code] will move the [code]CharacterBody3D[/code] automatically.
## If set to [code]true[/code] the [PointAndClick3D] will move the [CharacterBody3D] automatically.
@export var automatic_movement: bool = true

@export_flags_3d_physics var clickable_layer: int = 1
Expand Down Expand Up @@ -69,7 +69,7 @@ func is_navigation_finished() -> bool:
return false


## Moves the [code]CharacterBody3D[/code] to the clicked position.
## Moves the [CharacterBody3D] to the clicked position.
func move_to_clicked_position() -> void:
if Engine.is_editor_hint():
return
Expand Down Expand Up @@ -106,5 +106,6 @@ func set_new_movement_position() -> void:
new_position_marked.emit(target_position)


## Stops the [code]navigation_agent[/code] movement.
func stop_movement() -> void:
navigation_agent.target_position = character_3d.position

0 comments on commit 197e401

Please sign in to comment.