Difference between revisions of "ProductOption class"
(Created page with "{{CGscriptClass_Template |Name=<nowiki>ProductOption</nowiki> |Description=<nowiki>Represents a Product.</nowiki> |Methods= {{CGscriptMethods_Template|ReturnType=bool|Name=<no...") |
|||
Line 4: | Line 4: | ||
|Methods= | |Methods= | ||
{{CGscriptMethods_Template|ReturnType=bool|Name=<nowiki>Buy</nowiki>|Parameters= | {{CGscriptMethods_Template|ReturnType=bool|Name=<nowiki>Buy</nowiki>|Parameters= | ||
− | {{CGscriptParameters_Template|Type=Order|Name=<nowiki>order</nowiki>|Description=<nowiki>Order to add the purchase to</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>amount</nowiki>|Description=<nowiki>Number of items to add to order</nowiki>}} | + | {{CGscriptParameters_Template|Type=Order|Name=<nowiki>order</nowiki>|Description=<nowiki>Order to add the purchase to</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>amount</nowiki>|Description=<nowiki>Number of items to add to order. Negative or 0 removes existing</nowiki>}} |
+ | |Description=<nowiki>Purchase items</nowiki>}} | ||
+ | {{CGscriptMethods_Template|ReturnType=ProductOrder|Name=<nowiki>Buy</nowiki>|Parameters= | ||
+ | {{CGscriptParameters_Template|Type=Order|Name=<nowiki>order</nowiki>|Description=<nowiki>Order to add the purchase to</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>amount</nowiki>|Description=<nowiki>Number of items to add to order. Negative or 0 removes existing</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>unitCost</nowiki>|Description=<nowiki>Cost per unit in points. 0 is equal to default price. If set, updates price for all existing also.</nowiki>}} | ||
|Description=<nowiki>Purchase items</nowiki>}} | |Description=<nowiki>Purchase items</nowiki>}} | ||
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Description=<nowiki>The string representation of the object.</nowiki>}} | {{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Description=<nowiki>The string representation of the object.</nowiki>}} |
Revision as of 11:06, 3 December 2018
ProductOption
Represents a Product.
Methods
- bool Buy(Order order "Order to add the purchase to", int amount "Number of items to add to order. Negative or 0 removes existing") - Purchase items
- ProductOrder Buy(Order order "Order to add the purchase to", int amount "Number of items to add to order. Negative or 0 removes existing", int unitCost "Cost per unit in points. 0 is equal to default price. If set, updates price for all existing also.") - Purchase items
- string ToString() - The string representation of the object.
Properties
- bool CanSell { get; } - Is there enough products available to buy 1. Return false if unable to add to order
- int Id { get; } - Id of the ProductOption
- string LocalizedName { get; } - Localized Name of the ProductOption
- Dictionary LocalizedNames { get; } - Localized Names of the ProductOption
- string ObjectTypeName { get; } - The name of the type of object.
- TypeInformation TypeInformation { get; } - Get information about this class.