simon/the-great-game
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity
the-great-game/docs/codox/index.html
Simon Brooke 71cfda093d Massive code clean-up, all tests still pass. 
...but I'm still struggling to understand how it works and how I
use it. Memo to self: document your code better.
2024-04-08 22:29:21 +01:00

30 lines
37 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html PUBLIC ""
"">
<html><head><meta charset="UTF-8" /><title>The-great-game 0.1.3-SNAPSHOT</title><link rel="stylesheet" type="text/css" href="css/default.css" /><link rel="stylesheet" type="text/css" href="css/highlight.css" /><script type="text/javascript" src="js/highlight.min.js"></script><script type="text/javascript" src="js/jquery.min.js"></script><script type="text/javascript" src="js/page_effects.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div id="header"><h2>Generated by <a href="https://github.com/weavejester/codox">Codox</a></h2><h1><a href="index.html"><span class="project-title"><span class="project-name">The-great-game</span> <span class="project-version">0.1.3-SNAPSHOT</span></span></a></h1></div><div class="sidebar primary"><h3 class="no-link"><span class="inner">Project</span></h3><ul class="index-link"><li class="depth-1 current"><a href="index.html"><div class="inner">Index</div></a></li></ul><h3 class="no-link"><span class="inner">Topics</span></h3><ul><li class="depth-1"><a href="A-generic-planning-algorithm-for-craftworker-npcs.html"><div class="inner"><span>A Generic Planning Algorithm for craftworker NPCs</span></div></a></li><li class="depth-1"><a href="API_Spec.html"><div class="inner"><span>API Spec (unfinished)</span></div></a></li><li class="depth-1"><a href="Appraisal.html"><div class="inner"><span>Appraisal (unfinished)</span></div></a></li><li class="depth-1"><a href="Baking-the-world.html"><div class="inner"><span>Baking the world</span></div></a></li><li class="depth-1"><a href="Biomes_and_ecology.html"><div class="inner"><span>Biomes and ecology (unfinished)</span></div></a></li><li class="depth-1"><a href="Building_on_microworld.html"><div class="inner"><span>Building on Microworld</span></div></a></li><li class="depth-1"><a href="Canonical-dictionary.html"><div class="inner"><span>Canonical dictionary for this documentation</span></div></a></li><li class="depth-1"><a href="Division_of_tasks_between_server_and_client.html"><div class="inner"><span>Division of tasks between server and client</span></div></a></li><li class="depth-1"><a href="Dynamic-consequences.html"><div class="inner"><span>On the consequences of a dynamic game environment for storytelling</span></div></a></li><li class="depth-1"><a href="Economy.html"><div class="inner"><span>Game world economy</span></div></a></li><li class="depth-1"><a href="Further-reading.html"><div class="inner"><span>Further Reading (and watching)</span></div></a></li><li class="depth-1"><a href="Game-engine-integration.html"><div class="inner"><span>Game-engine integration (unfinished)</span></div></a></li><li class="depth-1"><a href="Game_Play.html"><div class="inner"><span>Game Play</span></div></a></li><li class="depth-1"><a href="Genetic-buildings.html"><div class="inner"><span>Genetic Buildings</span></div></a></li><li class="depth-1"><a href="Gossip_scripted_plot_and_Johnny_Silverhand.html"><div class="inner"><span>Gossip, scripted plot, and Johnny Silverhand</span></div></a></li><li class="depth-1"><a href="MVP-Roadmap.html"><div class="inner"><span>Minimum Viable Product, and a road map</span></div></a></li><li class="depth-1"><a href="Modelling_democracy_and_morale.html"><div class="inner"><span>The Red Company: modelling democracy and morale (unfinished)</span></div></a></li><li class="depth-1"><a href="Modelling_trading_cost_and_risk.html"><div class="inner"><span>Modelling trading cost and risk (unfinished)</span></div></a></li><li class="depth-1"><a href="Naming-of-characters.html"><div class="inner"><span>Naming of Characters</span></div></a></li><li class="depth-1"><a href="Not_my_problem.html"><div class="inner"><span> Not my problem</span></div></a></li><li class="depth-1"><a href="On-dying.html"><div class="inner"><span>On Dying, and Injury</span></div></a></li><li class="depth-1"><a href="On-sex-and-sexual-violence.html"><div class="inner"><span>On Sex, and Sexual Violence, in Games</span></div></a></li><li class="depth-1"><a href="Organic_Quests.html"><div class="inner"><span>Organic Quests</span></div></a></li><li class="depth-1"><a href="Pathmaking.html"><div class="inner"><span>Pathmaking</span></div></a></li><li class="depth-1"><a href="Populating-a-game-world.html"><div class="inner"><span>Populating a game world</span></div></a></li><li class="depth-1"><a href="Roadmap.html"><div class="inner"><span>Roadmap (obsolete)</span></div></a></li><li class="depth-1"><a href="Sandbox.html"><div class="inner"><span>Sandbox</span></div></a></li><li class="depth-1"><a href="Selecting_Character.html"><div class="inner"><span>Selecting the Player Character</span></div></a></li><li class="depth-1"><a href="Settling-a-game-world.html"><div class="inner"><span>Settling a game world</span></div></a></li><li class="depth-1"><a href="Sexual-dimorphism.html"><div class="inner"><span>Sexual dimorphism</span></div></a></li><li class="depth-1"><a href="Simulation-layers.html"><div class="inner"><span>Simulation layers</span></div></a></li><li class="depth-1"><a href="The-spread-of-knowledge-in-a-large-game-world.html"><div class="inner"><span>The spread of knowledge in a large game world</span></div></a></li><li class="depth-1"><a href="Things_Voice_Interaction_Enables.html"><div class="inner"><span>Things Voice Interaction Enables</span></div></a></li><li class="depth-1"><a href="Uncanny_dialogue.html"><div class="inner"><span>The Uncanny Valley, and dynamically generated dialogue</span></div></a></li><li class="depth-1"><a href="Voice-acting-considered-harmful.html"><div class="inner"><span>Voice acting considered harmful</span></div></a></li><li class="depth-1"><a href="intro.html"><div class="inner"><span>Introduction to the-great-game</span></div></a></li></ul><h3 class="no-link"><span class="inner">Namespaces</span></h3><ul><li class="depth-1"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>cc</span></div></div></li><li class="depth-2"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>journeyman</span></div></div></li><li class="depth-3"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>the-great-game</span></div></div></li><li class="depth-4"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>agent</span></div></div></li><li class="depth-5 branch"><a href="cc.journeyman.the-great-game.agent.agent.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>agent</span></div></a></li><li class="depth-5"><a href="cc.journeyman.the-great-game.agent.schedule.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>schedule</span></div></a></li><li class="depth-4"><div class="no-link"><div class="inner"><span class="tree" style="top: -83px;"><span class="top" style="height: 92px;"></span><span class="bottom"></span></span><span>buildings</span></div></div></li><li class="depth-5 branch"><a href="cc.journeyman.the-great-game.buildings.module.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>module</span></div></a></li><li class="depth-5"><a href="cc.journeyman.the-great-game.buildings.rectangular.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>rectangular</span></div></a></li><li class="depth-4"><div class="no-link"><div class="inner"><span class="tree" style="top: -83px;"><span class="top" style="height: 92px;"></span><span class="bottom"></span></span><span>gossip</span></div></div></li><li class="depth-5 branch"><a href="cc.journeyman.the-great-game.gossip.gossip.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>gossip</span></div></a></li><li class="depth-5"><a href="cc.journeyman.the-great-game.gossip.news-items.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>news-items</span></div></a></li><li class="depth-4"><div class="no-link"><div class="inner"><span class="tree" style="top: -83px;"><span class="top" style="height: 92px;"></span><span class="bottom"></span></span><span>holdings</span></div></div></li><li class="depth-5"><a href="cc.journeyman.the-great-game.holdings.holding.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>holding</span></div></a></li><li class="depth-4"><div class="no-link"><div class="inner"><span class="tree" style="top: -52px;"><span class="top" style="height: 61px;"></span><span class="bottom"></span></span><span>location</span></div></div></li><li class="depth-5"><a href="cc.journeyman.the-great-game.location.location.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>location</span></div></a></li><li class="depth-4"><div class="no-link"><div class="inner"><span class="tree" style="top: -52px;"><span class="top" style="height: 61px;"></span><span class="bottom"></span></span><span>lore</span></div></div></li><li class="depth-5"><a href="cc.journeyman.the-great-game.lore.digester.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>digester</span></div></a></li><li class="depth-4"><div class="no-link"><div class="inner"><span class="tree" style="top: -52px;"><span class="top" style="height: 61px;"></span><span class="bottom"></span></span><span>merchants</span></div></div></li><li class="depth-5 branch"><a href="cc.journeyman.the-great-game.merchants.markets.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>markets</span></div></a></li><li class="depth-5 branch"><a href="cc.journeyman.the-great-game.merchants.merchant-utils.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>merchant-utils</span></div></a></li><li class="depth-5 branch"><a href="cc.journeyman.the-great-game.merchants.merchants.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>merchants</span></div></a></li><li class="depth-5 branch"><a href="cc.journeyman.the-great-game.merchants.planning.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>planning</span></div></a></li><li class="depth-5"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>strategies</span></div></div></li><li class="depth-6"><a href="cc.journeyman.the-great-game.merchants.strategies.simple.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>simple</span></div></a></li><li class="depth-4"><div class="no-link"><div class="inner"><span class="tree" style="top: -207px;"><span class="top" style="height: 216px;"></span><span class="bottom"></span></span><span>objects</span></div></div></li><li class="depth-5 branch"><a href="cc.journeyman.the-great-game.objects.character.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>character</span></div></a></li><li class="depth-5 branch"><a href="cc.journeyman.the-great-game.objects.container.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>container</span></div></a></li><li class="depth-5"><a href="cc.journeyman.the-great-game.objects.game-object.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>game-object</span></div></a></li><li class="depth-4 branch"><a href="cc.journeyman.the-great-game.playroom.html"><div class="inner"><span class="tree" style="top: -114px;"><span class="top" style="height: 123px;"></span><span class="bottom"></span></span><span>playroom</span></div></a></li><li class="depth-4"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>proving</span></div></div></li><li class="depth-5 branch"><a href="cc.journeyman.the-great-game.proving.core.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>core</span></div></a></li><li class="depth-5"><a href="cc.journeyman.the-great-game.proving.sketches.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>sketches</span></div></a></li><li class="depth-4 branch"><a href="cc.journeyman.the-great-game.time.html"><div class="inner"><span class="tree" style="top: -83px;"><span class="top" style="height: 92px;"></span><span class="bottom"></span></span><span>time</span></div></a></li><li class="depth-4 branch"><a href="cc.journeyman.the-great-game.utils.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>utils</span></div></a></li><li class="depth-4"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>world</span></div></div></li><li class="depth-5 branch"><a href="cc.journeyman.the-great-game.world.heightmap.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>heightmap</span></div></a></li><li class="depth-5 branch"><a href="cc.journeyman.the-great-game.world.location.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>location</span></div></a></li><li class="depth-5 branch"><a href="cc.journeyman.the-great-game.world.mw.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>mw</span></div></a></li><li class="depth-5 branch"><a href="cc.journeyman.the-great-game.world.routes.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>routes</span></div></a></li><li class="depth-5"><a href="cc.journeyman.the-great-game.world.world.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>world</span></div></a></li></ul></div><div class="namespace-index" id="content"><h1><span class="project-title"><span class="project-name">The-great-game</span> <span class="project-version">0.1.3-SNAPSHOT</span></span></h1><h5 class="license">Released under the <a href="https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html">GNU General Public License,version 2.0 or (at your option) any later version</a></h5><div class="doc"><p>Prototype code towards the great game I've been writing about for ten years, and know I will never finish.</p></div><h2>Installation</h2><p>To install, add the following dependency to your project or build file:</p><pre class="deps">[journeyman-cc/the-great-game "0.1.3-SNAPSHOT"]</pre><h2>Topics</h2><ul class="topics"><li><a href="A-generic-planning-algorithm-for-craftworker-npcs.html">A Generic Planning Algorithm for craftworker NPCs</a></li><li><a href="API_Spec.html">API Spec (unfinished)</a></li><li><a href="Appraisal.html">Appraisal (unfinished)</a></li><li><a href="Baking-the-world.html">Baking the world</a></li><li><a href="Biomes_and_ecology.html">Biomes and ecology (unfinished)</a></li><li><a href="Building_on_microworld.html">Building on Microworld</a></li><li><a href="Canonical-dictionary.html">Canonical dictionary for this documentation</a></li><li><a href="Division_of_tasks_between_server_and_client.html">Division of tasks between server and client</a></li><li><a href="Dynamic-consequences.html">On the consequences of a dynamic game environment for storytelling</a></li><li><a href="Economy.html">Game world economy</a></li><li><a href="Further-reading.html">Further Reading (and watching)</a></li><li><a href="Game-engine-integration.html">Game-engine integration (unfinished)</a></li><li><a href="Game_Play.html">Game Play</a></li><li><a href="Genetic-buildings.html">Genetic Buildings</a></li><li><a href="Gossip_scripted_plot_and_Johnny_Silverhand.html">Gossip, scripted plot, and Johnny Silverhand</a></li><li><a href="MVP-Roadmap.html">Minimum Viable Product, and a road map</a></li><li><a href="Modelling_democracy_and_morale.html">The Red Company: modelling democracy and morale (unfinished)</a></li><li><a href="Modelling_trading_cost_and_risk.html">Modelling trading cost and risk (unfinished)</a></li><li><a href="Naming-of-characters.html">Naming of Characters</a></li><li><a href="Not_my_problem.html"> Not my problem</a></li><li><a href="On-dying.html">On Dying, and Injury</a></li><li><a href="On-sex-and-sexual-violence.html">On Sex, and Sexual Violence, in Games</a></li><li><a href="Organic_Quests.html">Organic Quests</a></li><li><a href="Pathmaking.html">Pathmaking</a></li><li><a href="Populating-a-game-world.html">Populating a game world</a></li><li><a href="Roadmap.html">Roadmap (obsolete)</a></li><li><a href="Sandbox.html">Sandbox</a></li><li><a href="Selecting_Character.html">Selecting the Player Character</a></li><li><a href="Settling-a-game-world.html">Settling a game world</a></li><li><a href="Sexual-dimorphism.html">Sexual dimorphism</a></li><li><a href="Simulation-layers.html">Simulation layers</a></li><li><a href="The-spread-of-knowledge-in-a-large-game-world.html">The spread of knowledge in a large game world</a></li><li><a href="Things_Voice_Interaction_Enables.html">Things Voice Interaction Enables</a></li><li><a href="Uncanny_dialogue.html">The Uncanny Valley, and dynamically generated dialogue</a></li><li><a href="Voice-acting-considered-harmful.html">Voice acting considered harmful</a></li><li><a href="intro.html">Introduction to the-great-game</a></li></ul><h2>Namespaces</h2><div class="namespace"><h3><a href="cc.journeyman.the-great-game.agent.agent.html">cc.journeyman.the-great-game.agent.agent</a></h3><div class="doc"><div class="markdown"><p>Anything in the game world with agency; primarily but not exclusively characters.</p>
</div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="cc.journeyman.the-great-game.agent.agent.html#var-ProtoAgent">ProtoAgent</a> </li></ul></div></div><div class="namespace"><h3><a href="cc.journeyman.the-great-game.agent.schedule.html">cc.journeyman.the-great-game.agent.schedule</a></h3><div class="doc"><div class="markdown"><p>Schedules of plans for actors in the game, in order that they may have daily and seasonal patterns of behaviour.</p>
</div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="cc.journeyman.the-great-game.agent.schedule.html#var-plan-scheduled-action">plan-scheduled-action</a> </li></ul></div></div><div class="namespace"><h3><a href="cc.journeyman.the-great-game.buildings.module.html">cc.journeyman.the-great-game.buildings.module</a></h3><div class="doc"><div class="markdown"><p>A module of a building; essentially something like a portacabin, which can be assembled together with other modules to make a complete building.</p>
</div></div><div class="index"><p>Public variables and functions:</p><ul></ul></div></div><div class="namespace"><h3><a href="cc.journeyman.the-great-game.buildings.rectangular.html">cc.journeyman.the-great-game.buildings.rectangular</a></h3><div class="doc"><div class="markdown"><p>Build buildings with a generally rectangular floow plan.</p>
</div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="cc.journeyman.the-great-game.buildings.rectangular.html#var-*building-families*">*building-families*</a> </li><li> <a href="cc.journeyman.the-great-game.buildings.rectangular.html#var-*crafts*">*crafts*</a> </li><li> <a href="cc.journeyman.the-great-game.buildings.rectangular.html#var-*cultures*">*cultures*</a> </li><li> <a href="cc.journeyman.the-great-game.buildings.rectangular.html#var-*terrain-types*">*terrain-types*</a> </li><li> <a href="cc.journeyman.the-great-game.buildings.rectangular.html#var-build.21">build!</a> </li><li> <a href="cc.journeyman.the-great-game.buildings.rectangular.html#var-building-family">building-family</a> </li></ul></div></div><div class="namespace"><h3><a href="cc.journeyman.the-great-game.gossip.gossip.html">cc.journeyman.the-great-game.gossip.gossip</a></h3><div class="doc"><div class="markdown"><p>Interchange of news events between gossip agents.</p>
</div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="cc.journeyman.the-great-game.gossip.gossip.html#var-dialogue">dialogue</a> </li><li> <a href="cc.journeyman.the-great-game.gossip.gossip.html#var-gather-news">gather-news</a> </li><li> <a href="cc.journeyman.the-great-game.gossip.gossip.html#var-move-gossip">move-gossip</a> </li><li> <a href="cc.journeyman.the-great-game.gossip.gossip.html#var-run">run</a> </li></ul></div></div><div class="namespace"><h3><a href="cc.journeyman.the-great-game.gossip.news-items.html">cc.journeyman.the-great-game.gossip.news-items</a></h3><div class="doc"><div class="markdown"><p>Using news items (propositions) to transfer knowledge between gossip agents.</p>
</div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="cc.journeyman.the-great-game.gossip.news-items.html#var-all-known-verbs">all-known-verbs</a> </li><li> <a href="cc.journeyman.the-great-game.gossip.news-items.html#var-compatible-item.3F">compatible-item?</a> </li><li> <a href="cc.journeyman.the-great-game.gossip.news-items.html#var-compatible-value.3F">compatible-value?</a> </li><li> <a href="cc.journeyman.the-great-game.gossip.news-items.html#var-degrade-character">degrade-character</a> </li><li> <a href="cc.journeyman.the-great-game.gossip.news-items.html#var-degrade-location">degrade-location</a> </li><li> <a href="cc.journeyman.the-great-game.gossip.news-items.html#var-degrade-news-item">degrade-news-item</a> </li><li> <a href="cc.journeyman.the-great-game.gossip.news-items.html#var-infer">infer</a> </li><li> <a href="cc.journeyman.the-great-game.gossip.news-items.html#var-interest-in-character">interest-in-character</a> </li><li> <a href="cc.journeyman.the-great-game.gossip.news-items.html#var-interest-in-location">interest-in-location</a> </li><li> <a href="cc.journeyman.the-great-game.gossip.news-items.html#var-interesting-character.3F">interesting-character?</a> </li><li> <a href="cc.journeyman.the-great-game.gossip.news-items.html#var-interesting-item.3F">interesting-item?</a> </li><li> <a href="cc.journeyman.the-great-game.gossip.news-items.html#var-interesting-location.3F">interesting-location?</a> </li><li> <a href="cc.journeyman.the-great-game.gossip.news-items.html#var-interesting-object.3F">interesting-object?</a> </li><li> <a href="cc.journeyman.the-great-game.gossip.news-items.html#var-interesting-verb.3F">interesting-verb?</a> </li><li> <a href="cc.journeyman.the-great-game.gossip.news-items.html#var-known-item.3F">known-item?</a> </li><li> <a href="cc.journeyman.the-great-game.gossip.news-items.html#var-learn-news-item">learn-news-item</a> </li><li> <a href="cc.journeyman.the-great-game.gossip.news-items.html#var-make-all-inferences">make-all-inferences</a> </li><li> <a href="cc.journeyman.the-great-game.gossip.news-items.html#var-news-topics">news-topics</a> </li></ul></div></div><div class="namespace"><h3><a href="cc.journeyman.the-great-game.holdings.holding.html">cc.journeyman.the-great-game.holdings.holding</a></h3><div class="doc"><div class="markdown"><p><strong>TODO</strong>: write docs</p>
</div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="cc.journeyman.the-great-game.holdings.holding.html#var-ProtoHolding">ProtoHolding</a> </li></ul></div></div><div class="namespace"><h3><a href="cc.journeyman.the-great-game.location.location.html">cc.journeyman.the-great-game.location.location</a></h3><div class="doc"><div class="markdown"><p><strong>TODO</strong>: write docs</p>
</div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="cc.journeyman.the-great-game.location.location.html#var-ProtoLocation">ProtoLocation</a> </li></ul></div></div><div class="namespace"><h3><a href="cc.journeyman.the-great-game.lore.digester.html">cc.journeyman.the-great-game.lore.digester</a></h3><div class="doc"><div class="markdown"><p><strong>TODO</strong>: write docs</p>
</div></div><div class="index"><p>Public variables and functions:</p><ul></ul></div></div><div class="namespace"><h3><a href="cc.journeyman.the-great-game.merchants.markets.html">cc.journeyman.the-great-game.merchants.markets</a></h3><div class="doc"><div class="markdown"><p>Adjusting quantities and prices in markets.</p>
</div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="cc.journeyman.the-great-game.merchants.markets.html#var-adjust-quantity-and-price">adjust-quantity-and-price</a> </li><li> <a href="cc.journeyman.the-great-game.merchants.markets.html#var-new-price">new-price</a> </li><li> <a href="cc.journeyman.the-great-game.merchants.markets.html#var-run">run</a> </li><li> <a href="cc.journeyman.the-great-game.merchants.markets.html#var-update-markets">update-markets</a> </li></ul></div></div><div class="namespace"><h3><a href="cc.journeyman.the-great-game.merchants.merchant-utils.html">cc.journeyman.the-great-game.merchants.merchant-utils</a></h3><div class="doc"><div class="markdown"><p>Useful functions for doing low-level things with merchants.</p>
</div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="cc.journeyman.the-great-game.merchants.merchant-utils.html#var-add-known-prices">add-known-prices</a> </li><li> <a href="cc.journeyman.the-great-game.merchants.merchant-utils.html#var-add-stock">add-stock</a> </li><li> <a href="cc.journeyman.the-great-game.merchants.merchant-utils.html#var-burden">burden</a> </li><li> <a href="cc.journeyman.the-great-game.merchants.merchant-utils.html#var-can-afford">can-afford</a> </li><li> <a href="cc.journeyman.the-great-game.merchants.merchant-utils.html#var-can-carry">can-carry</a> </li><li> <a href="cc.journeyman.the-great-game.merchants.merchant-utils.html#var-expected-price">expected-price</a> </li></ul></div></div><div class="namespace"><h3><a href="cc.journeyman.the-great-game.merchants.merchants.html">cc.journeyman.the-great-game.merchants.merchants</a></h3><div class="doc"><div class="markdown"><p>Trade planning for merchants, primarily.</p>
</div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="cc.journeyman.the-great-game.merchants.merchants.html#var-run">run</a> </li></ul></div></div><div class="namespace"><h3><a href="cc.journeyman.the-great-game.merchants.planning.html">cc.journeyman.the-great-game.merchants.planning</a></h3><div class="doc"><div class="markdown"><p>Trade planning for merchants, primarily. This follows a simple-minded generate-and-test strategy and currently generates plans for all possible routes from the current location. This may not scale. Also, routes do not currently have cost or risk associated with them.</p>
</div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="cc.journeyman.the-great-game.merchants.planning.html#var-augment-plan">augment-plan</a> </li><li> <a href="cc.journeyman.the-great-game.merchants.planning.html#var-generate-trade-plans">generate-trade-plans</a> </li><li> <a href="cc.journeyman.the-great-game.merchants.planning.html#var-nearest-with-targets">nearest-with-targets</a> </li><li> <a href="cc.journeyman.the-great-game.merchants.planning.html#var-plan-trade">plan-trade</a> </li><li> <a href="cc.journeyman.the-great-game.merchants.planning.html#var-select-cargo">select-cargo</a> </li></ul></div></div><div class="namespace"><h3><a href="cc.journeyman.the-great-game.merchants.strategies.simple.html">cc.journeyman.the-great-game.merchants.strategies.simple</a></h3><div class="doc"><div class="markdown"><p>Default trading strategy for merchants.</p>
</div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="cc.journeyman.the-great-game.merchants.strategies.simple.html#var-move-merchant">move-merchant</a> </li><li> <a href="cc.journeyman.the-great-game.merchants.strategies.simple.html#var-plan-and-buy">plan-and-buy</a> </li><li> <a href="cc.journeyman.the-great-game.merchants.strategies.simple.html#var-re-plan">re-plan</a> </li><li> <a href="cc.journeyman.the-great-game.merchants.strategies.simple.html#var-sell-and-buy">sell-and-buy</a> </li></ul></div></div><div class="namespace"><h3><a href="cc.journeyman.the-great-game.objects.character.html">cc.journeyman.the-great-game.objects.character</a></h3><div class="doc"><div class="markdown"><p><strong>TODO</strong>: write docs</p>
</div></div><div class="index"><p>Public variables and functions:</p><ul></ul></div></div><div class="namespace"><h3><a href="cc.journeyman.the-great-game.objects.container.html">cc.journeyman.the-great-game.objects.container</a></h3><div class="doc"><div class="markdown"><p><strong>TODO</strong>: write docs</p>
</div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="cc.journeyman.the-great-game.objects.container.html#var-ProtoContainer">ProtoContainer</a> </li></ul></div></div><div class="namespace"><h3><a href="cc.journeyman.the-great-game.objects.game-object.html">cc.journeyman.the-great-game.objects.game-object</a></h3><div class="doc"><div class="markdown"><p>Anything at all in the game world</p>
</div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="cc.journeyman.the-great-game.objects.game-object.html#var-ProtoObject">ProtoObject</a> </li></ul></div></div><div class="namespace"><h3><a href="cc.journeyman.the-great-game.playroom.html">cc.journeyman.the-great-game.playroom</a></h3><div class="doc"><div class="markdown"><p><strong>TODO</strong>: write docs</p>
</div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="cc.journeyman.the-great-game.playroom.html#var-app">app</a> </li><li> <a href="cc.journeyman.the-great-game.playroom.html#var-init">init</a> </li><li> <a href="cc.journeyman.the-great-game.playroom.html#var-simple-update">simple-update</a> </li></ul></div></div><div class="namespace"><h3><a href="cc.journeyman.the-great-game.proving.core.html">cc.journeyman.the-great-game.proving.core</a></h3><div class="doc"><div class="markdown"><p>Phase one of ‘<a href="Bakine-the-world.html#phase-one-proving-the-procedural-world">Baking the World</a>’</p>
</div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="cc.journeyman.the-great-game.proving.core.html#var-*life-goals*">*life-goals*</a> </li><li> <a href="cc.journeyman.the-great-game.proving.core.html#var-get-biome-map">get-biome-map</a> </li><li> <a href="cc.journeyman.the-great-game.proving.core.html#var-get-drainage-map">get-drainage-map</a> </li><li> <a href="cc.journeyman.the-great-game.proving.core.html#var-get-road-map">get-road-map</a> </li><li> <a href="cc.journeyman.the-great-game.proving.core.html#var-populate-cell">populate-cell</a> </li><li> <a href="cc.journeyman.the-great-game.proving.core.html#var-populate-world">populate-world</a> </li><li> <a href="cc.journeyman.the-great-game.proving.core.html#var-prove">prove</a> </li></ul></div></div><div class="namespace"><h3><a href="cc.journeyman.the-great-game.proving.sketches.html">cc.journeyman.the-great-game.proving.sketches</a></h3><div class="doc"><div class="markdown"><p><strong>TODO</strong>: write docs</p>
</div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="cc.journeyman.the-great-game.proving.sketches.html#var-couple-cell.3F">couple-cell?</a> </li><li> <a href="cc.journeyman.the-great-game.proving.sketches.html#var-happy-cell.3F">happy-cell?</a> </li></ul></div></div><div class="namespace"><h3><a href="cc.journeyman.the-great-game.time.html">cc.journeyman.the-great-game.time</a></h3><div class="doc"><div class="markdown"><p><strong>TODO</strong>: write docs</p>
</div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="cc.journeyman.the-great-game.time.html#var-canonical-ordering-of-houses">canonical-ordering-of-houses</a> </li><li> <a href="cc.journeyman.the-great-game.time.html#var-date-string">date-string</a> </li><li> <a href="cc.journeyman.the-great-game.time.html#var-day">day</a> </li><li> <a href="cc.journeyman.the-great-game.time.html#var-day-of-year">day-of-year</a> </li><li> <a href="cc.journeyman.the-great-game.time.html#var-days-in-season">days-in-season</a> </li><li> <a href="cc.journeyman.the-great-game.time.html#var-days-in-week">days-in-week</a> </li><li> <a href="cc.journeyman.the-great-game.time.html#var-days-of-week">days-of-week</a> </li><li> <a href="cc.journeyman.the-great-game.time.html#var-game-day-length">game-day-length</a> </li><li> <a href="cc.journeyman.the-great-game.time.html#var-game-start-time">game-start-time</a> </li><li> <a href="cc.journeyman.the-great-game.time.html#var-game-time">game-time</a> </li><li> <a href="cc.journeyman.the-great-game.time.html#var-now">now</a> </li><li> <a href="cc.journeyman.the-great-game.time.html#var-season">season</a> </li><li> <a href="cc.journeyman.the-great-game.time.html#var-seasons-in-year">seasons-in-year</a> </li><li> <a href="cc.journeyman.the-great-game.time.html#var-seasons-of-year">seasons-of-year</a> </li><li> <a href="cc.journeyman.the-great-game.time.html#var-waiting-day.3F">waiting-day?</a> </li><li> <a href="cc.journeyman.the-great-game.time.html#var-week">week</a> </li><li> <a href="cc.journeyman.the-great-game.time.html#var-weeks-in-season">weeks-in-season</a> </li><li> <a href="cc.journeyman.the-great-game.time.html#var-weeks-of-season">weeks-of-season</a> </li></ul></div></div><div class="namespace"><h3><a href="cc.journeyman.the-great-game.utils.html">cc.journeyman.the-great-game.utils</a></h3><div class="doc"><div class="markdown"><p><strong>TODO</strong>: write docs</p>
</div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="cc.journeyman.the-great-game.utils.html#var-cyclic.3F">cyclic?</a> </li><li> <a href="cc.journeyman.the-great-game.utils.html#var-deep-merge">deep-merge</a> </li><li> <a href="cc.journeyman.the-great-game.utils.html#var-inc-or-one">inc-or-one</a> </li><li> <a href="cc.journeyman.the-great-game.utils.html#var-make-target-filter">make-target-filter</a> </li><li> <a href="cc.journeyman.the-great-game.utils.html#var-truthy.3F">truthy?</a> </li><li> <a href="cc.journeyman.the-great-game.utils.html#var-value-or-default">value-or-default</a> </li></ul></div></div><div class="namespace"><h3><a href="cc.journeyman.the-great-game.world.heightmap.html">cc.journeyman.the-great-game.world.heightmap</a></h3><div class="doc"><div class="markdown"><p>Functions dealing with the tessellated multi-layer heightmap.</p>
</div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="cc.journeyman.the-great-game.world.heightmap.html#var-*base-map*">*base-map*</a> </li><li> <a href="cc.journeyman.the-great-game.world.heightmap.html#var-*noise-map*">*noise-map*</a> </li><li> <a href="cc.journeyman.the-great-game.world.heightmap.html#var-excerpt-grid">excerpt-grid</a> </li><li> <a href="cc.journeyman.the-great-game.world.heightmap.html#var-get-surface">get-surface</a> </li><li> <a href="cc.journeyman.the-great-game.world.heightmap.html#var-interpolate-altitude">interpolate-altitude</a> </li><li> <a href="cc.journeyman.the-great-game.world.heightmap.html#var-interpolate-cell">interpolate-cell</a> </li><li> <a href="cc.journeyman.the-great-game.world.heightmap.html#var-interpolate-grid">interpolate-grid</a> </li><li> <a href="cc.journeyman.the-great-game.world.heightmap.html#var-scale-grid">scale-grid</a> </li></ul></div></div><div class="namespace"><h3><a href="cc.journeyman.the-great-game.world.location.html">cc.journeyman.the-great-game.world.location</a></h3><div class="doc"><div class="markdown"><p>Functions dealing with location in the world.</p>
</div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="cc.journeyman.the-great-game.world.location.html#var-distance-between">distance-between</a> </li><li> <a href="cc.journeyman.the-great-game.world.location.html#var-get-coords">get-coords</a> </li></ul></div></div><div class="namespace"><h3><a href="cc.journeyman.the-great-game.world.mw.html">cc.journeyman.the-great-game.world.mw</a></h3><div class="doc"><div class="markdown"><p>Functions dealing with building a great game world from a MicroWorld world.</p>
</div></div><div class="index"><p>Public variables and functions:</p><ul></ul></div></div><div class="namespace"><h3><a href="cc.journeyman.the-great-game.world.routes.html">cc.journeyman.the-great-game.world.routes</a></h3><div class="doc"><div class="markdown"><p>Conceptual (plan level) routes, represented as tuples of location ids.</p>
</div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="cc.journeyman.the-great-game.world.routes.html#var-find-route">find-route</a> </li><li> <a href="cc.journeyman.the-great-game.world.routes.html#var-find-routes">find-routes</a> </li></ul></div></div><div class="namespace"><h3><a href="cc.journeyman.the-great-game.world.world.html">cc.journeyman.the-great-game.world.world</a></h3><div class="doc"><div class="markdown"><p>Access to data about the world</p>
</div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="cc.journeyman.the-great-game.world.world.html#var-actual-price">actual-price</a> </li><li> <a href="cc.journeyman.the-great-game.world.world.html#var-default-world">default-world</a> </li><li> <a href="cc.journeyman.the-great-game.world.world.html#var-run">run</a> </li></ul></div></div></div></body></html>
Reference in a new issue View git blame Copy permalink