Source.Python/docs/_modules/events/custom.html at v743 · Source-Python-Dev-Team/Source.Python

History

268 lines (212 loc) · 21.5 KB

Raw

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

<!DOCTYPE html>

<head>

<title>events.custom — Source.Python v742 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 v742 documentation</a> »</li>

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

<li class="nav-item nav-item-2"><a href="../events.html" accesskey="U">events</a> »</li>

<li class="nav-item nav-item-this"><a href="">events.custom</a></li>

</ul>

</div>

<h1>Source code for events.custom</h1><div class="highlight"><pre>

# ../events/custom.py

"""Provides a way to create custom events."""

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

# >> IMPORTS

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

# Python Imports

# Collections

from collections import OrderedDict

# Source.Python Imports

# Events

from events import events_logger

from events.manager import game_event_manager

# Hooks

from hooks.exceptions import except_hooks

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

# >> ALL DECLARATION

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

__all__ = ('CustomEvent',

)

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

# >> GLOBAL VARIABLES

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

# Get the sp.events.custom logger

events_custom_logger = events_logger.custom

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

# >> CLASSES

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

class _EventMeta(type):

"""Metaclass used to store class attributes in an ordered dictionary."""

@classmethod

def __prepare__(mcs, *args, **kwargs):

"""Return an ordered dictionary."""

return OrderedDict()

def __new__(mcs, name, bases, odict):

"""Called when the class is being created."""

# Create the instance

cls = super().__new__(mcs, name, bases, dict(odict))

# Is this CustomEvent itself?

if not bases:

return cls

# Store an ordered dictionary

cls._odict = OrderedDict()

# Loop through all items in the given ordered dictionary

for item in odict:

# Is the item not a magic method?

if not item.startswith('__'):

# Add the item to the dictionary

cls._odict[item] = odict[item]

# Loop through all base classes

for base in bases:

# Skip CustomEvent itself

if base is CustomEvent:

continue

# Skip any non CustomEvent base classes

if not issubclass(base, CustomEvent):

continue

# Loop through all items in the base class

for item in base._odict:

# Add the item if it doesn't already exist for the class

if item not in cls._odict:

cls._odict[item] = base._odict[item]

# Return the class

return cls

class CustomEvent(metaclass=_EventMeta):

"""Class inherited to create custom events."""

def __init__(self, **kwargs):

"""Called on instantiation."""

# Loop through the given keyword arguments

for kwarg in kwargs:

# Is the current keyword in the event's variables?

if kwarg not in self._odict:

# If not, raise an error

raise KeyError(

'Given keyword "{0}" is not a variable for '

'the event "{1}"'.format(kwarg, self.name))

# Store the variable's value as a private attribute

super().__setattr__('_' + kwarg, kwargs[kwarg])</div>

def __setattr__(self, attr, value):

"""Store variable values as private attributes."""

# Is the given attribute for a variable?

if not attr.startswith('_') and attr in self._odict:

# Set the attribute as the private value

super().__setattr__('_' + attr, value)

# No need to go further

return

# Set the attribute

super().__setattr__(attr, value)

def __enter__(self):

"""Context management that automatically fires on exit."""

return self

def __exit__(self, exctype, value, trace_back):

"""Fire the event on exit, unless an exception was encountered."""

# Was an exception raised?

if trace_back:

# Print the exception

except_hooks.print_exception(exctype, value, trace_back)

# Return

return False

# Fire the event

self.fire()

# Return

return True

def fire(self):

"""Fire the event with the stored variable values."""

# Get the event's instance

event = game_event_manager.create_event(self.name, True)

# Loop through the event's variables

for variable in self._odict:

# Set the event variable values

getattr(event, 'set_{0}'.format(self._odict[variable].method))(

variable, getattr(self, '_' + variable))

# Fire the event

game_event_manager.fire_event(event)</div>

def reset(self):

"""Reset all event variable values to their default values."""

# Loop through the event's variables

for variable in self._odict:

# Set the variable to its default value

super().__setattr__(

'_' + variable, getattr(self, variable)._default)</div>

@property

def name(self):

"""Return the name of the event."""

return self.__class__.__name__.lower()</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 v742 documentation</a> »</li>

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

<li class="nav-item nav-item-2"><a href="../events.html" >events</a> »</li>

<li class="nav-item nav-item-this"><a href="">events.custom</a></li>

</ul>

</div>

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

</div>

</body>

</html>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

custom.html

Latest commit

History

custom.html

File metadata and controls