> For the complete documentation index, see [llms.txt](https://flipcard.superiormc.cn/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://flipcard.superiormc.cn/flip-ui/ui-config/prices-option.md). # Prices Option Prices option is a little complex, so I introduce it on a separate page. **This section is optional, if you didn't add this, this means flip price is free.** ## Item Price You can set item as price, should use Item Format at [this](https://ultimateshop.superiormc.cn/base/item-format) page. **Example:** ```yaml 1: material: APPLE name: 'Magic Apple' custom-model-data: 5 apply: [1,2] amount: 10 placeholder: 'Magic Apple x10' ``` ## Item Match - Require MythicChanger Item Match has those options: * match-item: Determine the match rule of the price item. For more info, please view [this page](/features/custom-item-match-method.md). **Example:** ```yaml 1: match-item: items: - 'ender_pearl' has-name: true apply: [1,2] amount: 10 placeholder: 'Any named Ender Peral x10' ``` ## Hook Economy Hook economy has those options: * economy-plugin: What plugin you want this price economy hook into, for now, **FlipCard v2/3** supports `Vault, GamePoints, PlayerPoints, CoinsEngine, UltraEconomy, EcoBits, RedisEconomy, PEconomy, VotingPlugin`. * economy-type: If economy plugin is multi-currency economy plugin, you have to type currency name here. **Example:** ```yaml 1: economy-plugin: Vault # If you set Economy plugin to CoinsEngine, then: # economy-plugin: CoinsEngine # economy-type: Coin # Yeah, you need add economy-type option here because its a multi-currency plugin. # For this, players will always cost 5$. amount: 5 placeholder: '$5' apply: [1,2,3] ``` ## Vanilla Economy Vanilla economy has those options: * economy-type: Supports `exp, levels`. **Example:** ```yaml 1: economy-type: levels # In this example, player will cost different levels with different flip times. placeholders: 3: '10 Levels' 4: '20 Levels' cost: [10,20] apply: [3,4] ``` ## Custom * match-placeholder: The PlaceholderAPI placeholder value we will check in this price. * amount: The placeholder value must be greater than the amount you set here. * take-actions: The action will execute after price is cost. ```yaml 1: match-placeholder: '%player_health%' placeholder: 'Health x1' apply: [1,2] amount: 10 take-actions: 1: type: message message: 'I steal your one health!' ``` ## Free Just set `free: true` here. ## General Options Those options can be used in the 4 types of price. **All of them are optional.** * amount: The amount of items or economy price values. Like `1`. Default plugin will use cost option value, if cost option is not exists, we will use this option value. If not set, plugin will set amount to 1. * placeholder: Price display name at `%price%` placeholder. Like `Stone x5`. If not set, plugin will use default placeholder content that provided by language file. * placeholders: Format is `apply times: placeholder content`. ```yaml placeholders: 1: 'Stone x2' 2: 'Stone x5' ``` * start-apply: The number of usage times that price start applies. It is a number, if flip times more than this number, this price will be applied. `start-apply` is only work with `amount` option, does not support `cost` option. * apply: The number of usage times that this price applies. It is an array, should be like `[1,2,3]`, this means that this price applies to your first, second, and third time card flips. If not set, the plugin will automatically consider the ID of the price as the applicable times. * cost: Little same as amount, but this option corresponds to the number of times the apply option is applied one by one. Like `[10,20,30]`. If not set, plugin will use `amount` option value. * conditions: Players must meet certain conditions to use this price. You should write this option like this format: ```yaml conditions: : - ``` For example: ```yaml conditions: 1: 1: type: permission permission: 'group.default' 2: 1: type: world world: world 2: type: permission permission: 'group.default' ``` You can also write this option like this format, this format means players should always meet those conditions, whatever the flip times. ```yaml conditions: 1: type: permission permission: 'hi.hi' ``` Each condition id section should use **Condition Format**, for more info, please view [Format](/info/format.md) page. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://flipcard.superiormc.cn/flip-ui/ui-config/prices-option.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.