mirror of
https://github.com/illiumst/marl-factory-grid.git
synced 2025-05-22 14:56:43 +02:00
64 lines
2.8 KiB
Python
64 lines
2.8 KiB
Python
from typing import Union
|
|
|
|
from marl_factory_grid.environment.actions import Action
|
|
from marl_factory_grid.utils.results import ActionResult
|
|
|
|
from marl_factory_grid.modules.items import constants as i
|
|
from marl_factory_grid.environment import constants as c
|
|
|
|
|
|
class ItemAction(Action):
|
|
|
|
def __init__(self, failed_dropoff_reward: float | None = None, valid_dropoff_reward: float | None = None, **kwargs):
|
|
"""
|
|
Allows an entity to pick up or drop off items in the environment.
|
|
|
|
:param failed_drop_off_reward: The reward assigned when a drop-off action fails. Default is None.
|
|
:type failed_dropoff_reward: float | None
|
|
:param valid_drop_off_reward: The reward assigned when a drop-off action is successful. Default is None.
|
|
:type valid_dropoff_reward: float | None
|
|
"""
|
|
super().__init__(i.ITEM_ACTION, i.REWARD_PICK_UP_FAIL, i.REWARD_PICK_UP_VALID, **kwargs)
|
|
self.failed_drop_off_reward = failed_dropoff_reward if failed_dropoff_reward is not None else i.REWARD_DROP_OFF_FAIL
|
|
self.valid_drop_off_reward = valid_dropoff_reward if valid_dropoff_reward is not None else i.REWARD_DROP_OFF_VALID
|
|
|
|
def get_dropoff_result(self, validity, entity) -> ActionResult:
|
|
"""
|
|
Generates an ActionResult for a drop-off action based on its validity.
|
|
|
|
:param validity: Whether the drop-off action is valid.
|
|
:type validity: bool
|
|
|
|
:param entity: The entity performing the action.
|
|
:type entity: Entity
|
|
|
|
:return: ActionResult for the drop-off action.
|
|
:rtype: ActionResult
|
|
"""
|
|
reward = self.valid_drop_off_reward if validity else self.failed_drop_off_reward
|
|
return ActionResult(self.__class__.__name__, validity, reward=reward, entity=entity)
|
|
|
|
def do(self, entity, state) -> Union[None, ActionResult]:
|
|
inventory = state[i.INVENTORY].by_entity(entity)
|
|
if drop_off := state[i.DROP_OFF].by_pos(entity.pos):
|
|
if inventory:
|
|
valid = drop_off.place_item(inventory.pop())
|
|
else:
|
|
valid = c.NOT_VALID
|
|
if valid:
|
|
state.print(f'{entity.name} just dropped of an item at {drop_off.pos}.')
|
|
else:
|
|
state.print(f'{entity.name} just tried to drop off at {entity.pos}, but failed.')
|
|
return self.get_dropoff_result(valid, entity)
|
|
|
|
elif items := state[i.ITEM].by_pos(entity.pos):
|
|
item = items[0]
|
|
item.change_parent_collection(inventory)
|
|
item.set_pos(c.VALUE_NO_POS)
|
|
state.print(f'{entity.name} just picked up an item at {entity.pos}')
|
|
return self.get_result(c.VALID, entity)
|
|
|
|
else:
|
|
state.print(f'{entity.name} just tried to pick up an item at {entity.pos}, but failed.')
|
|
return self.get_result(c.NOT_VALID, entity)
|