-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathcustom_spells.html
More file actions
159 lines (134 loc) · 8.57 KB
/
Copy pathcustom_spells.html
File metadata and controls
159 lines (134 loc) · 8.57 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
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
<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="./">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Creating Your Own Spells 🧪</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=03e43079" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
<link rel="stylesheet" type="text/css" href="_static/css/tooltipster.custom.css" />
<link rel="stylesheet" type="text/css" href="_static/css/tooltipster.bundle.min.css" />
<link rel="stylesheet" type="text/css" href="_static/css/tooltipster-sideTip-shadow.min.css" />
<link rel="stylesheet" type="text/css" href="_static/css/tooltipster-sideTip-punk.min.css" />
<link rel="stylesheet" type="text/css" href="_static/css/tooltipster-sideTip-noir.min.css" />
<link rel="stylesheet" type="text/css" href="_static/css/tooltipster-sideTip-light.min.css" />
<link rel="stylesheet" type="text/css" href="_static/css/tooltipster-sideTip-borderless.min.css" />
<link rel="stylesheet" type="text/css" href="_static/css/micromodal.css" />
<link rel="stylesheet" type="text/css" href="_static/copybutton.css?v=76b2166b" />
<link rel="stylesheet" type="text/css" href="_static/css/sphinx_rtd_theme.css?v=3234e928" />
<link rel="stylesheet" type="text/css" href="_static/sphinx-design.min.css?v=95c83b7e" />
<link rel="stylesheet" type="text/css" href="_static/custom.css?v=7c7d8b87" />
<link rel="shortcut icon" href="_static/favicon.ico"/>
<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=5929fcd5"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/js/hoverxref.js"></script>
<script src="_static/js/tooltipster.bundle.min.js"></script>
<script src="_static/js/micromodal.min.js"></script>
<script src="_static/js/versionwarning.js?v=d4224a34"></script>
<script src="_static/clipboard.min.js?v=a7894cd8"></script>
<script src="_static/copybutton.js?v=f281be69"></script>
<script src="_static/design-tabs.js?v=f930bc37"></script>
<script>window.MathJax = {"options": {"processHtmlClass": "tex2jax_process|mathjax_process|math|output_area"}}</script>
<script defer="defer" src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Contributing 🛠️" href="contributing.html" />
<link rel="prev" title="Magic Errors and Exceptions 🧨" href="errors.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home">
Wizard API Documentation (prebuilt HTML pages)
<img src="_static/logo.png" class="logo" alt="Logo"/>
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Sections</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation 🔮</a></li>
<li class="toctree-l1"><a class="reference internal" href="quickstart.html">Quickstart Guide ✨</a></li>
<li class="toctree-l1"><a class="reference internal" href="spellbook.html">The Spellbook (API Reference) 📖</a></li>
<li class="toctree-l1"><a class="reference internal" href="errors.html">Magic Errors and Exceptions 🧨</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Creating Your Own Spells 🧪</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing 🛠️</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">Wizard API Documentation (prebuilt HTML pages)</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">Creating Your Own Spells 🧪</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/custom_spells.md.txt" rel="nofollow"> View page source</a>
</li>
<li class="wy-breadcrumbs-aside.github-icon">
<a href="https://github.com/elena-soloveva/wizard-api-prebuild" target="_blank" rel="noopener">
<img src="_static/_images/github-mark.png"
alt="GitHub"
style="height: 1.5em; vertical-align: text-bottom; " />
</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section class="tex2jax_ignore mathjax_ignore" id="creating-your-own-spells">
<h1>Creating Your Own Spells 🧪<a class="headerlink" href="#creating-your-own-spells" title="Link to this heading"></a></h1>
<p>You can define your own spells using the <code class="docutils literal notranslate"><span class="pre">@spell</span></code> decorator.</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span><span class="w"> </span><span class="nn">wizardapi</span><span class="w"> </span><span class="kn">import</span> <span class="n">spell</span>
<span class="nd">@spell</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s2">"rain_of_cats"</span><span class="p">)</span>
<span class="k">def</span><span class="w"> </span><span class="nf">rain_of_cats</span><span class="p">(</span><span class="n">target</span><span class="p">):</span>
<span class="k">return</span> <span class="sa">f</span><span class="s2">"☔ It's raining cats on </span><span class="si">{</span><span class="n">target</span><span class="si">}</span><span class="s2">!"</span>
</pre></div>
</div>
<p>Registering the spell:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">caster</span><span class="o">.</span><span class="n">register_custom_spell</span><span class="p">(</span><span class="n">rain_of_cats</span><span class="p">)</span>
<span class="nb">print</span><span class="p">(</span><span class="n">caster</span><span class="o">.</span><span class="n">cast</span><span class="p">(</span><span class="s2">"rain_of_cats"</span><span class="p">,</span> <span class="n">target</span><span class="o">=</span><span class="s2">"orc"</span><span class="p">))</span>
</pre></div>
</div>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="errors.html" class="btn btn-neutral float-left" title="Magic Errors and Exceptions 🧨" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="contributing.html" class="btn btn-neutral float-right" title="Contributing 🛠️" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>© Copyright Gaijin Entertainment 2026.
<span class="lastupdated">Last updated on Jan 27, 2026.
</span></p>
</div>
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>