From ebc3a570aceb5c5d93c9536a250d3c05639fe9d5 Mon Sep 17 00:00:00 2001
From: dcrawl <james@dungeon-crawl.com>
Date: Sun, 29 Oct 2023 12:58:44 -0300
Subject: [PATCH] Create write_file.md

---
 docs/API/runtime/write_file.md | 12 ++++++++++++
 1 file changed, 12 insertions(+)
 create mode 100644 docs/API/runtime/write_file.md

diff --git a/docs/API/runtime/write_file.md b/docs/API/runtime/write_file.md
new file mode 100644
index 0000000..3f13124
--- /dev/null
+++ b/docs/API/runtime/write_file.md
@@ -0,0 +1,12 @@
+# write_file
+
+This function takes in two parameters. The first parameter is the file path and assumes the the game directory is the root. The second parameter is the string that will be written. The method **overwrites** whatever is currently in the file. Use [append_file](append_file.md) to append to the file as opposed to overwriting.
+
+```ruby
+def tick args
+  if args.inputs.mouse.click
+    args.gtk.write_file "last-mouse-click.txt", "Mouse was clicked at #{args.state.tick_count}."
+  end
+end
+```
+