Source.Python/docs/_modules/effects.html at master · Source-Python-Dev-Team/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

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

<!DOCTYPE html>

<head>

<title>effects — 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>

<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="index.html" accesskey="U">Module code</a> »</li>

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

</ul>

</div>

<h1>Source code for effects</h1><div class="highlight"><pre>

# ../effects/__init__.py

"""Provides access to all effects within the engine."""

# ============================================================================

# >> IMPORTS

# ============================================================================

# Source.Python Imports

# Effects

from effects.base import TempEntity

# Mathlib

from mathlib import Vector

# Memory

from memory.manager import manager

# Entities

from entities.entity import BaseEntity

from entities.entity import Entity

# =============================================================================

# >> FORWARD IMPORTS

# =============================================================================

# Source.Python Imports

# Effects

from _effects import ShatterSurface

from _effects import BloodColor

# =============================================================================

# >> ALL DECLARATION

# =============================================================================

__all__ = ('BloodColor',

'ShatterSurface',

'ball',

'beam',

'box',

'polygon',

'square',

)

# ============================================================================

# >> GLOBAL VARIABLES

# ============================================================================

# Get the first temp entity in the chain...

try:

from _effects._base import _first_temp_entity

except ImportError:

_first_temp_entity = manager.get_global_pointer('BaseTempEntity')

# =============================================================================

# >> FUNCTIONS

# =============================================================================

def beam(recipients, start, end, parent=False, **kwargs):

"""A simple wrapper for the temporary effect ``BeamEntPoint``.

:param RecipientFilter recipients:

Players that should see the beam.

:param int/BaseEntity/Vector start:

The start location of the beam.

:param int/BaseEntity/Vector end:

The end location of the beam.

:param bool parent:

If True, the beam will be parented to the given entities.

:param kwargs:

Additional attributes that will be send to the effect.

"""

_entity = kwargs.pop('_entity', None)

if _entity is None:

entity = TempEntity('BeamEntPoint')

for attr, value in kwargs.items():

setattr(entity, attr, value)

else:

entity = _entity

def get_vec(value):

if isinstance(value, int):

return Entity(value).origin

elif isinstance(value, BaseEntity):

return Entity(value.index).origin

else:

return value

if parent:

if isinstance(start, int):

entity.start_entity_index = start

elif isinstance(start, BaseEntity):

entity.start_entity_index = start.index

else:

entity.start_point = start

else:

entity.start_point = get_vec(start)

if parent:

if isinstance(end, int):

entity.end_entity_index = end

elif isinstance(end, BaseEntity):

entity.end_entity_index = end.index

else:

entity.end_point = end

else:

entity.end_point = get_vec(end)

entity.create(recipients)</div>

def polygon(recipients, points, parent=False, **kwargs):

"""Create a polygon using :func:`beam`.

:param RecipientFilter recipients:

Players that should see the beam.

:param iterable points:

An iterable that contains at least 3 :class:`mathlib.Vector` instances.

:param bool parent:

If True, the beam will be parented to the given entities.

:param kwargs:

Additional attributes that will be send to the effect.

"""

if len(points) < 3:

raise ValueError('At least 3 points are required.')

start = points[0]

points = dict(enumerate(points))

entity = TempEntity('BeamEntPoint')

for index, point in points.items():

beam(

recipients, point, points.get(index + 1, start), parent,

_entity=entity, **kwargs)</div>

def square(recipients, start, end, **kwargs):

"""Create a square using the temporary effect ``BeamPoints``.

:param RecipientFilter recipients:

Players that should see the beam.

:param Vector start:

Upper left corner of the square.

:param Vector end:

Lower right corner of the square.

:param kwargs:

Additional attributes that will be send to the effect.

"""

x1, y1, z1 = start

x2, y2, z2 = end

a = start

b = Vector(x2, y2, z1)

c = Vector(x1, y1, z2)

d = end

lines = (

(a, b),

(b, d),

(d, c),

(c, a),

)

entity = TempEntity('BeamPoints')

for p1, p2 in lines:

entity.start_point = p1

entity.end_point = p2

entity.create(recipients)</div>

def box(recipients, start, end, **kwargs):

"""Create a box using the temporary effect ``BeamPoints``.

:param RecipientFilter recipients:

Players that should see the beam.

:param Vector start:

Upper left corner of the box.

:param Vector end:

Lower right corner of the box.

:param kwargs:

Additional attributes that will be send to the effect.

"""

x1, y1, z1 = start

x2, y2, z2 = end

a = start

b = Vector(x2, y1, z1)

c = Vector(x2, y1, z2)

d = Vector(x1, y1, z2)

e = Vector(x1, y2, z1)

f = Vector(x2, y2, z1)

h = Vector(x1, y2, z2)

g = end

lines = (

# First square

(a, b),

(b, c),

(c, d),

(d, a),

# Second square

(e, f),

(f, g),

(g, h),

(h, e),

# Connection between both squares

(a, e),

(b, f),

(c, g),

(d, h)

)

entity = TempEntity('BeamPoints')

for p1, p2 in lines:

entity.start_point = p1

entity.end_point = p2

entity.create(recipients)</div>

def ball(recipients, center, radius, steps=15, upper_half=True, lower_half=True, **kwargs):

"""Create a ball by using the remporary effect ``BeamRingPoint``.

:param RecipientFilter recipients:

Players that should see the beam.

:param Vector center:

The center location of the ball.

:param float radius:

The radius of the ball.

:param int steps:

Number of rings that should be used to create the ball.

:param bool upper_half:

If False, the upper half of the ball isn't created.

:param bool lower_half:

If False, the lower half of the ball isn't created.

.. note::

The number of steps is used for the lower and upper half. So, if you

define 15 steps, 29 rings are created (the center ring is shared by

both halves).

"""

# Make sure that at least one argument is True

assert not (upper_half == lower_half == False)

entity = TempEntity('BeamRingPoint')

step = float(radius) / steps

for x in range(steps):

dist = step * x

org = Vector(*center)

org.z += dist

rad = 2 * radius * (1 - (float(x) / steps) ** 2) ** 0.5

if upper_half:

entity.center = org

entity.start_radius = rad

entity.end_radius = rad - 0.1

entity.create(recipients)

if x and lower_half:

org.z -= 2 * dist

entity.center = org

entity.start_radius = rad

entity.end_radius = rad - 0.1

entity.create(recipients)</div>

</pre></div>

</div>

</a>

<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>

<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="index.html" >Module code</a> »</li>

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

</ul>

</div>

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

</div>

</body>

</html>

Source.Python/docs/_modules/effects.html at master · Source-Python-Dev-Team/Source.Python · GitHub

Repository navigation

Expand file tree

Breadcrumbs

effects.html

Latest commit

History

Breadcrumbs

effects.html

File metadata and controls