Repository navigation
Expand file tree
/
Copy pathBehaviourScript_8hpp_source.html
More file actions
132 lines (130 loc) · 15.1 KB
/
Copy pathBehaviourScript_8hpp_source.html
File metadata and controls
132 lines (130 loc) · 15.1 KB
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
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>SPC-H Platformer Engine: includes/spic-prj-api/BehaviourScript.hpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">SPC-H Platformer Engine
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_09e761304027c904456130627fd4dcf5.html">includes</a></li><li class="navelem"><a class="el" href="dir_de77370fa4c160312bb88f5d1919228b.html">spic-prj-api</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">BehaviourScript.hpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="BehaviourScript_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="preprocessor">#ifndef BEHAVIOURSCRIPT_H_</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define BEHAVIOURSCRIPT_H_</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>  </div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="preprocessor">#include "<a class="code" href="Component_8hpp.html">Component.hpp</a>"</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="preprocessor">#include "<a class="code" href="Collider_8hpp.html">Collider.hpp</a>"</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="preprocessor">#include "<a class="code" href="Collision_8hpp.html">Physics/Collision.hpp</a>"</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="preprocessor">#include <boost/serialization/access.hpp></span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor">#include <boost/serialization/export.hpp></span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor">#include <boost/archive/binary_iarchive.hpp></span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor">#include <boost/archive/binary_oarchive.hpp></span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor">#include "boost/archive/text_iarchive.hpp"</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor">#include "boost/archive/text_oarchive.hpp"</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#include "<a class="code" href="portable__binary__iarchive_8hpp.html">Networking/boost/portable_binary_iarchive.hpp</a>"</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#include "<a class="code" href="portable__binary__oarchive_8hpp.html">Networking/boost/portable_binary_oarchive.hpp</a>"</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>  </div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="keyword">namespace </span><a class="code" href="namespacespic.html">spic</a> {</div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>  </div>
<div class="line"><a name="l00018"></a><span class="lineno"><a class="line" href="classspic_1_1BehaviourScript.html"> 18</a></span>  <span class="keyword">class </span><a class="code" href="classspic_1_1BehaviourScript.html">BehaviourScript</a> : <span class="keyword">public</span> <a class="code" href="classspic_1_1Component.html">Component</a> {</div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  <span class="keyword">public</span>:</div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>  <span class="keyword">template</span><<span class="keyword">typename</span> archive></div>
<div class="line"><a name="l00021"></a><span class="lineno"><a class="line" href="classspic_1_1BehaviourScript.html#a5101079f8363686f20c467f2bc553461"> 21</a></span>  <span class="keywordtype">void</span> <a class="code" href="classspic_1_1BehaviourScript.html#a5101079f8363686f20c467f2bc553461">serialize</a>(archive &ar, <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="comment">/*version*/</span>) {</div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  ar & boost::serialization::base_object<Component, BehaviourScript>(*<span class="keyword">this</span>);</div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  boost::serialization::void_cast_register<BehaviourScript, Component>();</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  }</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  </div>
<div class="line"><a name="l00030"></a><span class="lineno"><a class="line" href="classspic_1_1BehaviourScript.html#a15da06506b3f3bb746f2515f29f08b77"> 30</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classspic_1_1BehaviourScript.html#a15da06506b3f3bb746f2515f29f08b77">OnStart</a>() {};</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  </div>
<div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="classspic_1_1BehaviourScript.html#a75efedda02ad6ac8946cd5e2d38a0d4d"> 36</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classspic_1_1BehaviourScript.html#a75efedda02ad6ac8946cd5e2d38a0d4d">OnUpdate</a>(<span class="keywordtype">double</span> speedMultiplier) {};</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  </div>
<div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="classspic_1_1BehaviourScript.html#a3529fbaa6d5a5ee83df5e42fd55f1350"> 43</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classspic_1_1BehaviourScript.html#a3529fbaa6d5a5ee83df5e42fd55f1350">OnTriggerEnter2D</a>(<span class="keyword">const</span> <a class="code" href="classCollision.html">Collision</a> collision) {};</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  </div>
<div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="classspic_1_1BehaviourScript.html#ae2407f8892c6b554e680d453c7f7cbcb"> 50</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classspic_1_1BehaviourScript.html#ae2407f8892c6b554e680d453c7f7cbcb">OnTriggerExit2D</a>(<span class="keyword">const</span> <a class="code" href="classCollision.html">Collision</a> collision) {};</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  </div>
<div class="line"><a name="l00057"></a><span class="lineno"><a class="line" href="classspic_1_1BehaviourScript.html#a0c0613a9783a0300429443ee14d384d3"> 57</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classspic_1_1BehaviourScript.html#a0c0613a9783a0300429443ee14d384d3">OnTriggerStay2D</a>(<span class="keyword">const</span> <a class="code" href="classCollision.html">Collision</a> collision) {};</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  };</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  </div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> } <span class="comment">// namespace spic</span></div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  </div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="preprocessor">#endif </span><span class="comment">// BEHAVIOURSCRIPT_H_</span></div>
<div class="ttc" id="aCollider_8hpp_html"><div class="ttname"><a href="Collider_8hpp.html">Collider.hpp</a></div></div>
<div class="ttc" id="aCollision_8hpp_html"><div class="ttname"><a href="Collision_8hpp.html">Collision.hpp</a></div></div>
<div class="ttc" id="aComponent_8hpp_html"><div class="ttname"><a href="Component_8hpp.html">Component.hpp</a></div></div>
<div class="ttc" id="aclassCollision_html"><div class="ttname"><a href="classCollision.html">Collision</a></div><div class="ttdoc">Collider wrapper passed to BehaviourScript triggers, adds additional information about a collision ev...</div><div class="ttdef"><b>Definition:</b> Collision.hpp:26</div></div>
<div class="ttc" id="aclassspic_1_1BehaviourScript_html"><div class="ttname"><a href="classspic_1_1BehaviourScript.html">spic::BehaviourScript</a></div><div class="ttdef"><b>Definition:</b> BehaviourScript.hpp:18</div></div>
<div class="ttc" id="aclassspic_1_1BehaviourScript_html_a0c0613a9783a0300429443ee14d384d3"><div class="ttname"><a href="classspic_1_1BehaviourScript.html#a0c0613a9783a0300429443ee14d384d3">spic::BehaviourScript::OnTriggerStay2D</a></div><div class="ttdeci">virtual void OnTriggerStay2D(const Collision collision)</div><div class="ttdoc">Sent each frame where another object is within a trigger collider attached to this object (2D physics...</div><div class="ttdef"><b>Definition:</b> BehaviourScript.hpp:57</div></div>
<div class="ttc" id="aclassspic_1_1BehaviourScript_html_a15da06506b3f3bb746f2515f29f08b77"><div class="ttname"><a href="classspic_1_1BehaviourScript.html#a15da06506b3f3bb746f2515f29f08b77">spic::BehaviourScript::OnStart</a></div><div class="ttdeci">virtual void OnStart()</div><div class="ttdoc">On start of behaviour script @spicapi.</div><div class="ttdef"><b>Definition:</b> BehaviourScript.hpp:30</div></div>
<div class="ttc" id="aclassspic_1_1BehaviourScript_html_a3529fbaa6d5a5ee83df5e42fd55f1350"><div class="ttname"><a href="classspic_1_1BehaviourScript.html#a3529fbaa6d5a5ee83df5e42fd55f1350">spic::BehaviourScript::OnTriggerEnter2D</a></div><div class="ttdeci">virtual void OnTriggerEnter2D(const Collision collision)</div><div class="ttdoc">Sent when another object enters a trigger collider attached to this object (2D physics only)....</div><div class="ttdef"><b>Definition:</b> BehaviourScript.hpp:43</div></div>
<div class="ttc" id="aclassspic_1_1BehaviourScript_html_a5101079f8363686f20c467f2bc553461"><div class="ttname"><a href="classspic_1_1BehaviourScript.html#a5101079f8363686f20c467f2bc553461">spic::BehaviourScript::serialize</a></div><div class="ttdeci">void serialize(archive &ar, const unsigned)</div><div class="ttdef"><b>Definition:</b> BehaviourScript.hpp:21</div></div>
<div class="ttc" id="aclassspic_1_1BehaviourScript_html_a75efedda02ad6ac8946cd5e2d38a0d4d"><div class="ttname"><a href="classspic_1_1BehaviourScript.html#a75efedda02ad6ac8946cd5e2d38a0d4d">spic::BehaviourScript::OnUpdate</a></div><div class="ttdeci">virtual void OnUpdate(double speedMultiplier)</div><div class="ttdoc">On update of behaviour script @spicapi.</div><div class="ttdef"><b>Definition:</b> BehaviourScript.hpp:36</div></div>
<div class="ttc" id="aclassspic_1_1BehaviourScript_html_ae2407f8892c6b554e680d453c7f7cbcb"><div class="ttname"><a href="classspic_1_1BehaviourScript.html#ae2407f8892c6b554e680d453c7f7cbcb">spic::BehaviourScript::OnTriggerExit2D</a></div><div class="ttdeci">virtual void OnTriggerExit2D(const Collision collision)</div><div class="ttdoc">Sent when another object leaves a trigger collider attached to this object (2D physics only)....</div><div class="ttdef"><b>Definition:</b> BehaviourScript.hpp:50</div></div>
<div class="ttc" id="aclassspic_1_1Component_html"><div class="ttname"><a href="classspic_1_1Component.html">spic::Component</a></div><div class="ttdoc">Base class for all components.</div><div class="ttdef"><b>Definition:</b> Component.hpp:23</div></div>
<div class="ttc" id="anamespacespic_html"><div class="ttname"><a href="namespacespic.html">spic</a></div><div class="ttdef"><b>Definition:</b> AudioNotFoundException.hpp:7</div></div>
<div class="ttc" id="aportable__binary__iarchive_8hpp_html"><div class="ttname"><a href="portable__binary__iarchive_8hpp.html">portable_binary_iarchive.hpp</a></div></div>
<div class="ttc" id="aportable__binary__oarchive_8hpp_html"><div class="ttname"><a href="portable__binary__oarchive_8hpp.html">portable_binary_oarchive.hpp</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
</body>
</html>