Package worldBuilder

Class OverlayRule


  • public class OverlayRule
    extends ResourceRule
    An extension of ResourceRules that includes information about RPGM tiles
    • Field Detail

      • tile_size

        public static int tile_size
        RPGMaker tile set
      • height

        public int height
        dimensions (if this is a stamp)
      • width

        public int width
        dimensions (if this is a stamp)
      • a_min

        public int a_min
        range of acceptable Z percentages
      • a_max

        public int a_max
        range of acceptable Z percentages
      • d_min

        public int d_min
        range of acceptable depth percentages
      • d_max

        public int d_max
        range of acceptable depth percentages
      • icon

        public java.awt.image.BufferedImage icon
        preview icon image
    • Constructor Detail

      • OverlayRule

        public OverlayRule​(java.lang.String name)
        create a new rule
        Parameters:
        name - of this rule
    • Method Detail

      • factory

        public OverlayRule factory​(java.lang.String name)
        Factory method (to permit subclass instantiation by ResourceRule.loadFile)
        Parameters:
        name - of this rule Note: this method is called by ResourceRule.read() when the rule reading is complete, which means that any extended attributes have already been set (in the static save variables). We copy those into the new rule, and then reinitialize them.
      • set_attribute

        public void set_attribute​(java.lang.String name,
                                  java.lang.String value)
        called from ResourceRule.loadFile ... set an extended attribute (string value)
        Overrides:
        set_attribute in class ResourceRule
        Parameters:
        name - of the attribute being set
        value - to be set
      • set_attribute

        public void set_attribute​(java.lang.String name,
                                  int value)
        called from ResourceRule.loadFile ... set an extended attribute (integer value)
        Overrides:
        set_attribute in class ResourceRule
        Parameters:
        name - of the attribute being set
        value - to be set
      • set_range

        public void set_range​(java.lang.String name,
                              java.lang.String limit,
                              double value)
        called from ResourceRule.loadFile ... set an extended attribute (min/max double value)
        Overrides:
        set_range in class ResourceRule
        Parameters:
        name - of the attribute being set
        limit - (min or max)
        value - to be set
      • dump

        public void dump​(java.lang.String prefix)
        dump out the extended field attributes (for debugging)
        Overrides:
        dump in class ResourceRule
        Parameters:
        prefix - ... leading blanks Note: subclass should call super.dump() and then add its own output