Class MapObjectProperty

public final class MapObjectProperty

Defines the built-in custom property names that LITIengine recognizes on Tiled IMapObject instances.

These string constants are used as keys for properties attached to map objects in .tmx files and are referenced by the various MapObjectLoader implementations to configure entities at load time.

  • Field Details

    • TAGS

      public static final String TAGS
      Comma-separated list of tags assigned to an entity.
      See Also:

    • RENDERTYPE

      public static final String RENDERTYPE
      Render type used when drawing the entity.
      See Also:

    • RENDERWITHLAYER

      public static final String RENDERWITHLAYER
      Whether the entity should be rendered together with its containing layer.
      See Also:

    • REQUIRED_QUALITY

      public static final String REQUIRED_QUALITY
      Minimum graphics quality required for the entity to be rendered.
      See Also:

    • COLLISION

      public static final String COLLISION
      Whether collision is enabled for the entity.
      See Also:

    • COLLISION_ALIGN

      public static final String COLLISION_ALIGN
      Horizontal alignment of the entity's collision box.
      See Also:

    • COLLISION_VALIGN

      public static final String COLLISION_VALIGN
      Vertical alignment of the entity's collision box.
      See Also:

    • COLLISION_TYPE

      public static final String COLLISION_TYPE
      Type of collision used by the entity (static, dynamic, etc.).
      See Also:

    • COLLISIONBOX_HEIGHT

      public static final String COLLISIONBOX_HEIGHT
      Height of the entity's collision box, in pixels.
      See Also:

    • COLLISIONBOX_WIDTH

      public static final String COLLISIONBOX_WIDTH
      Width of the entity's collision box, in pixels.
      See Also:

    • COLLISIONBOX_OBSTRUCTINGLIGHTS

      public static final String COLLISIONBOX_OBSTRUCTINGLIGHTS
      Whether the collision box obstructs light sources.
      See Also:

    • SPRITESHEETNAME

      public static final String SPRITESHEETNAME
      Name of the spritesheet associated with the entity.
      See Also:

    • SCALE_SPRITE

      public static final String SCALE_SPRITE
      Whether the entity's sprite should be scaled to fit its bounding box.
      See Also:

    • IMPLEMENTATION

      public static final String IMPLEMENTATION
      Project-defined implementation identifier for a built-in map object type.
      See Also:

    • SCRIPT_BINDINGS

      public static final String SCRIPT_BINDINGS
      Versioned JSON bindings for scripts attached to an entity.
      See Also:

    • MOVEMENT_ACCELERATION

      public static final String MOVEMENT_ACCELERATION
      Acceleration value of a mobile entity, in milliseconds to reach max velocity.
      See Also:

    • MOVEMENT_DECELERATION

      public static final String MOVEMENT_DECELERATION
      Deceleration value of a mobile entity, in milliseconds to come to a stop.
      See Also:

    • MOVEMENT_VELOCITY

      public static final String MOVEMENT_VELOCITY
      Maximum movement velocity of a mobile entity, in pixels per second.
      See Also:

    • MOVEMENT_TURNONMOVE

      public static final String MOVEMENT_TURNONMOVE
      Whether the entity should rotate towards its movement direction.
      See Also:

    • COMBAT_HITPOINTS

      public static final String COMBAT_HITPOINTS
      Hit points of a combat entity.
      See Also:

    • COMBAT_CURRENT_HITPOINTS

      public static final String COMBAT_CURRENT_HITPOINTS
      Initial current hit points of a combat entity.
      See Also:

    • COMBAT_INDESTRUCTIBLE

      public static final String COMBAT_INDESTRUCTIBLE
      Whether the combat entity is indestructible.
      See Also:

    • COMBAT_TEAM

      public static final String COMBAT_TEAM
      Identifier of the team the combat entity belongs to.
      See Also:

    • PROP_MATERIAL

      public static final String PROP_MATERIAL
      Material of a prop, used to determine sound effects and damage interactions.
      See Also:

    • PROP_ADDSHADOW

      public static final String PROP_ADDSHADOW
      Whether the prop should cast a shadow.
      See Also:

    • PROP_ROTATION

      public static final String PROP_ROTATION
      Sprite rotation of the prop.
      See Also:

    • PROP_FLIPHORIZONTALLY

      public static final String PROP_FLIPHORIZONTALLY
      Whether the prop's sprite is flipped horizontally.
      See Also:

    • PROP_FLIPVERTICALLY

      public static final String PROP_FLIPVERTICALLY
      Whether the prop's sprite is flipped vertically.
      See Also:

    • LIGHT_COLOR

      public static final String LIGHT_COLOR
      Color of the emitted light, encoded as a string.
      See Also:

    • LIGHT_INTENSITY

      public static final String LIGHT_INTENSITY
      Intensity of the emitted light.
      See Also:

    • LIGHT_SHAPE

      public static final String LIGHT_SHAPE
      Shape of the light source (e.g. rectangle, ellipse).
      See Also:

    • LIGHT_ACTIVE

      public static final String LIGHT_ACTIVE
      Whether the light source is initially active.
      See Also:

    • SOUND_VOLUME

      public static final String SOUND_VOLUME
      Volume modifier of the sound source.
      See Also:

    • SOUND_LOOP

      public static final String SOUND_LOOP
      Whether the sound source loops its playback.
      See Also:

    • SOUND_NAME

      public static final String SOUND_NAME
      Name of the sound resource played by the source.
      See Also:

    • SOUND_RANGE

      public static final String SOUND_RANGE
      Range, in pixels, within which the sound is audible.
      See Also:

    • SHADOW_TYPE

      public static final String SHADOW_TYPE
      Type of static shadow cast (e.g. rectangle, ellipse).
      See Also:

    • SHADOW_OFFSET

      public static final String SHADOW_OFFSET
      Pixel offset applied to the static shadow.
      See Also:

    • SPAWN_INFO

      public static final String SPAWN_INFO
      Free-form spawn information string passed to the spawned entity.
      See Also:

    • SPAWN_DIRECTION

      public static final String SPAWN_DIRECTION
      Initial facing direction of the spawned entity.
      See Also:

    • SPAWN_PIVOT

      public static final String SPAWN_PIVOT
      Pivot point used when positioning the spawned entity.
      See Also:

    • SPAWN_PIVOT_OFFSETX

      public static final String SPAWN_PIVOT_OFFSETX
      Horizontal offset of the spawn pivot.
      See Also:

    • SPAWN_PIVOT_OFFSETY

      public static final String SPAWN_PIVOT_OFFSETY
      Vertical offset of the spawn pivot.
      See Also:

    • TRIGGER_ACTIVATION

      public static final String TRIGGER_ACTIVATION
      Activation mode of a trigger (interact, collision, etc.).
      See Also:

    • TRIGGER_MESSAGE

      public static final String TRIGGER_MESSAGE
      Message dispatched when the trigger fires.
      See Also:

    • TRIGGER_ONETIME

      public static final String TRIGGER_ONETIME
      Whether the trigger can fire only once.
      See Also:

    • TRIGGER_ACTIVATORS

      public static final String TRIGGER_ACTIVATORS
      Identifiers of entities that may activate the trigger.
      See Also:

    • TRIGGER_TARGETS

      public static final String TRIGGER_TARGETS
      Identifiers of entities that receive the trigger message.
      See Also:

    • TRIGGER_COOLDOWN

      public static final String TRIGGER_COOLDOWN
      Cooldown, in milliseconds, between subsequent activations of the trigger.
      See Also:

  • Method Details

    • getAvailableProperties

      public static List<String> getAvailableProperties()
      Returns the lazily-computed list of all built-in property names defined by this class and its nested MapObjectProperty.Emitter and MapObjectProperty.Particle classes.
      Returns:
      the list of available built-in property names

    • isCustom

      public static boolean isCustom(String name)
      Determines whether the given property name is a custom (user-defined) property, i.e. not part of the built-in property names.
      Parameters:
      name - the property name to test
      Returns:
      true if the name is not part of the built-in properties; false otherwise