Package net.risingworld.api.definitions

Class Clothing.ClothingDefinition

java.lang.Object
net.risingworld.api.definitions.Clothing.ClothingDefinition
Enclosing class:
Clothing
public final class Clothing.ClothingDefinition extends Object

  • Field Details

    • id

      public short id
      Internal type ID of the clothing piece

    • name

      public String name
      Name of the clothing piece

    • types

      public Clothing.Type[] types
      Affected body types. Never null!

    • function

      public Clothing.Function function
      Gets the special function/behaviour of this clothing piece. "None" by default

    • requirement

      public String requirement
      Optional other clothing piece that is required for this piece (i.e the entity must wear this clothing piece already). May be null (for no requirement)

    • race

      public Clothing.Race race
      Race which can wear this clothing piece

    • gender

      public Clothing.Gender gender
      Gender which can wear this clothing piece

    • era

      public Era era
      Era/age this clothing piece belongs to

    • assetpath

      public String assetpath
      Path to the asset (for male and unisex)

    • assetpathfemale

      public String assetpathfemale
      Path to the asset for the female model. If not specified, this will automatically refer to the main "assetpath"

    • alphamask

      public String alphamask
      Path to an optional alpha mask texture (which will be applied to the player when wearing this clothing piece). May be null

    • hideunderwear

      public int hideunderwear
      Determines if underwear should be visible while wearing this clothing piece. 0 means all underwear remains visible, 1 means lower underwear is removed, 2 means upper underwear is removed, 3 means all underwear is removed. Only relevant for human clothes

    • rootbone

      public String rootbone
      Root bone for the skinned mesh renderer

    • bones

      public String[] bones
      Array of bones that need to be assigned to the skinned mesh renderer. May be null

    • relateditem

      public String relateditem

    • protection

      public int protection

    • insulation

      public int insulation

    • absorbency

      public int absorbency

    • heatprotection

      public int heatprotection

    • radiationprotection

      public int radiationprotection

    • camouflage

      public int camouflage

    • isarmor

      public boolean isarmor

    • istool

      public boolean istool

    • isheadgear

      public boolean isheadgear

    • isfootwear

      public boolean isfootwear

    • specialasset

      public String specialasset
      Optional special asset path (e.g light prefab for lamps etc)

    • visiblefp

      public boolean visiblefp
      Determines if the clothing piece is visible in first-person view

    • hidehair

      public boolean hidehair
      Determines whether or not the player hair needs to be hidden when wearing this clothing piece (see parameters)

    • hidebeard

      public boolean hidebeard
      Determines whether or not the player beard needs to be hidden when wearing this clothing piece (see parameters)

    • walksound

      public int walksound

  • Method Details

    • synchronize

      public void synchronize()

    • getIcon

      public TextureAsset getIcon(int texture)
      Gets the ingame icon of these clothes as TextureAsset.
      Parameters:
      texture - the cloth texture/variant. By default 0.
      Returns:
      the icon of these clothes.