Card Game Combat - Documentation

User Tools

Site Tools

You are here: start » plugin-card-layers
plugin-card-layers

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
plugin-card-layers [2024/12/03 10:50] – [Refreshing] banerjeeswplugin-card-layers [2024/12/10 05:01] (current) – [Badge Text] isiahgames
Line 5: Line 5:
 This plugin allows you to control the appearance of cards through a layer system. This allows the addition of Layers and Badges. This plugin allows you to control the appearance of cards through a layer system. This allows the addition of Layers and Badges.
  
-Layers are image components that have a Priority value which determines the order in which they appear, with the lowest value being the farthest back and the highest being the farthest in front.+Layers are image components that have a **Priority** value which determines the order in which they appear, with the lowest value being the farthest back and the highest being the farthest in front. Default Layers have the following Priorities: 
 +|  **Back**  |  0  | 
 +|  **Base**  |  100  | 
 +|  **Art**  |  200  | 
 +|  **Text**  |  300  | 
 +|  **Highlight**  |  400  |
  
-Default Layers have the following Priorities: 
-<code> 
-Back -                              0 
-Base -                            100 
-Art -                             200 
-Text -                            300 
-Highlight -                       400 
-</code> 
 Any Custom Layer added will have Priority values between these. So for instance if you have a Custom Layer with a Priority of 250 it will appear above the Art layer but behind the Text layer. Any Custom Layer added will have Priority values between these. So for instance if you have a Custom Layer with a Priority of 250 it will appear above the Art layer but behind the Text layer.
  
Line 25: Line 22:
 Layers all have the following properties, with some exceptions: Layers all have the following properties, with some exceptions:
  
-**Name** - The name of the Layer. +|  **Name**  | The name of the Layer. | 
- +|  **Priority**  | A number representing the order of all Layers in the Card. Higher number means farther in front. | 
-**Priority** - A number representing the order of all Layers in the Card. Higher number means farther in front. +|  **Image**  | The image of the Layer, located in img/CGC/bases for the Back and Base Layers and in img/CGC/art for all other Layers | 
- +|  **Position Offset**  | The offset position of the Layer. | 
-**Image** - The image of the Layer, located in img/CGC/bases for the Back and Base Layers and in img/CGC/art for all other Layers. +|  **Condition**  | A code expression that evalues whether the Layer is visible (true) or not (false). The condition evaluates once when the Card Sprite is first created and then again after  battler has taken an action in Battle if the Refresh Layer Visibility parameter is set to true. |
- +
-**Position Offset** - The offset position of the Layer. +
- +
-**Condition** - A code expression that evalues whether the Layer is visible (true) or not (false). The condition evaluates once when the Card Sprite is first created and then again after  battler has taken an action in Battle if the Refresh Layer Visibility parameter is set to true.+
 ===== Default Layers ===== ===== Default Layers =====
  
Line 40: Line 33:
 Back and Base images are located in img/CGC/bases, all other images are in img/CGC/art. Back and Base images are located in img/CGC/bases, all other images are in img/CGC/art.
  
