Interface Spell

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Interface Description
      static interface  Spell.Component
      A spell component.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      int getBlockID()
      Returns the integer serving as the block id in the cr.
      java.util.Map<java.lang.String,​java.lang.String> getComponents()
      Returns the components of this spell as a map of "type" Strings as keys and "amount" Strings as values.
      StringID getID()
      Returns the id uniquely identifying this object.
      boolean getIsFamiliar()
      Returns true if this is a spell can be cast by the mage's familiar.
      boolean getIsFar()
      Returns true if this spell has far effects
      int getLevel()
      Returns the level of this spell which indicates the lowest skill level a mage must have to be able to cast this spell.
      boolean getOnOcean()
      Returns true if this spell can be cast while on oceans.
      boolean getOnShip()
      Returns true if this spell can be cast on leaving ships.
      java.util.List<? extends Spell.Component> getParsedComponents()
      Returns a list of the spells components in a more convenient form.
      int getRank()
      Returns the rank of this spell.
      SpellSyntax getSpellSyntax()
      returns the spellsyntax object of this spell
      java.lang.String getSyntax()
      Enno in e-client about the syntax: 'c' = Zeichenkette 'k' = REGION|EINHEIT|STUFE|SCHIFF|GEBAEUDE 'i' = Zahl 's' = Schiffsnummer 'b' = Gebaeudenummer 'r' = Regionskoordinaten (x, y) 'u' = Einheit '+' = Wiederholung des vorangehenden Parameters '?'
      java.lang.String getSyntaxString()
      A human readable string with information about the syntax of the spell or null.
      java.lang.String getType()
      Returns the class attribute of this spell or null.
      java.lang.String getTypeName()
      Returns a name for this spell's type.
      void setBlockID​(int id)
      Sets the integer serving as the block id in the cr.
      void setComponents​(java.util.Map<java.lang.String,​java.lang.String> components)
      Sets the components of this spell as Strings.
      void setIsFamiliar​(boolean isFamiliar)
      Sets the familiar property.
      void setIsFar​(boolean isFar)
      Sets if this spell has far effects
      void setLevel​(int level)
      Sets the level of this spell which indicates the lowest skill level a mage must have to be able to cast this spell.
      void setOnOcean​(boolean onOcean)
      Sets if this spell has effect on oceans.
      void setOnShip​(boolean onShip)
      Sets if this spell can be cast on leaving ships
      void setRank​(int rank)
      Sets the rank of this spell.
      void setSyntax​(java.lang.String syntax)  
      void setType​(java.lang.String type)
      Sets the class attribute of this spell.
      java.lang.String toString()  
    • Method Detail

      • getBlockID

        int getBlockID()
        Returns the integer serving as the block id in the cr.
      • setBlockID

        void setBlockID​(int id)
        Sets the integer serving as the block id in the cr.
      • getLevel

        int getLevel()
        Returns the level of this spell which indicates the lowest skill level a mage must have to be able to cast this spell.
      • setLevel

        void setLevel​(int level)
        Sets the level of this spell which indicates the lowest skill level a mage must have to be able to cast this spell.
      • getRank

        int getRank()
        Returns the rank of this spell.
      • setRank

        void setRank​(int rank)
        Sets the rank of this spell.
      • getType

        java.lang.String getType()
        Returns the class attribute of this spell or null.
      • setType

        void setType​(java.lang.String type)
        Sets the class attribute of this spell.
      • getOnOcean

        boolean getOnOcean()
        Returns true if this spell can be cast while on oceans.
      • setOnOcean

        void setOnOcean​(boolean onOcean)
        Sets if this spell has effect on oceans.
      • getOnShip

        boolean getOnShip()
        Returns true if this spell can be cast on leaving ships.
      • setOnShip

        void setOnShip​(boolean onShip)
        Sets if this spell can be cast on leaving ships
      • getIsFamiliar

        boolean getIsFamiliar()
        Returns true if this is a spell can be cast by the mage's familiar.
      • setIsFamiliar

        void setIsFamiliar​(boolean isFamiliar)
        Sets the familiar property. true means that this is a spell can be cast by the mage's familiar.
      • getIsFar

        boolean getIsFar()
        Returns true if this spell has far effects
      • setIsFar

        void setIsFar​(boolean isFar)
        Sets if this spell has far effects
      • getComponents

        java.util.Map<java.lang.String,​java.lang.String> getComponents()
        Returns the components of this spell as a map of "type" Strings as keys and "amount" Strings as values. Types are not localized.
      • getParsedComponents

        java.util.List<? extends Spell.Component> getParsedComponents()
        Returns a list of the spells components in a more convenient form.
      • setComponents

        void setComponents​(java.util.Map<java.lang.String,​java.lang.String> components)
        Sets the components of this spell as Strings. Types (the keys) are not localized.
      • toString

        java.lang.String toString()
        Overrides:
        toString in class java.lang.Object
        See Also:
        Object.toString()
      • getTypeName

        java.lang.String getTypeName()
        Returns a name for this spell's type.
      • getSyntaxString

        java.lang.String getSyntaxString()
        A human readable string with information about the syntax of the spell or null.
      • getSyntax

        java.lang.String getSyntax()
        Enno in e-client about the syntax:
        • 'c' = Zeichenkette
        • 'k' = REGION|EINHEIT|STUFE|SCHIFF|GEBAEUDE
        • 'i' = Zahl
        • 's' = Schiffsnummer
        • 'b' = Gebaeudenummer
        • 'r' = Regionskoordinaten (x, y)
        • 'u' = Einheit
        • '+' = Wiederholung des vorangehenden Parameters
        • '?' = vorangegangener Parameter
        ist nicht zwingend Syntaxcheks, die der Server auf dieser Basis macht, sind nicht perfekt; es ist notwendig, aber nicht hinreichend, dass die Syntax erfuellt wird. Aber in den vielen Faellen kann man damit schonmal sagen, was denn falsch war.
        Returns:
        the syntax or null
      • setSyntax

        void setSyntax​(java.lang.String syntax)
        Parameters:
        syntax - the syntax to set
      • getSpellSyntax

        SpellSyntax getSpellSyntax()
        returns the spellsyntax object of this spell
        Returns:
        a SpellSyntax object