comet.CProduct¶
- class comet.CProduct¶
This section describes all functions for the CProduct class.
See also
Methods¶
- CProduct.getID()¶
Gets the record ID of the product.
This is a convenience function for calling
getAttribute()
with keyscomet.kProductID
,comet.kProductID2
,comet.kProductID3
andcomet.kProductStringID
, assembled as aCIDType
object.- Returns
The ID of the product
- Return type
- Available
- CScript
- CProduct.getName()¶
Get the name of a product.
This is a convenience function for calling
getAttribute()
with keycomet.kProductRow1
- Returns
The name of the product as displayed in the product pool
- Return type
- Available
- CScript
- CProduct.getAttribute(key)¶
Fetch an attribute of a product. Depending on the attribute fetched, the return type may vary.
- Parameters
key (int) –
The key of the attribute to be fetched.
For available selectors and the resulting return type see Product selectors.
- Returns
The value which belongs to the key.
- Return type
- Raises
TypeError – When parameter key has wrong type
ValueError – When parameter key has invalid value
CometError – On internal error
- Available
- CScript
- CProduct.setAttribute(value)¶
Set an attribute of a product.
The value type depends on the attribute you want to set which can be found at Product selectors.
- Parameters
- Return type
- Raises
When parameter types are invalid
When parameter type of value mismatches the selector from key
ValueError – When parameter key has invalid value
CometError – On internal error
- Available
- CScript