-**Back** - The layer that appears behind all other layers. This image actually renders backwards. This is because when a card is "flipped over" all components appear backwards, and so by flipping the Back layer to begin with it actually looks correct. +|  **Back**  | The layer that appears behind all other layers. This image actually renders backwards. This is because when a card is "flipped over" all components appear backwards, and so by flipping the Back layer to begin with it actually looks correct.\\ \\ If the Back's image is set to "%default", then it will use the following logic:\\ 1. If it has a Card Type that has a Card Back parameter, it will use that.\\ 2. Else it will use DefaultBack.png | 
- +|  **Base**  | The layer that is designed to be uniform across all cards or all cards of a given Type or other group. This represents the "frame" of the card. It's recommended to be the same size as the Back so that the Back is only visible while the card is flipped over.\\ The Base determines the dimensions of the card for purposes of placing any other layer components and for touch input hitboxes.\\ \\ If its image is set to "%default" then the Card will use vanilla CGC logic to determine its card base. That logic being:\\ 1. If it has a <Card Base: fileName> tag, use that image.\\ 2. If it has a Card Type that has a Card Base parameter, it will use that.\\ 3. Else it will use Default.png | 
-If the Back's image is set to "%default", then it will use the following logic: +|  **Art**  | The layer that is designed to be unique per skill.\\ \\ If its image is set to "$default" then the Card will use the vanilla CGC logic to determine the card art. That logic being:\\ 1. If it has a <Card Art: fileName> tag, use that image.\\ 2. Else it will use the skill's icon scaled up. | 
- +|  **Text**  | The layer that holds all of the text on the card.\\ \\ This Default Layer does not have an image component because it is designed to be an empty canvas on which the text is written. | 
-1. If it has a Card Type that has a Card Back parameter, it will use that. +|  **Highlight**  | The layer that contains the Highlights. |
- +
-2. Else it will use DefaultBack.png +
- +
-**Base** - The layer that is designed to be uniform across all cards or all cards of a given Type or other group. This represents the "frame" of the card. It's recommended to be the same size as the Back so that the Back is only visible while the card is flipped over. +
- +
-The Base determines the dimensions of the card for purposes of placing any other layer components and for touch input hitboxes. +
- +
-If its image is set to "%default" then the Card will use vanilla CGC logic to determine its card base. That logic being: +
- +
-1. If it has a <Card Base: fileName> tag, use that image. +
- +
-2. If it has a Card Type that has a Card Base parameter, it will use that. +
- +
-3. Else it will use Default.png +
- +
-**Art** - The layer that is designed to be unique per skill. +
- +
-If its image is set to "$default" then the Card will use the vanilla CGC logic to determine the card art. That logic being: +
- +
-1. If it has a <Card Art: fileName> tag, use that image. +
- +
-2. Else it will use the skill's icon scaled up. +
- +
-**Text** - The layer that holds all of the text on the card. +
- +
-This Default Layer does not have an image component because it is designed to be an empty canvas on which the text is written. +
- +
-**Highlight** - The layer that contains the Highlights.+
  
 This Default Layer also does not have an image component because Cards contain multiple highlights at once to ensure a smooth transition between states of highlight. This Layer represents all Highlights. This Default Layer also does not have an image component because Cards contain multiple highlights at once to ensure a smooth transition between states of highlight. This Layer represents all Highlights.
Line 101: Line 66:
 </code> </code>
  
-**LayerName** - The name of the Layer whose values are being overridden. Can have spaces and is case-insensitive. +|  **LayerName**  | The name of the Layer whose values are being overridden. Can have spaces and is case-insensitive. | 
- +| **Priority** | A number from 1 to 500 that overrides the default Priority of the layer. Note this will do nothing for Default Layers. | 
-**Priority** - A number from 1 to 500 that overrides the default Priority of the layer. Note this will do nothing for Default Layers. +| **ImageName** | The name of the image file to use for the Layer. Can have spaces. | 
- +| **X** | The new X offset | 
-**ImageName** - The name of the image file to use for the Layer. Can have spaces. +| **Y** | The new Y offset | 
- +| **Condition** | The new condition for the Layer. |
-**X** - The new X offset +
- +
-**Y** - The new Y offset +
- +
-**Condition** - The new condition for the Layer.+
  
 Each one of these components are optional. If a component is not present the Layer will use the default values defined through plugin parameters. The | dividers are still neccessary to override a later property if you aren't overriding an early one. Each one of these components are optional. If a component is not present the Layer will use the default values defined through plugin parameters. The | dividers are still neccessary to override a later property if you aren't overriding an early one.
Line 147: Line 107:
 ===== Badges ===== ===== Badges =====
  
