Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
Cooperative Cuisine Environment
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package registry
Container Registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Terms and privacy
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Social Cognitive Systems
CoCoSy
Cooperative Cuisine Environment
Commits
35afcd29
Commit
35afcd29
authored
10 months ago
by
Fabian Heinrich
Browse files
Options
Downloads
Patches
Plain Diff
Added missing docstrings to hooks
parent
d783e321
No related branches found
No related tags found
1 merge request
!96
More hook updates
Pipeline
#51798
passed
10 months ago
Stage: test
Changes
1
Pipelines
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
cooperative_cuisine/hooks.py
+12
-5
12 additions, 5 deletions
cooperative_cuisine/hooks.py
with
12 additions
and
5 deletions
cooperative_cuisine/hooks.py
+
12
−
5
View file @
35afcd29
...
...
@@ -171,6 +171,7 @@ Args:
on_hands (bool): if the picked up item is put on the free player hands (True) or on a cooking equipment (False).
return_this (Item | None): what will be put on the player (holding) - the new item / the item that was on the counter.
player (str): player id.
player_holding (Item): What the player was holding.
"""
PRE_PLATE_DISPENSER_PICK_UP
=
"
pre_plate_dispenser_pick_up
"
...
...
@@ -188,9 +189,9 @@ POST_PLATE_DISPENSER_PICK_UP = "post_plate_dispenser_pick_up"
Args:
counter (Counter): the counter from which to pick up.
on_hands (bool): if the picked up item is put on the free player hands (True) or on a cooking equipment (False).
return_this (Item | None): what will be put on the player (holding)
player (str): player id.
on_hands (bool): if the picked up item is put on the free player hands (True) or on a cooking equipment (False).
returned_item (Item | None): what will be put on the player (holding)
"""
PRE_COUNTER_DROP_OFF
=
"
pre_counter_drop_off
"
...
...
@@ -219,6 +220,7 @@ Args:
item (Item): the item to drop on the counter.
equipment (Item | None | deque[Item]): what is currently on the counter.
counter (Counter): the counter from which to drop off.
occupied_before (Item): What was on the counter before the drop off.
player (str): player id.
return_this (Item | None): what will be put on the player (holding)
"""
...
...
@@ -230,6 +232,7 @@ Args:
occupied_by (Item): What is now in the counter.
counter (Counter): the counter from which to pick up.
player (str): player id.
player_holding (Item): What the player was holding.
"""
...
...
@@ -261,8 +264,8 @@ Args:
counter (Counter): the counter from which to drop off.
player (str): player id.
item (Item): the item to drop on the counter.
return_this (Item | None): what will be put on the player (holding)
equipment (Item | None | deque[Item]): the cooking equipment that combined the items.
return_this (Item | None): what will be put on the player (holding)
"""
DISPENSER_ITEM_RETURNED
=
"
dispenser_item_returned
"
...
...
@@ -291,6 +294,7 @@ Args:
counter (Counter): the cutting board.
item (Item): the item that was chopped.
player (str): player id.
before: (Item): What the item was before.
"""
# --- items.py ---
...
...
@@ -304,7 +308,8 @@ PROGRESS_FINISHED = "progress_finished"
"""
Progress on a cooking equipment is finished. (Does not include fire.)
Args:
item (CookingEquipment): the cooking equipment that did the progress.
before (CookingEquipment): the cooking equipment before the progress.
item (CookingEquipment): the cooking equipment after the progress.
"""
...
...
@@ -380,6 +385,7 @@ DROP_ON_SINK_ADDON = "drop_on_sink_addon"
Args:
counter (SinkAddon): the target counter of the drop off.
item (Item): the item which is combined with the top plate.
occupied_by: (Item | None): What the sink addon is occupied by.
player (str): the player id.
"""
PICK_UP_FROM_SINK_ADDON
=
"
pick_up_from_sink_addon
"
...
...
@@ -399,6 +405,7 @@ Args:
counter (Sink): The sink on which the plate was cleaned.
player (str): the player id.
plate (Item): the plate that was cleaned.
plate_before (Item): the plate before cleaning.
"""
# --- items.py ---
...
...
@@ -415,8 +422,8 @@ CONTENT_READY = "content_ready"
"""
A meal is ready on a cooking equipment.
Args:
result (str): Name of the meal.
before (CookingEquipment): the cooking equipment.
result (str): Name of the meal.
"""
# --- orders.py ---
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment