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 >
Module: Gardner
— 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 = "Gardner";
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 (G)< / a > »
< span class = "title" > Gardner< / 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 >
< div id = "content" > < h1 > Module: Gardner
< / h1 >
< div class = "box_info" >
< dl >
< dt > Defined in:< / dt >
2017-05-07 20:59:34 +00:00
< dd > lib/sapling/gardner.rb< / dd >
2017-05-06 22:12:33 +00:00
< / dl >
< / div >
< h2 > Overview< / h2 > < div class = "docstring" >
< div class = "discussion" >
< p > Gardner is the module for working with a dialogue tree file< / p >
< / div >
< / div >
< div class = "tags" >
< / div >
< h2 >
Class Method Summary
< small > < a href = "#" class = "summary_toggle" > collapse< / a > < / small >
< / h2 >
< ul class = "summary" >
< li class = "public " >
< span class = "summary_signature" >
< a href = "#prune_branches-class_method" title = "prune_branches (class method)" > .< strong > prune_branches< / strong > (tree) ⇒ Array < / a >
< / span >
< span class = "summary_desc" > < div class = 'inline' >
2017-10-15 03:40:38 +00:00
< p > Parse the tree array into an array of numbered branches, and ordered
leaves.< / p >
2017-05-06 22:12:33 +00:00
< / div > < / span >
< / li >
< li class = "public " >
< span class = "summary_signature" >
< a href = "#prune_leaves-class_method" title = "prune_leaves (class method)" > .< strong > prune_leaves< / strong > (leaves) ⇒ Hash < / a >
< / span >
< span class = "summary_desc" > < div class = 'inline' >
2017-10-15 03:40:38 +00:00
< p > Parse the leaves of a branch into a numbered hash of options.< / p >
2017-05-06 22:12:33 +00:00
< / div > < / span >
< / li >
< li class = "public " >
< span class = "summary_signature" >
2017-10-15 03:40:38 +00:00
< a href = "#prune_trunk-class_method" title = "prune_trunk (class method)" > .< strong > prune_trunk< / strong > (tree) ⇒ Array < / a >
2017-05-06 22:12:33 +00:00
< / span >
< span class = "summary_desc" > < div class = 'inline' >
2017-10-15 03:40:38 +00:00
< p > Parse the trunk of the tree.< / p >
2017-05-06 22:12:33 +00:00
< / div > < / span >
< / li >
< / ul >
< div id = "class_method_details" class = "method_details_list" >
< h2 > Class Method Details< / h2 >
< div class = "method_details first" >
2017-10-15 03:40:38 +00:00
< h3 class = "signature first" id = "prune_branches-class_method" >
2017-05-06 22:12:33 +00:00
.< strong > prune_branches< / strong > (tree) ⇒ < tt > Array< / tt >
< / h3 > < div class = "docstring" >
< div class = "discussion" >
2017-10-15 03:40:38 +00:00
< p > Parse the tree array into an array of numbered branches, and ordered
leaves.< / p >
2017-05-06 22:12:33 +00:00
< / div >
< / div >
< div class = "tags" >
< p class = "tag_title" > Parameters:< / p >
< ul class = "param" >
< li >
< span class = 'name' > tree< / span >
< span class = 'type' > (< tt > Array< / tt > )< / span >
—
< div class = 'inline' >
< p > The dialogue tree< / p >
< / div >
< / li >
< / ul >
< p class = "tag_title" > Returns:< / p >
< ul class = "return" >
< li >
< span class = 'type' > (< tt > Array< / tt > )< / span >
—
< div class = 'inline' >
2017-10-15 03:40:38 +00:00
< p > An array of numbered branches, with numbered leaves< / p >
2017-05-06 22:12:33 +00:00
< / div >
< / li >
< / ul >
< / div > < table class = "source_code" >
< tr >
< td >
< pre class = "lines" >
2017-05-07 20:59:34 +00:00
10
11
12
2017-05-06 22:12:33 +00:00
13
14
15
16
17
18
2017-10-15 03:40:38 +00:00
19< / pre >
2017-05-06 22:12:33 +00:00
< / td >
< td >
2017-05-07 20:59:34 +00:00
< pre class = "code" > < span class = "info file" > # File 'lib/sapling/gardner.rb', line 10< / span >
2017-05-06 22:12:33 +00:00
< span class = 'kw' > def< / span > < span class = 'kw' > self< / span > < span class = 'period' > .< / span > < span class = 'id identifier rubyid_prune_branches' > prune_branches< / span > < span class = 'lparen' > (< / span > < span class = 'id identifier rubyid_tree' > tree< / span > < span class = 'rparen' > )< / span >
< span class = 'id identifier rubyid_branches' > branches< / span > < span class = 'op' > =< / span > < span class = 'lbrace' > {< / span > < span class = 'int' > 0< / span > < span class = 'op' > => < / span > < span class = 'lbrace' > {< / span > < span class = 'tstring' > < span class = 'tstring_beg' > " < / span > < span class = 'tstring_content' > desc< / span > < span class = 'tstring_end' > " < / span > < / span > < span class = 'op' > => < / span > < span class = 'tstring' > < span class = 'tstring_beg' > " < / span > < span class = 'tstring_content' > Thanks for using Sapling!< / span > < span class = 'tstring_end' > " < / span > < / span > < span class = 'rbrace' > }< / span > < span class = 'rbrace' > }< / span >
< span class = 'id identifier rubyid_tree' > tree< / span > < span class = 'period' > .< / span > < span class = 'id identifier rubyid_each' > each< / span > < span class = 'kw' > do< / span > < span class = 'op' > |< / span > < span class = 'id identifier rubyid_b' > b< / span > < span class = 'op' > |< / span >
< span class = 'id identifier rubyid_branches' > branches< / span > < span class = 'lbracket' > [< / span > < span class = 'id identifier rubyid_b' > b< / span > < span class = 'lbracket' > [< / span > < span class = 'tstring' > < span class = 'tstring_beg' > " < / span > < span class = 'tstring_content' > branch< / span > < span class = 'tstring_end' > " < / span > < / span > < span class = 'rbracket' > ]< / span > < span class = 'lbracket' > [< / span > < span class = 'tstring' > < span class = 'tstring_beg' > " < / span > < span class = 'tstring_content' > number< / span > < span class = 'tstring_end' > " < / span > < / span > < span class = 'rbracket' > ]< / span > < span class = 'rbracket' > ]< / span > < span class = 'op' > =< / span > < span class = 'lbrace' > {< / span >
< span class = 'tstring' > < span class = 'tstring_beg' > " < / span > < span class = 'tstring_content' > desc< / span > < span class = 'tstring_end' > " < / span > < / span > < span class = 'op' > => < / span > < span class = 'id identifier rubyid_b' > b< / span > < span class = 'lbracket' > [< / span > < span class = 'tstring' > < span class = 'tstring_beg' > " < / span > < span class = 'tstring_content' > branch< / span > < span class = 'tstring_end' > " < / span > < / span > < span class = 'rbracket' > ]< / span > < span class = 'lbracket' > [< / span > < span class = 'tstring' > < span class = 'tstring_beg' > " < / span > < span class = 'tstring_content' > text< / span > < span class = 'tstring_end' > " < / span > < / span > < span class = 'rbracket' > ]< / span > < span class = 'comma' > ,< / span >
< span class = 'tstring' > < span class = 'tstring_beg' > " < / span > < span class = 'tstring_content' > options< / span > < span class = 'tstring_end' > " < / span > < / span > < span class = 'op' > => < / span > < span class = 'id identifier rubyid_prune_leaves' > prune_leaves< / span > < span class = 'lparen' > (< / span > < span class = 'id identifier rubyid_b' > b< / span > < span class = 'lbracket' > [< / span > < span class = 'tstring' > < span class = 'tstring_beg' > " < / span > < span class = 'tstring_content' > branch< / span > < span class = 'tstring_end' > " < / span > < / span > < span class = 'rbracket' > ]< / span > < span class = 'lbracket' > [< / span > < span class = 'tstring' > < span class = 'tstring_beg' > " < / span > < span class = 'tstring_content' > leaf< / span > < span class = 'tstring_end' > " < / span > < / span > < span class = 'rbracket' > ]< / span > < span class = 'rparen' > )< / span > < span class = 'rbrace' > }< / span >
< span class = 'kw' > end< / span >
< span class = 'kw' > return< / span > < span class = 'id identifier rubyid_branches' > branches< / span >
< span class = 'kw' > end< / span > < / pre >
< / td >
< / tr >
< / table >
< / div >
< div class = "method_details " >
< h3 class = "signature " id = "prune_leaves-class_method" >
.< strong > prune_leaves< / strong > (leaves) ⇒ < tt > Hash< / tt >
< / h3 > < div class = "docstring" >
< div class = "discussion" >
2017-10-15 03:40:38 +00:00
< p > Parse the leaves of a branch into a numbered hash of options.< / p >
2017-05-06 22:12:33 +00:00
< / div >
< / div >
< div class = "tags" >
< p class = "tag_title" > Parameters:< / p >
< ul class = "param" >
< li >
< span class = 'name' > leaves< / span >
< span class = 'type' > (< tt > Array< / tt > )< / span >
—
< div class = 'inline' >
< p > The option of leaf hashes< / p >
< / div >
< / li >
< / ul >
< p class = "tag_title" > Returns:< / p >
< ul class = "return" >
< li >
< span class = 'type' > (< tt > Hash< / tt > )< / span >
—
< div class = 'inline' >
2017-10-15 03:40:38 +00:00
< p > A numbered hash of options< / p >
2017-05-06 22:12:33 +00:00
< / div >
< / li >
< / ul >
< / div > < table class = "source_code" >
< tr >
< td >
< pre class = "lines" >
2017-10-15 03:40:38 +00:00
25
2017-05-07 20:59:34 +00:00
26
27
28
2017-05-06 22:12:33 +00:00
29
30
31
32
33
34
35
36
2017-10-15 03:40:38 +00:00
37< / pre >
2017-05-06 22:12:33 +00:00
< / td >
< td >
2017-10-15 03:40:38 +00:00
< pre class = "code" > < span class = "info file" > # File 'lib/sapling/gardner.rb', line 25< / span >
2017-05-06 22:12:33 +00:00
< span class = 'kw' > def< / span > < span class = 'kw' > self< / span > < span class = 'period' > .< / span > < span class = 'id identifier rubyid_prune_leaves' > prune_leaves< / span > < span class = 'lparen' > (< / span > < span class = 'id identifier rubyid_leaves' > leaves< / span > < span class = 'rparen' > )< / span >
< span class = 'id identifier rubyid_x' > x< / span > < span class = 'op' > =< / span > < span class = 'int' > 1< / span >
< span class = 'id identifier rubyid_options' > options< / span > < span class = 'op' > =< / span > < span class = 'lbrace' > {< / span > < span class = 'rbrace' > }< / span >
< span class = 'kw' > return< / span > < span class = 'id identifier rubyid_options' > options< / span > < span class = 'kw' > if< / span > < span class = 'id identifier rubyid_leaves' > leaves< / span > < span class = 'period' > .< / span > < span class = 'id identifier rubyid_nil?' > nil?< / span >
< span class = 'id identifier rubyid_leaves' > leaves< / span > < span class = 'period' > .< / span > < span class = 'id identifier rubyid_each' > each< / span > < span class = 'kw' > do< / span > < span class = 'op' > |< / span > < span class = 'id identifier rubyid_l' > l< / span > < span class = 'op' > |< / span >
< span class = 'id identifier rubyid_options' > options< / span > < span class = 'lbracket' > [< / span > < span class = 'id identifier rubyid_x' > x< / span > < span class = 'rbracket' > ]< / span > < span class = 'op' > =< / span > < span class = 'lbrace' > {< / span > < span class = 'id identifier rubyid_l' > l< / span > < span class = 'lbracket' > [< / span > < span class = 'tstring' > < span class = 'tstring_beg' > " < / span > < span class = 'tstring_content' > text< / span > < span class = 'tstring_end' > " < / span > < / span > < span class = 'rbracket' > ]< / span > < span class = 'op' > => < / span > < span class = 'id identifier rubyid_l' > l< / span > < span class = 'lbracket' > [< / span > < span class = 'tstring' > < span class = 'tstring_beg' > " < / span > < span class = 'tstring_content' > branch< / span > < span class = 'tstring_end' > " < / span > < / span > < span class = 'rbracket' > ]< / span > < span class = 'rbrace' > }< / span >
< span class = 'id identifier rubyid_x' > x< / span > < span class = 'op' > +=< / span > < span class = 'int' > 1< / span >
< span class = 'kw' > end< / span >
< span class = 'kw' > return< / span > < span class = 'id identifier rubyid_options' > options< / span >
< span class = 'kw' > end< / span > < / pre >
< / td >
< / tr >
< / table >
< / div >
< div class = "method_details " >
< h3 class = "signature " id = "prune_trunk-class_method" >
2017-10-15 03:40:38 +00:00
.< strong > prune_trunk< / strong > (tree) ⇒ < tt > Array< / tt >
2017-05-06 22:12:33 +00:00
< / h3 > < div class = "docstring" >
< div class = "discussion" >
2017-10-15 03:40:38 +00:00
< p > Parse the trunk of the tree.< / p >
2017-05-06 22:12:33 +00:00
< / div >
< / div >
< div class = "tags" >
< p class = "tag_title" > Parameters:< / p >
< ul class = "param" >
< li >
< span class = 'name' > tree< / span >
< span class = 'type' > (< tt > Hash< / tt > )< / span >
—
< div class = 'inline' >
< p > The entire tree< / p >
< / div >
< / li >
< / ul >
< p class = "tag_title" > Returns:< / p >
< ul class = "return" >
< li >
2017-10-15 03:40:38 +00:00
< span class = 'type' > (< tt > Array< / tt > )< / span >
2017-05-06 22:12:33 +00:00
—
< div class = 'inline' >
2017-10-15 03:40:38 +00:00
< p > The trunk, and the remainder of the tree< / p >
2017-05-06 22:12:33 +00:00
< / div >
< / li >
< / ul >
< / div > < table class = "source_code" >
< tr >
< td >
< pre class = "lines" >
2017-10-15 03:40:38 +00:00
43
44
45
2017-05-07 20:59:34 +00:00
46
2017-10-15 03:40:38 +00:00
47< / pre >
2017-05-06 22:12:33 +00:00
< / td >
< td >
2017-10-15 03:40:38 +00:00
< pre class = "code" > < span class = "info file" > # File 'lib/sapling/gardner.rb', line 43< / span >
2017-05-06 22:12:33 +00:00
< span class = 'kw' > def< / span > < span class = 'kw' > self< / span > < span class = 'period' > .< / span > < span class = 'id identifier rubyid_prune_trunk' > prune_trunk< / span > < span class = 'lparen' > (< / span > < span class = 'id identifier rubyid_tree' > tree< / span > < span class = 'rparen' > )< / span >
< span class = 'id identifier rubyid_trunk' > trunk< / span > < span class = 'op' > =< / span > < span class = 'id identifier rubyid_tree' > tree< / span > < span class = 'period' > .< / span > < span class = 'id identifier rubyid_shift' > shift< / span >
2017-10-15 03:40:38 +00:00
< span class = 'kw' > return< / span > < span class = 'lbracket' > [< / span > < span class = 'id identifier rubyid_trunk' > trunk< / span > < span class = 'comma' > ,< / span > < span class = 'id identifier rubyid_tree' > tree< / span > < span class = 'rbracket' > ]< / span >
2017-05-06 22:12:33 +00:00
< span class = 'kw' > end< / span > < / pre >
< / td >
< / tr >
< / table >
< / div >
< / div >
< / 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 >
