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 >
Top Level Namespace
— 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 = "";
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< / a > »
< span class = "title" > Top Level Namespace< / 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 > Top Level Namespace
< / h1 >
< div class = "box_info" >
< / div >
< h2 > Defined Under Namespace< / h2 >
< p class = "children" >
2017-10-15 03:40:38 +00:00
< strong class = "modules" > Modules:< / strong > < span class = 'object_link' > < a href = "Dialogue.html" title = "Dialogue (module)" > Dialogue< / a > < / span > , < span class = 'object_link' > < a href = "Gardner.html" title = "Gardner (module)" > Gardner< / a > < / span > , < span class = 'object_link' > < a href = "Planter.html" title = "Planter (module)" > Planter< / a > < / span >
2017-05-06 22:12:33 +00:00
2017-10-15 03:40:38 +00:00
< strong class = "classes" > Classes:< / strong > < span class = 'object_link' > < a href = "Sapling.html" title = "Sapling (class)" > Sapling< / a > < / span >
2017-05-06 22:12:33 +00:00
< / p >
2017-05-07 20:59:34 +00:00
< h2 > Constant Summary< / h2 >
< dl class = "constants" >
< dt id = "SKELE_TRUNK_TEXT-constant" class = "" > SKELE_TRUNK_TEXT =
< div class = "docstring" >
< div class = "discussion" >
< p > The default trunk text of a new tree< / p >
2017-05-06 22:12:33 +00:00
2017-05-07 20:59:34 +00:00
< / div >
< / div >
< div class = "tags" >
2017-05-06 22:12:33 +00:00
2017-05-07 20:59:34 +00:00
< / div >
< / dt >
< dd > < pre class = "code" > < span class = 'tstring' > < span class = 'tstring_beg' > " < / span > < span class = 'tstring_content' > Welcome to the Sapling Editor. For details, please see the
documentation!< / span > < span class = 'tstring_end' > " < / span > < / span > < / pre > < / dd >
< dt id = "SKELE_BRANCH_TEXT-constant" class = "" > SKELE_BRANCH_TEXT =
< div class = "docstring" >
< div class = "discussion" >
< p > The default first-branch text of a new tree< / p >
2017-05-06 22:12:33 +00:00
2017-05-07 20:59:34 +00:00
< / div >
< / div >
< div class = "tags" >
< / div >
< / dt >
< dd > < pre class = "code" > < span class = 'tstring' > < span class = 'tstring_beg' > " < / span > < span class = 'tstring_content' > The first branch is always shown by default. It should act
as the introduction to the story. From here, the user enters your world!< / span > < span class = 'tstring_end' > " < / span > < / span > < / pre > < / dd >
< dt id = "SKELE_LEAF_TEXT-constant" class = "" > SKELE_LEAF_TEXT =
< div class = "docstring" >
< div class = "discussion" >
< p > The default first-leaf text of the first branch of a new tree. The leaf
points to it' s own branch. The only way out of the program is to either
force-quit or reply with option 0.< / p >
< / div >
< / div >
< div class = "tags" >
< / div >
< / dt >
< dd > < pre class = "code" > < span class = 'tstring' > < span class = 'tstring_beg' > " < / span > < span class = 'tstring_content' > Each branch can have any number of leaves, which represent
the options a user has on that branch. Each leaf points to another branch, or
can point to branch 0 to immediately exit.< / span > < span class = 'tstring_end' > " < / span > < / span > < / pre > < / dd >
< dt id = "SKELETON_TREE-constant" class = "" > SKELETON_TREE =
< div class = "docstring" >
< div class = "discussion" >
< p > The final tree< / p >
2017-05-06 22:12:33 +00:00
2017-05-07 20:59:34 +00:00
< / div >
< / div >
< div class = "tags" >
< / div >
< / dt >
< dd > < pre class = "code" > < span class = 'lbracket' > [< / span >
< span class = 'lbrace' > {< / span > < span class = 'tstring' > < span class = 'tstring_beg' > " < / span > < span class = 'tstring_content' > trunk< / span > < span class = 'tstring_end' > " < / span > < / span > < span class = 'op' > => < / span > < span class = 'tstring' > < span class = 'tstring_beg' > " < / span > < span class = 'embexpr_beg' > #{< / span > < span class = 'const' > < span class = 'object_link' > < a href = "top-level-namespace.html#SKELE_TRUNK_TEXT-constant" title = "SKELE_TRUNK_TEXT (constant)" > SKELE_TRUNK_TEXT< / a > < / span > < / span > < span class = 'embexpr_end' > }< / span > < span class = 'tstring_end' > " < / span > < / span > < span class = 'rbrace' > }< / span > < span class = 'comma' > ,< / span >
< span class = 'lbrace' > {< / span > < span class = 'tstring' > < span class = 'tstring_beg' > " < / span > < span class = 'tstring_content' > branch< / span > < span class = 'tstring_end' > " < / span > < / span > < span class = 'op' > => < / span > < span class = 'lbrace' > {< / span >
< span class = 'tstring' > < span class = 'tstring_beg' > " < / span > < span class = 'tstring_content' > number< / span > < span class = 'tstring_end' > " < / span > < / span > < span class = 'op' > => < / span > < span class = 'int' > 1< / span > < span class = 'comma' > ,< / span >
< span class = 'tstring' > < span class = 'tstring_beg' > " < / span > < span class = 'tstring_content' > text< / span > < span class = 'tstring_end' > " < / span > < / span > < span class = 'op' > => < / span > < span class = 'tstring' > < span class = 'tstring_beg' > " < / span > < span class = 'embexpr_beg' > #{< / span > < span class = 'const' > < span class = 'object_link' > < a href = "top-level-namespace.html#SKELE_BRANCH_TEXT-constant" title = "SKELE_BRANCH_TEXT (constant)" > SKELE_BRANCH_TEXT< / a > < / span > < / span > < span class = 'embexpr_end' > }< / span > < span class = 'tstring_end' > " < / span > < / span > < span class = 'comma' > ,< / span >
< span class = 'tstring' > < span class = 'tstring_beg' > " < / span > < span class = 'tstring_content' > leaf< / span > < span class = 'tstring_end' > " < / span > < / span > < span class = 'op' > => < / span > < span class = 'lbracket' > [< / span > < span class = 'lbrace' > {< / span >
< span class = 'tstring' > < span class = 'tstring_beg' > " < / span > < span class = 'tstring_content' > text< / span > < span class = 'tstring_end' > " < / span > < / span > < span class = 'op' > => < / span > < span class = 'tstring' > < span class = 'tstring_beg' > " < / span > < span class = 'embexpr_beg' > #{< / span > < span class = 'const' > < span class = 'object_link' > < a href = "top-level-namespace.html#SKELE_LEAF_TEXT-constant" title = "SKELE_LEAF_TEXT (constant)" > SKELE_LEAF_TEXT< / a > < / span > < / span > < span class = 'embexpr_end' > }< / span > < span class = 'tstring_end' > " < / span > < / span > < span class = 'comma' > ,< / span >
< span class = 'tstring' > < span class = 'tstring_beg' > " < / span > < span class = 'tstring_content' > branch< / span > < span class = 'tstring_end' > " < / span > < / span > < span class = 'op' > => < / span > < span class = 'int' > 1< / span >
< span class = 'rbrace' > }< / span > < span class = 'rbracket' > ]< / span >
< span class = 'rbrace' > }< / span >
< span class = 'rbrace' > }< / span >
< span class = 'rbracket' > ]< / span > < / pre > < / dd >
< / dl >
< 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 = "top-level-namespace.html#verify_tree-instance_method" title = "#verify_tree (instance method)" > #< strong > verify_tree< / strong > (file) ⇒ Boolean < / a >
< / span >
< span class = "summary_desc" > < div class = 'inline' >
< p > Verify that a file is a dialogue tree file.< / p >
< / div > < / span >
< / li >
< / ul >
< div id = "instance_method_details" class = "method_details_list" >
< h2 > Instance Method Details< / h2 >
< div class = "method_details first" >
< h3 class = "signature first" id = "verify_tree-instance_method" >
#< strong > verify_tree< / strong > (file) ⇒ < tt > Boolean< / tt >
< / h3 > < div class = "docstring" >
< div class = "discussion" >
< p > Verify that a file is a dialogue tree file.< / p >
< / div >
< / div >
< div class = "tags" >
< p class = "tag_title" > Parameters:< / p >
< ul class = "param" >
< li >
< span class = 'name' > file< / span >
< span class = 'type' > (< tt > File< / tt > )< / span >
—
< div class = 'inline' >
< p > The provided file< / p >
< / div >
< / li >
< / ul >
< p class = "tag_title" > Returns:< / p >
< ul class = "return" >
< li >
< span class = 'type' > (< tt > Boolean< / tt > )< / span >
—
< div class = 'inline' >
< p > True if the file is a tree; false otherwise< / p >
< / div >
< / li >
< / ul >
< / div > < table class = "source_code" >
< tr >
< td >
< pre class = "lines" >
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
2017-10-15 03:40:38 +00:00
58< / pre >
2017-05-07 20:59:34 +00:00
< / td >
< td >
< pre class = "code" > < span class = "info file" > # File 'lib/sapling/utility.rb', line 43< / span >
< span class = 'kw' > def< / span > < span class = 'id identifier rubyid_verify_tree' > verify_tree< / span > < span class = 'lparen' > (< / span > < span class = 'id identifier rubyid_file' > file< / span > < span class = 'rparen' > )< / span >
< span class = 'id identifier rubyid_results' > results< / span > < span class = 'op' > =< / span > < span class = 'lbracket' > [< / span > < span class = 'rbracket' > ]< / span >
< span class = 'kw' > begin< / span >
< span class = 'id identifier rubyid_tree' > tree< / span > < span class = 'op' > =< / 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_file' > file< / span > < span class = 'rparen' > )< / span >
< span class = 'id identifier rubyid_results' > results< / span > < span class = 'op' > < < < / span > < span class = 'id identifier rubyid_tree' > tree< / span > < span class = 'lbracket' > [< / span > < span class = 'int' > 0< / span > < span class = 'rbracket' > ]< / span > < span class = 'period' > .< / span > < span class = 'id identifier rubyid_keys' > keys< / span > < span class = 'period' > .< / span > < span class = 'id identifier rubyid_include?' > include?< / span > < span class = 'lparen' > (< / span > < span class = 'tstring' > < span class = 'tstring_beg' > " < / span > < span class = 'tstring_content' > trunk< / span > < span class = 'tstring_end' > " < / span > < / span > < span class = 'rparen' > )< / span >
< span class = 'id identifier rubyid_results' > results< / span > < span class = 'op' > < < < / span > < span class = 'id identifier rubyid_tree' > tree< / span > < span class = 'lbracket' > [< / span > < span class = 'int' > 1< / span > < span class = 'rbracket' > ]< / 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 = 'period' > .< / span > < span class = 'id identifier rubyid_keys' > keys< / span > < span class = 'period' > .< / span > < span class = 'id identifier rubyid_include?' > include?< / span > < span class = 'lparen' > (< / span > < span class = 'tstring' > < span class = 'tstring_beg' > " < / span > < span class = 'tstring_content' > number< / span > < span class = 'tstring_end' > " < / span > < / span > < span class = 'rparen' > )< / span >
< span class = 'id identifier rubyid_results' > results< / span > < span class = 'op' > < < < / span > < span class = 'id identifier rubyid_tree' > tree< / span > < span class = 'lbracket' > [< / span > < span class = 'int' > 1< / span > < span class = 'rbracket' > ]< / 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 = 'period' > .< / span > < span class = 'id identifier rubyid_keys' > keys< / span > < span class = 'period' > .< / span > < span class = 'id identifier rubyid_include?' > include?< / span > < span class = 'lparen' > (< / span > < span class = 'tstring' > < span class = 'tstring_beg' > " < / span > < span class = 'tstring_content' > text< / span > < span class = 'tstring_end' > " < / span > < / span > < span class = 'rparen' > )< / span >
< span class = 'id identifier rubyid_results' > results< / span > < span class = 'op' > < < < / span > < span class = 'id identifier rubyid_tree' > tree< / span > < span class = 'lbracket' > [< / span > < span class = 'int' > 1< / span > < span class = 'rbracket' > ]< / 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 = 'period' > .< / span > < span class = 'id identifier rubyid_keys' > keys< / span > < span class = 'period' > .< / span > < span class = 'id identifier rubyid_include?' > include?< / span > < span class = 'lparen' > (< / span > < span class = 'tstring' > < span class = 'tstring_beg' > " < / span > < span class = 'tstring_content' > leaf< / span > < span class = 'tstring_end' > " < / span > < / span > < span class = 'rparen' > )< / span >
< span class = 'kw' > rescue< / span >
< span class = 'id identifier rubyid_puts' > puts< / span > < span class = 'tstring' > < span class = 'tstring_beg' > " < / span > < span class = 'tstring_content' > Sorry chummer, I don' t think this is a tree.< / span > < span class = 'tstring_end' > " < / span > < / span >
< span class = 'id identifier rubyid_puts' > puts< / span > < span class = 'tstring' > < span class = 'tstring_beg' > " < / span > < span class = 'tstring_content' > Verify your YAML file is formatted properly.< / span > < span class = 'tstring_end' > " < / span > < / span >
< span class = 'id identifier rubyid_results' > results< / span > < span class = 'op' > < < < / span > < span class = 'kw' > false< / span >
< span class = 'kw' > end< / span >
< span class = 'id identifier rubyid_results' > results< / span > < span class = 'period' > .< / span > < span class = 'id identifier rubyid_include?' > include?< / span > < span class = 'lparen' > (< / span > < span class = 'kw' > false< / span > < span class = 'rparen' > )< / span > < span class = 'op' > ?< / span > < span class = 'kw' > false< / span > < span class = 'op' > :< / span > < span class = 'kw' > true< / 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 >
