Class Help

Object
Help
All Implemented Interfaces:
Serializable, DisplayInterface
@Entity public class Help extends Object implements Serializable, DisplayInterface
Author:
maartenl
See Also:

  • Constructor Details

    • Help

      public Help()

    • Help

      public Help(String command)

    • Help

      public Help(String command, String contents)

  • Method Details

    • getCommand

      public String getCommand()
      The command for which help is requested and found.
      Returns:
      String containing the command.

    • setCommand

      public void setCommand(String command)

    • getContents

      public String getContents()
      The explanation, description, whatever-you-may-call-it.
      Returns:
      'the help' as a String

    • setContents

      public void setContents(String contents)

    • getSynopsis

      public String getSynopsis()
      The way the command syntax works.
      Returns:
      String, for example "swoon [to <person>]".

    • setSynopsis

      public void setSynopsis(String synopsis)

    • getSeealso

      public String getSeealso()
      Reference to other commands.
      Returns:
      references to other commands.

    • setSeealso

      public void setSeealso(String seealso)

    • getBodyForWebpage

      public String getBodyForWebpage()

    • getSeealsoForWebpage

      public String getSeealsoForWebpage()
      For display purposes on the website.
      Returns:
      other commands, but linked.

    • getExample1

      public String getExample1()
      An example of the way the command is executed.
      Returns:
      For example "unwield pick from bothhands".

    • setExample1

      public void setExample1(String example1)

    • getExample1a

      public String getExample1a()
      Output of the example visible to you.
      Returns:
      For example "You open an old, iron chest.".

    • setExample1a

      public void setExample1a(String example1a)

    • getExample1b

      public String getExample1b()
      Output of the example visible to others.
      Returns:
      For example "Hotblack locks an old, iron chest with an old iron key."

    • setExample1b

      public void setExample1b(String example1b)

    • getExample2

      public String getExample2()
      An example of the way the command is executed to someone else.
      Returns:
      For example "tell to marvin Hey!".

    • setExample2

      public void setExample2(String example2)

    • getExample2a

      public String getExample2a()
      What the players sees.
      Returns:
      For example "You tell Marvin : Hey!".

    • setExample2a

      public void setExample2a(String example2a)

    • getExample2b

      public String getExample2b()
      What the target notices.
      Returns:
      For example "Hotblack tells you : Hey!".

    • setExample2b

      public void setExample2b(String example2b)

    • getExample2c

      public String getExample2c()
      What a third party sees.
      Returns:
      For example "Hotblack says [to Marvin]: Hey!".

    • setExample2c

      public void setExample2c(String example2c)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object object)
      Overrides:
      equals in class Object

    • getMainTitle

      public String getMainTitle()
      Description copied from interface: DisplayInterface
      The title as visible on the screen.
      Specified by:
      getMainTitle in interface DisplayInterface
      Returns:

    • getImage

      public String getImage()
      Description copied from interface: DisplayInterface
      Returns an url pointing to an image.
      Specified by:
      getImage in interface DisplayInterface
      Returns:

    • getBody

      public String getBody()
      Description copied from interface: DisplayInterface
      The body to be displayed on the screen. In general the first letter of the body is converted to an image on the client side.
      Specified by:
      getBody in interface DisplayInterface
      Returns:

    • toString

      public String toString()
      Overrides:
      toString in class Object