Differences

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

--- plugin-card-layers [2024/12/03 11:36] – [Notetags] banerjeesw
+++ plugin-card-layers [2024/12/10 05:01] (current) – [Badge Text] isiahgames
@@ Line 66: / Line 66: @@
 </code>
+|  **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. |
-**LayerName** - The name of the Layer whose values are being overridden. Can have spaces and is case-insensitive.
+| **ImageName** | The name of the image file to use for the Layer. Can have spaces. |
+| **X** | The new X offset |
-**Priority** - A number from 1 to 500 that overrides the default Priority of the layer. Note this will do nothing for Default Layers.
+| **Y** | The new Y offset |
+| **Condition** | The new condition for the Layer. |
-**ImageName** - The name of the image file to use for the Layer. Can have spaces.
-**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.
@@ Line 114: / Line 107: @@
 ===== 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 =====
+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 =====