Class Base

java.lang.Object
gaiasky.scene.component.Base
All Implemented Interfaces:
com.badlogic.ashley.core.Component, ICopy
public class Base extends Object implements com.badlogic.ashley.core.Component, ICopy

  • Field Details

    • archetype

      public Archetype archetype
      Reference to the archetype used to create this entity, if any.

    • id

      public long id
      The internal identifier

    • names

      public String[] names
      The name(s) of the node, if any.

    • localizedNameIndex

      public int localizedNameIndex
      The index of the localized name in the names array.

    • lastStateChangeTimeMs

      public long lastStateChangeTimeMs
      Time of last visibility change in milliseconds

    • opacity

      public float opacity
      The ownOpacity value (alpha)

    • ct

      public ComponentTypes ct
      Component types, for managing visibility

    • computed

      public boolean computed
      Flag indicating whether the object has been computed in this step.

    • initialized

      public boolean initialized
      Flag marking entities as fully initialized. This means that both EntityInitializer.initializeEntity(Entity) and EntityInitializer.setUpEntity(Entity) have run.

    • visible

      public boolean visible
      Is this node visible?

    • copy

      public boolean copy
      Is this just a copy?

    • attributes

      public com.badlogic.gdx.utils.ObjectMap<String,Object> attributes
      Extra attributes.

  • Constructor Details

    • Base

      public Base()

  • Method Details

    • getName

      public String getName()

    • setName

      public void setName(String name)

    • setNames

      public void setNames(String[] names)

    • setName

      public void setName(String name, int index)
      Sets the given index in the names list to the given name. If the index is out of bounds, nothing happens.
      Parameters:
      name - The new name.
      index - The index in the names list.

    • hasName

      public boolean hasName(String candidate)

    • hasName

      public boolean hasName(String candidate, boolean matchCase)

    • matchesName

      public boolean matchesName(String candidate, boolean matchCase)
      Checks if the entity holding this Base component has a name that matches the candidate. If the candidate string is not a regex, the matching is done with equals() and contains(). If the candidate string is a regex
      Parameters:
      candidate - The candidate string.
      matchCase - Whether to match the case.
      Returns:
      True if the entity has a name matching the candidate. False otherwise.

    • addName

      public int addName(String name)
      Adds a name to the list of names.
      Parameters:
      name - The name.
      Returns:
      The index of the added name.

    • removeLocalizedName

      public void removeLocalizedName()
      Removes the localized name from the array if it exists and can be removed.

    • getLocalizedName

      public String getLocalizedName()

    • updateLocalizedName

      public void updateLocalizedName()

    • setAltname

      public void setAltname(String altname)

    • setAltName

      public void setAltName(String altname)

    • hasCt

      public boolean hasCt(ComponentTypes.ComponentType ct)

    • setComponentType

      public void setComponentType(String ct)

    • setCt

      public void setCt(String ct)

    • setComponentTypes

      public void setComponentTypes(String[] cts)

    • setComponentType

      public void setComponentType(String[] cts)

    • setCt

      public void setCt(String[] cts)

    • setComponentType

      public void setComponentType(ComponentTypes.ComponentType ct)

    • isVisible

      public boolean isVisible()

    • msSinceStateChange

      public long msSinceStateChange()
      Computes the elapsed number of milliseconds since the last visibility state change for the given base component.
      Returns:
      The elapsed time [ms] since the last visibility state change.

    • getVisibilityOpacityFactor

      public float getVisibilityOpacityFactor()
      Gets the visibility opacity factor for this base component.
      Returns:
      The visibility opacity factor.

    • addExtraAttribute

      public void addExtraAttribute(String name, Object value)

    • getExtraAttributes

      public com.badlogic.gdx.utils.ObjectMap<String,Object> getExtraAttributes()

    • hasExtraAttributes

      public boolean hasExtraAttributes()

    • getCopy

      public com.badlogic.ashley.core.Component getCopy(com.badlogic.ashley.core.Engine engine)
      Specified by:
      getCopy in interface ICopy