Source.Python/docs/developing/module_tutorials/memory.html at patch-1 · srpg/Source.Python · GitHub

Repository navigation

History

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

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

<!DOCTYPE html>

<head>

<title>memory — Source.Python v743 documentation</title>

</head><body>

<h3>Navigation</h3>

<ul>

<a href="../../genindex.html" title="General Index"

accesskey="I">index</a></li>

<a href="../../py-modindex.html" title="Python Module Index"

>modules</a> |</li>

<a href="menus.html" title="menus"

accesskey="N">next</a> |</li>

<a href="listeners.html" title="listeners"

accesskey="P">previous</a> |</li>

<li class="nav-item nav-item-0"><a href="../../index.html"> Source.Python v743 documentation</a> »</li>

<li class="nav-item nav-item-1"><a href="../module_tutorials.html" accesskey="U">Module tutorials</a> »</li>

<li class="nav-item nav-item-this"><a href="">memory</a></li>

</ul>

</div>

<h1>memory<a class="headerlink" href="#memory" title="Link to this heading">¶</a></h1>

This page contains tutorials about the <a class="reference internal" href="../modules/memory.html#module-memory" title="memory"><code class="xref py py-mod docutils literal notranslate">memory</code></a> package.

<h2>Calling a virtual function<a class="headerlink" href="#calling-a-virtual-function" title="Link to this heading">¶</a></h2>

This is a simple example for calling a virtual function in CS:S.

<div class="highlight-python notranslate"><div class="highlight"><pre>import core

from memory import DataType

from memory import Convention

from mathlib import Vector

from entities.helpers import pointer_from_index

from entities.helpers import index_from_pointer

# CBaseEntity* CCSPlayer::GiveNamedItem(char const*, int)

# Index on Windows is 400. On Linux it is 401.

GIVE_NAMED_ITEM_INDEX = 400 if core.PLATFORM == 'windows' else 401

def give_named_item(index, item, slot=0):

# Retrieve the player's pointer.

ptr = pointer_from_index(index)

# Now, we can get and wrap the virtual function. To do this, we need

# to pass the index of the virtual function in the virtual function table

# of the CCSPlayer class. This index might change after a game update.

# We also need to specify the calling convention. Since it's a normal

# member function, the calling convention is THISCALL.

# For the third argument a tuple is required that defines the types of the

# arguments of the function. In this case we need to pass a pointer

# (the this-pointer), a string that specifies the item that should be

# given and an integer that defines the slot/sub type of the item.

# For the fourth and last argument we need to define the return type of the

# virtual function. In this case the function returns a pointer to the

# created entity.

GiveNamedItem = ptr.make_virtual_function(

GIVE_NAMED_ITEM_INDEX,

Convention.THISCALL,

(DataType.POINTER, DataType.STRING, DataType.INT),

DataType.POINTER

)

# Finally, we can call the virtual function! Since many functions in

# Source.Python's API require an index instead of a pointer, we will

# convert the returned pointer to an index.

return index_from_pointer(GiveNamedItem(ptr, item, slot))

# Usage example:

# entity_index = give_named_item(my_player_index, 'weapon_awp')

</pre></div>

</div>

</section>

<h2>Calling a virtual function with non atomic arguments<a class="headerlink" href="#calling-a-virtual-function-with-non-atomic-arguments" title="Link to this heading">¶</a></h2>

This example will cover calling a virtual function which requires two non atomic arguments. This example was made for CS:S.

<div class="highlight-python notranslate"><div class="highlight"><pre>import core

from memory import DataType

from memory import Convention

from mathlib import Vector

from entities.helpers import pointer_from_index

# void CBaseAnimating::GetVelocity(Vector*, Vector*)

# Index on Windows is 140. On Linux it is 141.

GET_VELOCITY_INDEX = 140 if core.PLATFORM == 'windows' else 141

def get_velocity(index):

# Retrieve the entity's pointer.

ptr = pointer_from_index(index)

# Now, get and wrap the virtual function. Again, we need to pass the

# virtual function index and the calling convention.

# The tuple that defines the types of the arguments will now contain three

# times Argument.POINTER. The first pointer stands for the this-pointer.

# The other two stand for the Vector* arguments.

# This time the function doesn't return anything. Instead the return value

# is "returned" by modifying the two Vector arguments. This is a common

# practice in C/C++ to return multiple return values.

GetVelocity = ptr.make_virtual_function(

GET_VELOCITY_INDEX,

Convention.THISCALL,

(DataType.POINTER, DataType.POINTER, DataType.POINTER),

DataType.VOID

)

# Since Source.Python exposes the Vector class, we don't even need to

# reconstruct the memory structure of the both vectors. So, we just need

# to create two new Vector objects.

velocity = Vector()

angle = Vector()

# Finally, call the function! But what's happening here? Source.Python

# converts both Vector objects to a Pointer object at first and then

# accesses the memory addresses of the Vector objects which were allocated

# internally. Pretty cool, eh? This works with every object whose class

# was exposed by Source.Python and every object that is an instance of

# CustomType.

GetVelocity(ptr, velocity, angle)

# After the function modified the vectors just return them.

return (velocity, angle)

</pre></div>

</div>

</section>

</div>

</a>

<div>

<h3><a href="../../index.html">Table of Contents</a></h3>

<ul>

<li><a class="reference internal" href="#">memory</a><ul>

<li><a class="reference internal" href="#calling-a-virtual-function">Calling a virtual function</a></li>

<li><a class="reference internal" href="#calling-a-virtual-function-with-non-atomic-arguments">Calling a virtual function with non atomic arguments</a></li>

</ul>

</li>

</ul>

</div>

<div>

<h4>Previous topic</h4>

<a href="listeners.html"

title="previous chapter">listeners</a>

</div>

<div>

<h4>Next topic</h4>

<a href="menus.html"

title="next chapter">menus</a>

</div>

<li><a href="../../_sources/developing/module_tutorials/memory.rst.txt"

rel="nofollow">Show Source</a></li>

</ul>

</div>

<h3 id="searchlabel">Quick search</h3>

</form>

</div>

</search>

</div>

</div>

<h3>Navigation</h3>

<ul>

<a href="../../genindex.html" title="General Index"

>index</a></li>

<a href="../../py-modindex.html" title="Python Module Index"

>modules</a> |</li>

<a href="menus.html" title="menus"

>next</a> |</li>

<a href="listeners.html" title="listeners"

>previous</a> |</li>

<li class="nav-item nav-item-0"><a href="../../index.html"> Source.Python v743 documentation</a> »</li>

<li class="nav-item nav-item-1"><a href="../module_tutorials.html" >Module tutorials</a> »</li>

<li class="nav-item nav-item-this"><a href="">memory</a></li>

</ul>

</div>

Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.2.3.

</div>

</body>

</html>

Source.Python/docs/developing/module_tutorials/memory.html at patch-1 · srpg/Source.Python · GitHub

Repository navigation

Expand file tree

Breadcrumbs

memory.html

Latest commit

History

Breadcrumbs

memory.html

File metadata and controls