Record Class ScriptPropertyMetadata

java.lang.Object
java.lang.Record
de.gurkenlabs.litiengine.scripting.ScriptPropertyMetadata
Record Components:
name - The Java field name used for binding.
displayName - The label intended for editors and tools.
description - Explanatory text for users configuring the field.
category - The optional group under which an editor should display the field.
type - The configured editor type identifier, or the Java field type name when no override is configured.
defaultValue - The default value represented as text.
min - The inclusive suggested minimum, or Double.NEGATIVE_INFINITY when unspecified.
max - The inclusive suggested maximum, or Double.POSITIVE_INFINITY when unspecified.
unit - The optional unit displayed with numeric values.
required - Whether a binding must provide a value.
public record ScriptPropertyMetadata(String name, String displayName, String description, String category, String type, String defaultValue, double min, double max, String unit, boolean required) extends Record
Editor-facing description of one configurable script field discovered from its implementation.

  • Constructor Details

    • ScriptPropertyMetadata

      public ScriptPropertyMetadata(String name, String displayName, String description, String category, String type, String defaultValue, double min, double max, String unit, boolean required)
      Creates an instance of a ScriptPropertyMetadata record class.
      Parameters:
      name - the value for the name record component
      displayName - the value for the displayName record component
      description - the value for the description record component
      category - the value for the category record component
      type - the value for the type record component
      defaultValue - the value for the defaultValue record component
      min - the value for the min record component
      max - the value for the max record component
      unit - the value for the unit record component
      required - the value for the required record component

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • name

      public String name()
      Returns the value of the name record component.
      Returns:
      the value of the name record component

    • displayName

      public String displayName()
      Returns the value of the displayName record component.
      Returns:
      the value of the displayName record component

    • description

      public String description()
      Returns the value of the description record component.
      Returns:
      the value of the description record component

    • category

      public String category()
      Returns the value of the category record component.
      Returns:
      the value of the category record component

    • type

      public String type()
      Returns the value of the type record component.
      Returns:
      the value of the type record component

    • defaultValue

      public String defaultValue()
      Returns the value of the defaultValue record component.
      Returns:
      the value of the defaultValue record component

    • min

      public double min()
      Returns the value of the min record component.
      Returns:
      the value of the min record component

    • max

      public double max()
      Returns the value of the max record component.
      Returns:
      the value of the max record component

    • unit

      public String unit()
      Returns the value of the unit record component.
      Returns:
      the value of the unit record component

    • required

      public boolean required()
      Returns the value of the required record component.
      Returns:
      the value of the required record component