/usr/share/doc/libghc-lambdahack-doc/html/Game-LambdaHack-Common-ContentDef.html

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Game.LambdaHack.Common.ContentDef</title><link href="ocean.css" rel="stylesheet" type="text/css" title="Ocean" /><script src="haddock-util.js" type="text/javascript"></script><script src="file:///usr/share/javascript/mathjax/MathJax.js" type="text/javascript"></script><script type="text/javascript">//<![CDATA[
window.onload = function () {pageLoad();setSynopsis("mini_Game-LambdaHack-Common-ContentDef.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/Game-LambdaHack-Common-ContentDef.html">Source</a></li><li><a href="index.html">Contents</a></li><li><a href="doc-index.html">Index</a></li></ul><p class="caption">LambdaHack-0.5.0.0: A game engine library for roguelike dungeon crawlers</p></div><div id="content"><div id="module-header"><table class="info"><tr><th>Safe Haskell</th><td>None</td></tr><tr><th>Language</th><td>Haskell2010</td></tr></table><p class="caption">Game.LambdaHack.Common.ContentDef</p></div><div id="description"><p class="caption">Description</p><div class="doc"><p>A game requires the engine provided by the library, perhaps customized,
 and game content, defined completely afresh for the particular game.
 The general type of the content is <code>ContentDef</code> and it has instances
 for all content kinds, such as items kinds
 (<code>Game.LambdaHack.Content.ItemKind</code>).
 The possible kinds are fixed in the library and all defined in the same
 directory. On the other hand, game content, that is all elements
 of <code>ContentDef</code> instances, are defined in a directory
 of the game code proper, with names corresponding to their kinds.</p></div></div><div id="synopsis"><p id="control.syn" class="caption expander" onclick="toggleSection('syn')">Synopsis</p><ul id="section.syn" class="hide" onclick="toggleSection('syn')"><li class="src short"><span class="keyword">data</span> <a href="#t:ContentDef">ContentDef</a> a = <a href="#v:ContentDef">ContentDef</a> {<ul class="subs"><li><a href="#v:getSymbol">getSymbol</a> :: a -&gt; <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/Data-Char.html#t:Char">Char</a></li><li><a href="#v:getName">getName</a> :: a -&gt; <a href="file:///usr/share/doc/libghc-text-doc/html/Data-Text.html#t:Text">Text</a></li><li><a href="#v:getFreq">getFreq</a> :: a -&gt; <a href="Game-LambdaHack-Common-Misc.html#t:Freqs">Freqs</a> a</li><li><a href="#v:validateSingle">validateSingle</a> :: a -&gt; [<a href="file:///usr/share/doc/libghc-text-doc/html/Data-Text.html#t:Text">Text</a>]</li><li><a href="#v:validateAll">validateAll</a> :: [a] -&gt; [<a href="file:///usr/share/doc/libghc-text-doc/html/Data-Text.html#t:Text">Text</a>]</li><li><a href="#v:content">content</a> :: ![a]</li></ul>}</li></ul></div><div id="interface"><h1>Documentation</h1><div class="top"><p class="src"><span class="keyword">data</span> <a id="t:ContentDef" class="def">ContentDef</a> a <a href="src/Game-LambdaHack-Common-ContentDef.html#ContentDef" class="link">Source</a> <a href="#t:ContentDef" class="selflink">#</a></p><div class="doc"><p>The general type of a particular game content, e.g., item kinds.</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a id="v:ContentDef" class="def">ContentDef</a></td><td class="doc empty">&nbsp;</td></tr><tr><td colspan="2"><div class="subs fields"><p class="caption">Fields</p><ul><li><dfn class="src"><a id="v:getSymbol" class="def">getSymbol</a> :: a -&gt; <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/Data-Char.html#t:Char">Char</a></dfn><div class="doc"><p>symbol, e.g., to print on the map</p></div></li><li><dfn class="src"><a id="v:getName" class="def">getName</a> :: a -&gt; <a href="file:///usr/share/doc/libghc-text-doc/html/Data-Text.html#t:Text">Text</a></dfn><div class="doc"><p>name, e.g., to show to the player</p></div></li><li><dfn class="src"><a id="v:getFreq" class="def">getFreq</a> :: a -&gt; <a href="Game-LambdaHack-Common-Misc.html#t:Freqs">Freqs</a> a</dfn><div class="doc"><p>frequency within groups</p></div></li><li><dfn class="src"><a id="v:validateSingle" class="def">validateSingle</a> :: a -&gt; [<a href="file:///usr/share/doc/libghc-text-doc/html/Data-Text.html#t:Text">Text</a>]</dfn><div class="doc"><p>validate a content item and list all offences</p></div></li><li><dfn class="src"><a id="v:validateAll" class="def">validateAll</a> :: [a] -&gt; [<a href="file:///usr/share/doc/libghc-text-doc/html/Data-Text.html#t:Text">Text</a>]</dfn><div class="doc"><p>validate the whole defined content of this type and list all offences</p></div></li><li><dfn class="src"><a id="v:content" class="def">content</a> :: ![a]</dfn><div class="doc"><p>all the defined content of this type</p></div></li></ul></div></td></tr></table></div></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.17.3</p></div></body></html>
libghc-lambdahack-doc 0.5.0.0-2build5 / usr / share / doc / libghc-lambdahack-doc / html / Game-LambdaHack-Common-ContentDef.html
