From 70233f88ca30ded0ccb84261db88afabe906068f Mon Sep 17 00:00:00 2001
From: Piotr Usewicz <piotr@layer22.com>
Date: Thu, 12 Sep 2019 12:57:54 +0200
Subject: Document state

---
 dragon/args.rb | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/dragon/args.rb b/dragon/args.rb
index 0f39ede..cfd0502 100644
--- a/dragon/args.rb
+++ b/dragon/args.rb
@@ -163,10 +163,18 @@ module GTK
       @runtime
     end
 
+    # @return [OpenEntity] returns `OpenEntity` object that allows for storing state between ticks
+    # @example Storing a value in a state
+    #   args.state.player_score = 0
+    #   args.state.current_time = Time.now
     def state
       @state
     end
 
+    # @param value [OpenEntity] the new state object to use
+    # @return [OpenEntity] the new state object
+    # @example Overwriting the state object
+    #   args.state = OpenEntity.new
     def state= value
       @state = value
     end
-- 
cgit v1.2.3