Skip to main content

Ownership

Description

This service provides an interface to interact with items the agent has a relationship with or can make one.

Interface

Type
IOwnershipService

Inherits

Type
N/A

Properties

NameType
dataIOwnershipData

Public Methods

NameParametersReturn TypeDescription
AccessItemOWNERSHIP ownership, ITEMS_TYPE type, ITEMS nameList<Item>Returns items which fit the filter.
RemoveItemOWNERSHIP ownership, List<Item> itemsbooleanRemoves the item from the ownership group if present.
UpsertItemOWNERSHIP ownership, List<Item> itemsbooleanAdd the item to a slot if already filled else added to a new slot.
ConsumeITEMS name = ITEMS.NULLbooleanRemoves an entry within a slot of a certain item if present.
DropITEMS name = ITEMS.NULLbooleanDrops the item if present. Returns false if not.
HasItemOWNERSHIP ownership, ITEMS name = ITEMS.NULL, ITEMS_TYPE type = ITEMS_TYPE.NULL, ITEMS_SIZE size = ITEMS_SIZE.NULLbooleanReturns true if an item fits the filter.
PickUpItem itembooleanAdds the item to a slot if there is space. Returns false if not.
PickUpGameObject itembooleanSame as the other pick up but tries to find item from GameObject.
EquipITEMS name = ITEMS.NULL, ITEMS_TYPE type = ITEMS_TYPE.NULL, ITEMS_SIZE size = ITEMS_SIZE.NULLbooleanMoves item to using slot, if already filled will move items between slots.
AddBuildingBUILDING_TYPE type, IBuildingService buildingbooleanAdds an ownership relationship to a building.One building per a building type.
GetBuildingBUILDING_TYPE typeIBuildingServiceAccess a building with an ownership relationship.
AddRoomIRoomService room, OWNERSHIP ownershipbooleanAdds a room ownership relationship.
GetRoomsN/Aboolean?Access all rooms which have an ownership relationship.