Orxonox  0.0.5 Codename: Arcturus
Public Attributes | List of all members
orxonox::PickupInventoryContainer Struct Reference

Data structure to store collected data for one specific Pickupable. More...

#include </home/jenkins/workspace/orxonox_doxygen_trunk/src/modules/pickup/PickupManager.h>

Public Attributes

uint32_t carrierPawnId
 The objectId of the Pawn that carries the Pickupable. More...
 
bool inUse
 Whether the Pickupable is currently in use. More...
 
bool pickedUp
 Whether the Pickupable is currently picked up. More...
 
uint32_t pickup
 An indentifier for the Pickupable that is associated with the information stored here. More...
 
std::string representationName
 The name of the associated PickupRepresentation. More...
 
bool unusable
 Whether the Pickupable is droppable. More...
 
bool usable
 Whether the Pickupable is usable. More...
 

Detailed Description

Data structure to store collected data for one specific Pickupable.

This is used to not have to synchronise Pickupable just to have the needed information for the PickupInventory available on all clients. Instead the information is sent over the network and stored in a PickupInventoryContainer.

Member Data Documentation

uint32_t orxonox::PickupInventoryContainer::carrierPawnId

The objectId of the Pawn that carries the Pickupable.

bool orxonox::PickupInventoryContainer::inUse

Whether the Pickupable is currently in use.

bool orxonox::PickupInventoryContainer::pickedUp

Whether the Pickupable is currently picked up.

uint32_t orxonox::PickupInventoryContainer::pickup

An indentifier for the Pickupable that is associated with the information stored here.

std::string orxonox::PickupInventoryContainer::representationName

The name of the associated PickupRepresentation.

bool orxonox::PickupInventoryContainer::unusable

Whether the Pickupable is droppable.

bool orxonox::PickupInventoryContainer::usable

Whether the Pickupable is usable.


The documentation for this struct was generated from the following file: