Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: investigate and document Actions, Behaviors, and Components #86

Draft
wants to merge 3 commits into
base: develop
Choose a base branch
from
Draft

docs: investigate and document Actions, Behaviors, and Components #86

wants to merge 3 commits into from

Conversation

skaldarnar
Copy link
Contributor

@skaldarnar skaldarnar commented Jan 12, 2022 •
edited

Investigate the different actions, behaviors, components and systems to figure out how things are supposed to work together.
The overall goal of this excercise is to get enough understanding of the internals to port it over to https://github.com/Terasology/FlexiblePathfinding.

  • docs: docstrings and TODOs for FindNearbyPlayersSystem
  • docs: docstrings and TODOs for MoveTo action and MinionMoveComponent
  • docs: investigate actions for moving along a path

@skaldarnar skaldarnar added Category: Doc Requests, Issues and Changes targeting javadoc and module documentation Topic: Stabilization Requests, Issues and Changes related to improving stablity and reducing flakyness labels Jan 12, 2022
@skaldarnar skaldarnar changed the title docs/describe actions components behaviors docs: investigate and document Actions, Behaviors, and Components Jan 12, 2022
@jdrueckert
Copy link
Member

jdrueckert commented Jan 12, 2022 •
edited

Behaviors currently in use (and behaviors and actions they reference)
Behaviors currently in use:

  • (Behaviors:aggressiveCritter)
    • Behaviors:hostile (behavior)
    • Behaviors:stray (behavior)
  • (Behaviors:attackFollowedEntity)
    • Behaviors:continue_following_check (action)
    • Behaviors:set_target_to_followed_entity (action)
    • Behaviors:move_to (action)
    • Behaviors:stop_moving (action)
    • Behaviors:damage_followed_entity (action)
  • Behaviors:critter
    • Behaviors:check_flee_stop (action)
    • Behaviors:flee (behavior)
    • Behaviors:stray (behavior)
  • Behaviors:doBuildBlock
    • Behaviors:find_work (action)
    • Behaviors:moveToWork (behavior)
    • Behaviors:finish_work (action)
    • Behaviors:jump (action)
  • Behaviors:doRandomMove
    • Behaviors:set_target_nearby_block (action)
    • Behaviors:move_to (action)
  • Behaviors:doRemoveBlock
    • Behaviors:find_work (action)
    • Behaviors:moveToWork (behavior)
    • Behaviors:finish_work (action)
  • Behaviors:doWalkTo
    • Behaviors:find_work (action)
    • Behaviors:moveToWork (behavior)
    • Behaviors:finish_work (action)
  • Behaviors:flee
    • Behaviors:set_target_nearby_block_away_from_instigator (action)
    • Behaviors:move_to (action)
  • Behaviors:follow
    • Behaviors:continue_following_check (action)
    • Behaviors:set_target_to_followed_entity (action)
    • Behaviors:move_to (action)
  • (Behaviors:friendlyCritter)
    • Behaviors:followCharacter (action)
    • Behaviors:follow (behavior)
    • Behaviors:stray (behavior)
  • (Behaviors:hostile)
    • Behaviors:check_attack_stop (action)
    • Behaviors:attackFollowedEntity (behavior)
  • Behaviors:hostileCritter
    • Behaviors:followCharacter (action)
    • Behaviors:hostile (behavior)
    • Behaviors:stray (behavior)
  • Behaviors:moveToWork
    • Behaviors:set_target_work (action)
    • Behaviors:move_to (action)
  • Behaviors:restrictedStray
    • Behaviors:set_target_nearby_block_restricted (action)
    • Behaviors:move_to (action)
  • (Behaviors:scaredCritter)
    • Behaviors:flee_from_character (action)
    • Behaviors:flee (behavior)
    • Behaviors:stray (behavior)
  • Behaviors:stray
    • Behaviors:doRandomMove (behavior)
  • (Behaviors:territorialCritter)
    • Behaviors:set_target_nearby_player (action)
    • Behaviors:hostile (behavior)
    • Behaviors:stray (behavior)
    • Behaviors:set_target_territory (action)
    • Behaviors:move_to (action)
  • Behaviors:worker
    • Behaviors:doWalkTo (behavior)
    • Behaviors:doBuildBlock (behavior)
    • Behaviors:doRemoveBlock (behavior)
  • GooeysQuests:gooey
    • Behaviors:follow (behavior)
    • Behaviors:stop_moving (action)
  • (GooKeeper:doRandomMove)
    • Behaviors:set_target_nearby_block (action)
    • Behaviors:move_to (action)
  • (GooKeeper:follow)
    • Behaviors:continue_following_check (action)
    • Behaviors:set_target_to_followed_entity (action)
    • Behaviors:move_to (action)
  • (GooKeeper:gooey)
    • GooKeeper:CheckStunStatus (action)
    • GooKeeper:BeginBreeding (action)
    • GooKeeper:CheckFollowStatus (action)
    • GooKeeper:hostile (behavior)
    • GooKeeper:follow (behavior)
    • GooKeeper:stray (behavior)
  • (GooKeeper:hostile)
    • GooKeeper:CheckAttackStop (action)
    • Behaviors:attackFollowedEntity (behavior)
  • (GooKeeper:stray)
    • GooKeeper:doRandomMove (behavior)
  • (GooKeeper:visitor)
    • GooKeeper:set_target_to_visit_block (action)
    • Behaviors:ensure_target_present (action)
    • Behaviors:move_to (action)
    • GooKeeper:observe_gooey (action)
    • GooKeeper:visitor_exit (action)
  • LightAndShadowResources:attackRed (doesn't exist anymore)
  • LightAndShadowResources:attackBlack (doesn't exist anymore)
  • MasterOfOreon:advancedTasksForOreon
    • MasterOfOreon:needs_food (action)
    • MasterOfOreon:needs_training (action)
    • MasterOfOreon:needs_sleep (action)
  • MasterOfOreon:build == MasterOfOreon:plant (behavior)
  • MasterOfOreon:eat
    • MasterOfOreon:check_required_resources (action)
    • MasterOfOreon:check_task_status (action)
    • Behaviors:move_to (action)
    • MasterOfOreon:perform_task (action)
  • MasterOfOreon:getBlocksFromChest
    • MasterOfOreon:check_task_status (action)
    • Behaviors:move_to (action)
    • MasterOfOreon:get_blocks_from_chest (action)
    • MasterOfOreon:perform_task (action)
  • MasterOfOreon:guard
    • MasterOfOreon:find_next_block_on_boundary (action)
    • Behaviors:move_to (action)
    • MasterOfOreon:perform_task (action)
  • MasterOfOreon:harvest
    • MasterOfOreon:check_task_status (action)
    • Behaviors:move_to (action)
    • MasterOfOreon:add_crop_transfer_to_storage_task (action)
    • MasterOfOreon:perform_task (action)
  • MasterOfOreon:placeBlocksInChest
    • MasterOfOreon:check_task_status (action)
    • Behaviors:move_to (action)
    • MasterOfOreon:place_blocks_in_chest (action)
    • MasterOfOreon:perform_task (action)
  • MasterOfOreon:plant
    • MasterOfOreon:check_task_status (action)
    • Behaviors:move_to (action)
    • MasterOfOreon:perform_task (action)
  • MasterOfOreon:research == MasterOfOreon:eat (behavior)
  • MasterOfOreon:taskAcquiringOreon
    • Behaviors:critter (behavior)
    • MasterOfOreon:look_for_task (action)
    • MasterOfOreon:advancedTasksForOreon (behavior)
    • Behaviors:set_speed (action)
    • Behaviors:find_path (action)
    • Behaviors:move_along_path (action)
    • Behaviors:move_to (action)
    • MasterOfOreon:plant (behavior)
    • MasterOfOreon:build (behavior)
    • MasterOfOreon:guard (behavior)
    • MasterOfOreon:upgrade (behavior)
    • MasterOfOreon:eat (behavior)
    • MasterOfOreon:research (behavior)
    • MasterOfOreon:harvest (behavior)
    • MasterOfOreon:placeBlocksInChest (behavior)
    • MasterOfOreon:getBlocksFromChest (behavior)
  • MasterOfOreon:upgrade == MasterOfOreon:plant (behavior)
  • MetalRenegades:citizen
    • MetalRenegades:set_target_to_enemy (action)
    • Behaviors:hostile (behavior)
    • MetalRenegades:check_need (action)
    • Behaviors:check_nighttime (action)
    • MetalRenegades:returnHome (behavior)
    • Behaviors:stray (behavior)
  • MetalRenegades:enemyHostile
    • MetalRenegades:inside_city_check (action)
    • Behaviors:flee_from_character (action)
    • Behaviors:flee (behavior)
    • Behaviors:followCharacter (action)
    • Behaviors:hostile (behavior)
    • Behaviors:stray (behavior)
  • MetalRenegades:returnHome
    • Behaviors:set_speed (action)
    • MetalRenegades:set_target_to_home (action)
    • Behaviors:move_to (action)
  • WildAnimals:lure
    • WildAnimals:check_luring_item_in_use (action)
    • Behaviors:followCharacter (action)
    • Behaviors:follow (behavior)
    • Behaviors:stray (behavior)
  • WildAnimals:still
  • (WildAnimalsGenome:mate)
    • WildAnimalsGenome:set_mating_target_block (action)
    • Behaviors:ensure_target_present (action)
    • Behaviors:move_to (action)
  • (WildAnimalsGenome:matingCritter)
    • Behaviors:set_target_nearby_block (action)
    • WildAnimalsGenome:mate (behavior)
    • Behaviors:critter (behavior)

@jdrueckert
Copy link
Member

jdrueckert commented Jan 13, 2022 •
edited

Actions currently in use:

  • (Behaviors:check_attack_stop)
  • Behaviors:check_flee_stop
  • Behaviors:check_nighttime
  • Behaviors:continue_following_check
  • Behaviors:damage_followed_entity
  • (Behaviors:ensure_target_present)
  • Behaviors:find_path
  • Behaviors:find_work
  • Behaviors:finish_work
  • Behaviors:flee_from_character
  • Behaviors:followCharacter
  • Behaviors:jump
  • Behaviors:move_along_path
  • Behaviors:move_to
  • Behaviors:set_speed
  • Behaviors:set_target_nearby_block
  • Behaviors:set_target_nearby_block_away_from_instigator
  • Behaviors:set_target_nearby_block_restricted
  • Behaviors:set_target_nearby_player
  • Behaviors:set_target_territory
  • Behaviors:set_target_to_followed_entity
  • Behaviors:set_target_work
  • Behaviors:stop_moving
  • (GooKeeper:BeginBreeding)
  • (GooKeeper:CheckAttackStop)
  • (GooKeeper:CheckFollowStatus)
  • (GooKeeper:CheckStunStatus)
  • (GooKeeper:observe_gooey)
  • (GooKeeper:set_target_to_visit_block)
  • (GooKeeper:visitor_exit)
  • MasterOfOreon:add_crop_transfer_to_storage_task
  • MasterOfOreon:check_required_resources
  • MasterOfOreon:check_task_status
  • MasterOfOreon:find_next_block_on_boundary
  • MasterOfOreon:get_blocks_from_chest
  • MasterOfOreon:look_for_task
  • MasterOfOreon:needs_food
  • MasterOfOreon:needs_training
  • MasterOfOreon:needs_sleep
  • MasterOfOreon:perform_task
  • MasterOfOreon:place_blocks_in_chest
  • MetalRenegades:check_need
  • MetalRenegades:inside_city_check
  • MetalRenegades:set_target_to_enemy
  • MetalRenegades:set_target_to_home
  • WildAnimals:check_luring_item_in_use
  • (WildAnimalsGenome:set_mating_target_block)

@skaldarnar skaldarnar marked this pull request as draft January 19, 2022 10:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jdrueckert jdrueckert Awaiting requested review from jdrueckert

@casals casals Awaiting requested review from casals

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
Category: Doc Requests, Issues and Changes targeting javadoc and module documentation Topic: Stabilization Requests, Issues and Changes related to improving stablity and reducing flakyness
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@skaldarnar @jdrueckert