doc/phpdoc/packages/inc.shop.inc.html


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208

<!DOCTYPE html>
<html lang="en">
<head>
    <meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=0"/>
    <meta charset="utf-8"/>
    <title>     &raquo; \inc\shop.inc
</title>
    <meta name="author" content=""/>
    <meta name="description" content=""/>

            <link href="../css/template.css" rel="stylesheet" media="all"/>
    
            <!--[if lt IE 9]>
        <script src="https://html5shim.googlecode.com/svn/trunk/html5.js" type="text/javascript"></script>
        <![endif]-->
        <script src="../js/jquery-1.7.1.min.js" type="text/javascript"></script>
        <script src="../js/jquery-ui-1.8.2.custom.min.js" type="text/javascript"></script>
        <script src="../js/jquery.mousewheel.min.js" type="text/javascript"></script>
        <script src="../js/bootstrap.js" type="text/javascript"></script>
        <script src="../js/template.js" type="text/javascript"></script>
        <script src="../js/prettify/prettify.min.js" type="text/javascript"></script>
    
            <link rel="shortcut icon" href="../img/favicon.ico"/>
        <link rel="apple-touch-icon" href="../img/apple-touch-icon.png"/>
        <link rel="apple-touch-icon" sizes="72x72" href="../img/apple-touch-icon-72x72.png"/>
        <link rel="apple-touch-icon" sizes="114x114" href="../img/apple-touch-icon-114x114.png"/>
    </head>
