aboutsummaryrefslogtreecommitdiff
path: root/src/scalevalapokalypsi/Model/Item.scala
diff options
context:
space:
mode:
authorJoel Kronqvist <joel.kronqvist@iki.fi>2024-11-17 13:45:44 +0200
committerJoel Kronqvist <joel.kronqvist@iki.fi>2024-11-17 13:45:44 +0200
commit4de67b497e0e229fe4a42f66f833640b6e50fd5a (patch)
tree34fb5b0e776f7cd3adcb4556f4d6a7c8ad66de39 /src/scalevalapokalypsi/Model/Item.scala
parent8595e892abc0e0554f589ed2eb88c351a347fbd4 (diff)
downloadscalevalapokalypsi-4de67b497e0e229fe4a42f66f833640b6e50fd5a.tar.gz
scalevalapokalypsi-4de67b497e0e229fe4a42f66f833640b6e50fd5a.zip
Moved the project to an IDEA project & wrote part of README.txt
Diffstat (limited to 'src/scalevalapokalypsi/Model/Item.scala')
-rw-r--r--src/scalevalapokalypsi/Model/Item.scala20
1 files changed, 20 insertions, 0 deletions
diff --git a/src/scalevalapokalypsi/Model/Item.scala b/src/scalevalapokalypsi/Model/Item.scala
new file mode 100644
index 0000000..7979480
--- /dev/null
+++ b/src/scalevalapokalypsi/Model/Item.scala
@@ -0,0 +1,20 @@
+package scalevalapokalypsi.Model
+
+import scala.annotation.targetName
+
+/** The class `Item` represents items in a text adventure game. Each item has a name
+ * and a longer description. (In later versions of the adventure game, items may
+ * have other features as well.)
+ *
+ * N.B. It is assumed, but not enforced by this class, that items have unique names.
+ * That is, no two items in a game world have the same name.
+ *
+ * @param name the item’s name
+ * @param description the item’s description */
+class Item(val name: String, val description: String):
+
+ /** Returns a short textual representation of the item (its name, that is). */
+ override def toString = this.name
+
+end Item
+