This must be set to the base setting key for the component.
This variable holds the markup box used to lay out the
content text, or null if there is no content text.
It is set during createFrontPainter
.
This variable holds the DIY component instance.
This variable will hold the component's private settings.
This variable holds the markup box used to lay out the
card title, or null if there is no title.
It is set during createFrontPainter
.
Called to set up global variables once the DIY instance is known.
the DIY instance for the compnent
Composes a full key name from the base name
(pfBaseKey
) and a suffix.
the suffix to append to the key base
the complete key name
Called from the standard prefab painting function to paint an overlay overtop of the background and portrait. Replace to customize behaviour.
the graphics context
the sheet being painted
Returns a string looked up from the DIY's settings
based on the base key (pfFrontKey
). If the value
starts with #
, @
, or $
, the true value is
looked up as if the value were a global variable
(i.e., as a game string, interface string, or setting).
prefab library
Creates a DIY component based on a common layout with a minimum of coding. For an explanation of how to use prefab components, refer to the relevant Developer Manual section.
Include this library by adding
useLibrary("prefab")
to your script, then define the relevant values (at a minimumpfBaseKey
). See the plug-in authoring kit for examples that use this library.