<body>

        <div class="navbar navbar-fixed-top">
        <div class="navbar-inner">
            <div class="container">
                <a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse">
                    <span class="icon-bar"></span> <span class="icon-bar"></span>
                    <span class="icon-bar"></span> </a>
                <a class="brand" href="../index.html">API Documentation</a>

                <div class="nav-collapse">
                    <ul class="nav">
                        <li class="dropdown">
                            <a href="#api" class="dropdown-toggle" data-toggle="dropdown">
                                API Documentation <b class="caret"></b>
                            </a>
                            <ul class="dropdown-menu">
                                                                                            </ul>
                        </li>
                        <li class="dropdown" id="charts-menu">
                            <a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
                                Charts <b class="caret"></b>
                            </a>
                            <ul class="dropdown-menu">
                                <li>
                                    <a href="../graph_class.html">
                                        <i class="icon-list-alt"></i>&#160;Class hierarchy diagram
                                    </a>
                                </li>
                            </ul>
                        </li>
                        <li class="dropdown" id="reports-menu">
                            <a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
                                Reports <b class="caret"></b>
                            </a>
                            <ul class="dropdown-menu">
                                <li>
                                    <a href="../errors.html">
                                        <i class="icon-list-alt"></i>&#160;Errors
                                    </a>
                                </li>
                                <li>
                                    <a href="../markers.html">
                                        <i class="icon-list-alt"></i>&#160;Markers
                                    </a>
                                </li>
                                <li>
                                    <a href="../deprecated.html">
                                        <i class="icon-list-alt"></i>&#160;Deprecated
                                    </a>
                                </li>
                            </ul>
                        </li>
                    </ul>
                </div>
            </div>
        </div>
        <div class="go_to_top">
            <a href="#___" style="color: inherit">Back to top&#160;&#160;<i class="icon-upload icon-white"></i></a>
        </div>
    </div>
    
    <div id="___" class="container">
        <noscript>
            <div class="alert alert-warning">
                Javascript is disabled; several features are only available if Javascript is enabled.
            </div>
        </noscript>

        
            
    <div class="row">

        <div class="span4">
            <div class="btn-group view pull-right" data-toggle="buttons-radio">
                <button class="btn details" title="Show descriptions and method names">
                    <i class="icon-list"></i></button><button class="btn simple" title="Show only method names">
                    <i class="icon-align-justify"></i>
                </button>
            </div>
            <ul class="side-nav nav nav-list">
                <li class="nav-header">
                    <i class="icon-map-marker"></i> Packages
                </li>
                <a href="../packages/inc.shop.inc.html" title="shop.inc">
                    <i class="icon-th"></i> shop.inc
                </a>
                <ul class="nav nav-list nav-packages">
                        
    
                </ul>
            </ul>
        </div>

        <div class="span8 package-contents">
                
    <ul class="breadcrumb">
        <li><a href="../index.html"><i class="icon-th"></i></a></li>
            
                
    
    <li>
        <span class="divider">\</span><a href="../packages/inc.html">inc</a>
    </li>

    
    <li>
        <span class="divider">\</span><a href="../packages/inc.shop.inc.html">shop.inc</a>
    </li>

    </ul>

    
                    <div class="package-indent">
                <h3><i class="icon-custom icon-function"></i> Functions</h3>
                                        <div id="loadShop" class="element ajax clickable function">
        <h1>loadShop<a href="../namespaces/default.html#function_loadShop">¶</a></h1>
        <p class="short_description">Loads all the shop&#039;s items from the XML file data/items.xml.</p>
        <div class="details collapse"></div>
        <a href="../namespaces/default.html#function_loadShop" class="more">« More »</a>
    </div>

                                        <div id="getItem" class="element ajax clickable function">
        <h1>getItem<a href="../namespaces/default.html#function_getItem">¶</a></h1>
        <p class="short_description">Gets an Item object from the shop from its name.</p>
        <div class="details collapse"></div>
        <a href="../namespaces/default.html#function_getItem" class="more">« More »</a>
    </div>

                                        <div id="initShop" class="element ajax clickable function">
        <h1>initShop<a href="../namespaces/default.html#function_initShop">¶</a></h1>
        <p class="short_description">Marks the shop as created in the session.</p>
        <div class="details collapse"></div>
        <a href="../namespaces/default.html#function_initShop" class="more">« More »</a>
    </div>

                                        <div id="sendShop" class="element ajax clickable function">
        <h1>sendShop<a href="../namespaces/default.html#function_sendShop">¶</a></h1>
        <p class="short_description">Returns the shop array if it was created.</p>
        <div class="details collapse"></div>
        <a href="../namespaces/default.html#function_sendShop" class="more">« More »</a>
    </div>

                                        <div id="buildShop" class="element ajax clickable function">
        <h1>buildShop<a href="../namespaces/default.html#function_buildShop">¶</a></h1>
        <p class="short_description">Creates the shop in the session and sends it to the client.</p>
        <div class="details collapse">Debits the shop&#039;s cost from the player&#039;s gold.</div>
        <a href="../namespaces/default.html#function_buildShop" class="more">« More »</a>
    </div>

                                        <div id="buyItem" class="element ajax clickable function">
        <h1>buyItem<a href="../namespaces/default.html#function_buyItem">¶</a></h1>
        <p class="short_description">Debits the item&#039;s cost specified as the item POST parameter, adds it to the Inventory and sends it to the client.</p>
        <div class="details collapse"></div>
        <a href="../namespaces/default.html#function_buyItem" class="more">« More »</a>
    </div>

                                        <div id="useItem" class="element ajax clickable function">
        <h1>useItem<a href="../namespaces/default.html#function_useItem">¶</a></h1>
        <p class="short_description">Invoke useItem on an item passed as the item POST parameter, sends to the client the updated player stats and the item.</p>
        <div class="details collapse"></div>
        <a href="../namespaces/default.html#function_useItem" class="more">« More »</a>
    </div>

                            </div>
        
        
            
    
        </div>
    </div>
    </div>

        <footer class="span12">
            Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by
            <a href="http://glyphicons.com/">Glyphicons</a>.<br/>
            Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and<br/>
            generated on Sun, 08 May 2016 20:44:21 +0200.<br/>
    </footer>
    </body>
</html>