-Badges are special components that have an image property and a text property. Instead of having a Priority, they're associated with a Layer and are placed directly on that Layer.+Badges are special components that have an image property and a text property. Instead of having a Priority, they're associated with a Layer and are placed directly on that Layer. Badges have the following properties:
  
-Badges have the following properties:+| **Name** | The name of the Badge. | 
 +| **Layer Name** | The Layer the Badge is attached to. | 
 +| **Image** | The image of the Badge, located in img/CGC/art. | 
 +| **Position Offset** | The offset position of the Badge. | 
 +| **Text** | A code expression that evaluates into text. More about that below. | 
 +| **Font Settings** | | 
 +| //Font Face// | The font for the text to use. Use GameFont for the project's font. | 
 +| //Font Size// | The font size for the text. | 
 +| **Text Color** | A hexcode for the text color, though certain color |
  
-**Name** - The name of the Badge.+===== Badge Text =====
  
-**Layer Name** - The Layer the Badge is attached to.+The Text property is not a simple text input, but instead code which evaluates into text. In programming, a string of text, referred to simply as a string, is formatted with quotation marks. So if you want static text, you should format it like this:
  
-**Image** - The image of the Badge, located in img/CGC/art.+"Hello World!"     <- would work
  
-**Position Offset** - The offset position of the Badge.+instead of like this
  
-**Text** - A code expression that evaluates into text. More about that below.+Hello World!       <- would NOT work
  
-**Font Settings** - +This property is code so that it can display variables more easily.
  
-//Font Face// - The font for the text to use. Use GameFont for the project's font.+Example: 
 +<code> 
 +user.mp + " MP" 
 +</code>
  
-//Font Size// - The font size for the text.+This example would display "3 MP" while the owner of the card had 3 MP.
  
-**Text Color** - A hexcode for the text color, though certain color+There are three variables you can use in the Text property to make referencing variables you want easier.
  
-===== Badge Text =====+<code> 
 +user - The Actor that owns the card. 
 +card - The Card object itself. 
 +skill - The Skill that the Card is a copy of. 
 +</code>
  
 +Examples of how you might use these:
 +
 +<code>
 +"LVL " + user.level
 +card.origin().toUpperCase()
 +skill.mpCost
 +</code>
 +
 +If you're using MYTH_CGC_IndependantCardVariables you can use:
 +<code>
 +card.cardVar(1)
 +</code>
 +
 +===== Badge Notetags =====
 +
 +Badge notetags work similarly to Layer notetags and use the following syntax:
 +
 +<code>
 +BadgeName (ParentLayerName): TextCode | ImageName | X Y | Condition
 +</code>
 +
 +|  **BadgeName**  | The name of the Badge whose values are being defined/overridden. Can have spaces and is case-insensitive. |
 +| **ParentLayerName** | The name of the Layer this Badge is attached to. |
 +| **TextCode** | The code that returns the text for the Badge to display. |
 +| **ImageName** | The name of the image file to use for the Badge. Can have spaces. |
 +| **X** | The new X offset |
 +| **Y** | The new Y offset |
 +| **Condition** | The new condition for the Badge. |
 +
 +Just like with Layers, you can use notetags to define entirely new Badges or override the values defined through the Custom Badges plugin parameter.
 ===== Conditions ===== ===== Conditions =====
  
 +The Condition property determines whether a Layer or Badge is visible. If it returns true, the component is visible, and if it returns false it is invisible.
 +
 +Note that because Badges are attached to Layers, if a Badge's parent Layer is invisible, it will be invisible too.
 +
 +Just like with Badge Text, you have three variables you can use to make this evaluation more flexible:
 +<code>
 +user - The Actor that owns the card.
 +card - The Card object itself.
 +skill - The Skill that the Card is a copy of.
 +</code>
 ===== Refreshing ===== ===== Refreshing =====
  
plugin-card-layers.1733219437.txt.gz · Last modified: 2024/12/03 10:50 by banerjeesw