2017-05-06 22:12:33 +00:00
<!DOCTYPE html>
< html >
< head >
< meta charset = "utf-8" >
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" >
< title >
2017-10-15 03:40:38 +00:00
Class: Sapling
2017-05-06 22:12:33 +00:00
— Sapling Documentation
< / title >
< link rel = "stylesheet" href = "css/style.css" type = "text/css" charset = "utf-8" / >
< link rel = "stylesheet" href = "css/common.css" type = "text/css" charset = "utf-8" / >
< script type = "text/javascript" charset = "utf-8" >
pathId = "Sapling";
relpath = '';
< / script >
< script type = "text/javascript" charset = "utf-8" src = "js/jquery.js" > < / script >
< script type = "text/javascript" charset = "utf-8" src = "js/app.js" > < / script >
< / head >
< body >
< div class = "nav_wrap" >
< iframe id = "nav" src = "class_list.html?1" > < / iframe >
< div id = "resizer" > < / div >
< / div >
< div id = "main" tabindex = "-1" >
< div id = "header" >
< div id = "menu" >
< a href = "_index.html" > Index (S)< / a > »
< span class = "title" > Sapling< / span >
< / div >
< div id = "search" >
< a class = "full_list_link" id = "class_list_link"
href="class_list.html">
< svg width = "24" height = "24" >
< rect x = "0" y = "4" width = "24" height = "4" rx = "1" ry = "1" > < / rect >
< rect x = "0" y = "12" width = "24" height = "4" rx = "1" ry = "1" > < / rect >
< rect x = "0" y = "20" width = "24" height = "4" rx = "1" ry = "1" > < / rect >
< / svg >
< / a >
< / div >
< div class = "clear" > < / div >
< / div >
2017-10-15 03:40:38 +00:00
< div id = "content" > < h1 > Class: Sapling
2017-05-06 22:12:33 +00:00
< / h1 >
< div class = "box_info" >
2017-10-15 03:40:38 +00:00
< dl >
< dt > Inherits:< / dt >
< dd >
< span class = "inheritName" > Thor< / span >
< ul class = "fullTree" >
< li > Object< / li >
< li class = "next" > Thor< / li >
< li class = "next" > Sapling< / li >
< / ul >
< a href = "#" class = "inheritanceTree" > show all< / a >
< / dd >
< / dl >
2017-05-06 22:12:33 +00:00
< dl >
< dt > Defined in:< / dt >
< dd > lib/sapling.rb< / dd >
< / dl >
< / div >
< h2 > Overview< / h2 > < div class = "docstring" >
< div class = "discussion" >
2017-10-15 03:40:38 +00:00
< p > The main Sapling interface.< / p >
2017-05-06 22:12:33 +00:00
< / div >
< / div >
< div class = "tags" >
2017-10-15 03:40:38 +00:00
< / div >
< h2 >
Instance Method Summary
< small > < a href = "#" class = "summary_toggle" > collapse< / a > < / small >
< / h2 >
< ul class = "summary" >
< li class = "public " >
< span class = "summary_signature" >
< a href = "#edit-instance_method" title = "#edit (instance method)" > #< strong > edit< / strong > (tree = ' ' ) ⇒ Object < / a >
< / span >
< span class = "summary_desc" > < div class = 'inline' > < / div > < / span >
< / li >
< li class = "public " >
< span class = "summary_signature" >
< a href = "#export-instance_method" title = "#export (instance method)" > #< strong > export< / strong > (tree) ⇒ Object < / a >
< / span >
< span class = "summary_desc" > < div class = 'inline' > < / div > < / span >
< / li >
< li class = "public " >
< span class = "summary_signature" >
< a href = "#read-instance_method" title = "#read (instance method)" > #< strong > read< / strong > (tree) ⇒ Object < / a >
< / span >
< span class = "summary_desc" > < div class = 'inline' > < / div > < / span >
< / li >
< li class = "public " >
< span class = "summary_signature" >
< a href = "#serve-instance_method" title = "#serve (instance method)" > #< strong > serve< / strong > (tree) ⇒ Object < / a >
< / span >
2017-05-06 22:12:33 +00:00
2017-10-15 03:40:38 +00:00
< span class = "summary_desc" > < div class = 'inline' > < / div > < / span >
< / li >
< / ul >
< div id = "instance_method_details" class = "method_details_list" >
< h2 > Instance Method Details< / h2 >
2017-05-06 22:12:33 +00:00
2017-10-15 03:40:38 +00:00
< div class = "method_details first" >
< h3 class = "signature first" id = "edit-instance_method" >
#< strong > edit< / strong > (tree = ' ' ) ⇒ < tt > Object< / tt >
2017-05-06 22:12:33 +00:00
2017-10-15 03:40:38 +00:00
< / h3 > < table class = "source_code" >
< tr >
< td >
< pre class = "lines" >
19
20
21
22
23
24
25
26
27
28
29
30< / pre >
< / td >
< td >
< pre class = "code" > < span class = "info file" > # File 'lib/sapling.rb', line 19< / span >
< span class = 'kw' > def< / span > < span class = 'id identifier rubyid_edit' > edit< / span > < span class = 'lparen' > (< / span > < span class = 'id identifier rubyid_tree' > tree< / span > < span class = 'op' > =< / span > < span class = 'tstring' > < span class = 'tstring_beg' > ' < / span > < span class = 'tstring_end' > ' < / span > < / span > < span class = 'rparen' > )< / span >
< span class = 'id identifier rubyid_puts' > puts< / span > < span class = 'tstring' > < span class = 'tstring_beg' > ' < / span > < span class = 'tstring_content' > Welcome to Sapling, a Dialogue Tree Utility.< / span > < span class = 'tstring_end' > ' < / span > < / span >
< span class = 'kw' > if< / span > < span class = 'op' > !< / span > < span class = 'id identifier rubyid_tree' > tree< / span > < span class = 'period' > .< / span > < span class = 'id identifier rubyid_empty?' > empty?< / span >
< span class = 'id identifier rubyid_puts' > puts< / span > < span class = 'tstring' > < span class = 'tstring_beg' > " < / span > < span class = 'tstring_content' > Loading tree: < / span > < span class = 'embexpr_beg' > #{< / span > < span class = 'id identifier rubyid_tree' > tree< / span > < span class = 'embexpr_end' > }< / span > < span class = 'tstring_end' > " < / span > < / span >
< span class = 'id identifier rubyid_exit' > exit< / span > < span class = 'kw' > unless< / span > < span class = 'id identifier rubyid_verify_tree' > < span class = 'object_link' > < a href = "top-level-namespace.html#verify_tree-instance_method" title = "#verify_tree (method)" > verify_tree< / a > < / span > < / span > < span class = 'lparen' > (< / span > < span class = 'id identifier rubyid_tree' > tree< / span > < span class = 'rparen' > )< / span >
< span class = 'id identifier rubyid_gardner' > gardner< / span > < span class = 'op' > =< / span > < span class = 'const' > < span class = 'object_link' > < a href = "Planter.html" title = "Planter (module)" > Planter< / a > < / span > < / span > < span class = 'op' > ::< / span > < span class = 'const' > < span class = 'object_link' > < a href = "Planter/Spade.html" title = "Planter::Spade (class)" > Spade< / a > < / span > < / span > < span class = 'period' > .< / span > < span class = 'id identifier rubyid_new' > < span class = 'object_link' > < a href = "Planter/Spade.html#initialize-instance_method" title = "Planter::Spade#initialize (method)" > new< / a > < / span > < / span > < span class = 'lparen' > (< / span > < span class = 'const' > YAML< / span > < span class = 'period' > .< / span > < span class = 'id identifier rubyid_load_file' > load_file< / span > < span class = 'lparen' > (< / span > < span class = 'id identifier rubyid_tree' > tree< / span > < span class = 'comma' > ,< / span > < span class = 'kw' > false< / span > < span class = 'rparen' > )< / span > < span class = 'rparen' > )< / span >
< span class = 'kw' > else< / span >
< span class = 'id identifier rubyid_puts' > puts< / span > < span class = 'tstring' > < span class = 'tstring_beg' > ' < / span > < span class = 'tstring_content' > Creating a new tree!< / span > < span class = 'tstring_end' > ' < / span > < / span >
< span class = 'id identifier rubyid_gardner' > gardner< / span > < span class = 'op' > =< / span > < span class = 'const' > < span class = 'object_link' > < a href = "Planter.html" title = "Planter (module)" > Planter< / a > < / span > < / span > < span class = 'op' > ::< / span > < span class = 'const' > < span class = 'object_link' > < a href = "Planter/Spade.html" title = "Planter::Spade (class)" > Spade< / a > < / span > < / span > < span class = 'period' > .< / span > < span class = 'id identifier rubyid_new' > < span class = 'object_link' > < a href = "Planter/Spade.html#initialize-instance_method" title = "Planter::Spade#initialize (method)" > new< / a > < / span > < / span > < span class = 'lparen' > (< / span > < span class = 'const' > < span class = 'object_link' > < a href = "top-level-namespace.html#SKELETON_TREE-constant" title = "SKELETON_TREE (constant)" > SKELETON_TREE< / a > < / span > < / span > < span class = 'rparen' > )< / span >
< span class = 'kw' > end< / span >
< span class = 'id identifier rubyid_gardner' > gardner< / span > < span class = 'period' > .< / span > < span class = 'id identifier rubyid_plant' > plant< / span >
< span class = 'kw' > end< / span > < / pre >
< / td >
< / tr >
< / table >
< / div >
2017-05-06 22:12:33 +00:00
2017-10-15 03:40:38 +00:00
< div class = "method_details " >
< h3 class = "signature " id = "export-instance_method" >
#< strong > export< / strong > (tree) ⇒ < tt > Object< / tt >
< / h3 > < table class = "source_code" >
< tr >
< td >
< pre class = "lines" >
39
40
41
42< / pre >
< / td >
< td >
< pre class = "code" > < span class = "info file" > # File 'lib/sapling.rb', line 39< / span >
< span class = 'kw' > def< / span > < span class = 'id identifier rubyid_export' > export< / span > < span class = 'lparen' > (< / span > < span class = 'id identifier rubyid_tree' > tree< / span > < span class = 'rparen' > )< / span >
< span class = 'id identifier rubyid_exit' > exit< / span > < span class = 'kw' > unless< / span > < span class = 'id identifier rubyid_verify_tree' > < span class = 'object_link' > < a href = "top-level-namespace.html#verify_tree-instance_method" title = "#verify_tree (method)" > verify_tree< / a > < / span > < / span > < span class = 'lparen' > (< / span > < span class = 'id identifier rubyid_tree' > tree< / span > < span class = 'rparen' > )< / span >
< span class = 'id identifier rubyid_puts' > puts< / span > < span class = 'tstring' > < span class = 'tstring_beg' > ' < / span > < span class = 'tstring_content' > Cool feature, bro!< / span > < span class = 'tstring_end' > ' < / span > < / span >
< span class = 'kw' > end< / span > < / pre >
< / td >
< / tr >
< / table >
< / div >
2017-05-06 22:12:33 +00:00
2017-10-15 03:40:38 +00:00
< div class = "method_details " >
< h3 class = "signature " id = "read-instance_method" >
#< strong > read< / strong > (tree) ⇒ < tt > Object< / tt >
2017-05-06 22:12:33 +00:00
2017-10-15 03:40:38 +00:00
2017-05-06 22:12:33 +00:00
2017-10-15 03:40:38 +00:00
< / h3 > < table class = "source_code" >
< tr >
< td >
< pre class = "lines" >
2017-05-06 22:12:33 +00:00
2017-10-15 03:40:38 +00:00
11
12
13
14
15
16< / pre >
< / td >
< td >
< pre class = "code" > < span class = "info file" > # File 'lib/sapling.rb', line 11< / span >
2017-05-06 22:12:33 +00:00
2017-10-15 03:40:38 +00:00
< span class = 'kw' > def< / span > < span class = 'id identifier rubyid_read' > read< / span > < span class = 'lparen' > (< / span > < span class = 'id identifier rubyid_tree' > tree< / span > < span class = 'rparen' > )< / span >
< span class = 'id identifier rubyid_exit' > exit< / span > < span class = 'kw' > unless< / span > < span class = 'id identifier rubyid_verify_tree' > < span class = 'object_link' > < a href = "top-level-namespace.html#verify_tree-instance_method" title = "#verify_tree (method)" > verify_tree< / a > < / span > < / span > < span class = 'lparen' > (< / span > < span class = 'id identifier rubyid_tree' > tree< / span > < span class = 'rparen' > )< / span >
< span class = 'id identifier rubyid_puts' > puts< / span > < span class = 'tstring' > < span class = 'tstring_beg' > ' < / span > < span class = 'tstring_content' > Welcome to Sapling, a Dialogue Tree Utility.< / span > < span class = 'tstring_end' > ' < / span > < / span >
< span class = 'id identifier rubyid_speaker' > speaker< / span > < span class = 'op' > =< / span > < span class = 'const' > < span class = 'object_link' > < a href = "Dialogue.html" title = "Dialogue (module)" > Dialogue< / a > < / span > < / span > < span class = 'op' > ::< / span > < span class = 'const' > < span class = 'object_link' > < a href = "Dialogue/Speaker.html" title = "Dialogue::Speaker (class)" > Speaker< / a > < / span > < / span > < span class = 'period' > .< / span > < span class = 'id identifier rubyid_new' > < span class = 'object_link' > < a href = "Dialogue/Speaker.html#initialize-instance_method" title = "Dialogue::Speaker#initialize (method)" > new< / a > < / span > < / span > < span class = 'lparen' > (< / span > < span class = 'const' > YAML< / span > < span class = 'period' > .< / span > < span class = 'id identifier rubyid_load_file' > load_file< / span > < span class = 'lparen' > (< / span > < span class = 'id identifier rubyid_tree' > tree< / span > < span class = 'rparen' > )< / span > < span class = 'comma' > ,< / span > < span class = 'kw' > false< / span > < span class = 'rparen' > )< / span >
< span class = 'id identifier rubyid_speaker' > speaker< / span > < span class = 'period' > .< / span > < span class = 'id identifier rubyid_conversation' > conversation< / span >
< span class = 'kw' > end< / span > < / pre >
< / td >
< / tr >
< / table >
< / div >
< div class = "method_details " >
< h3 class = "signature " id = "serve-instance_method" >
#< strong > serve< / strong > (tree) ⇒ < tt > Object< / tt >
2017-05-06 22:12:33 +00:00
2017-10-15 03:40:38 +00:00
2017-05-06 22:12:33 +00:00
2017-10-15 03:40:38 +00:00
< / h3 > < table class = "source_code" >
< tr >
< td >
< pre class = "lines" >
33
34
35
36< / pre >
< / td >
< td >
< pre class = "code" > < span class = "info file" > # File 'lib/sapling.rb', line 33< / span >
2017-05-06 22:12:33 +00:00
2017-10-15 03:40:38 +00:00
< span class = 'kw' > def< / span > < span class = 'id identifier rubyid_serve' > serve< / span > < span class = 'lparen' > (< / span > < span class = 'id identifier rubyid_tree' > tree< / span > < span class = 'rparen' > )< / span >
< span class = 'id identifier rubyid_exit' > exit< / span > < span class = 'kw' > unless< / span > < span class = 'id identifier rubyid_verify_tree' > < span class = 'object_link' > < a href = "top-level-namespace.html#verify_tree-instance_method" title = "#verify_tree (method)" > verify_tree< / a > < / span > < / span > < span class = 'lparen' > (< / span > < span class = 'id identifier rubyid_tree' > tree< / span > < span class = 'rparen' > )< / span >
< span class = 'id identifier rubyid_puts' > puts< / span > < span class = 'tstring' > < span class = 'tstring_beg' > ' < / span > < span class = 'tstring_content' > Sinatra will be cool.< / span > < span class = 'tstring_end' > ' < / span > < / span >
< span class = 'kw' > end< / span > < / pre >
< / td >
< / tr >
< / table >
< / div >
< / div >
2017-05-06 22:12:33 +00:00
< / div >
< div id = "footer" >
2017-10-15 03:40:38 +00:00
Generated on Sat Oct 14 23:40:01 2017 by
2017-05-06 22:12:33 +00:00
< a href = "http://yardoc.org" title = "Yay! A Ruby Documentation Tool" target = "_parent" > yard< / a >
2017-10-15 03:40:38 +00:00
0.9.9 (ruby-2.4.2).
2017-05-06 22:12:33 +00:00
< / div >
< / div >
< / body >
< / html >