Source.Python/docs/_modules/events.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

<!DOCTYPE html>

<head>

<title>events — 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="">events</a></li>

</ul>

</div>

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

# ../events/__init__.py

"""Provides event based functionality."""

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

# >> IMPORTS

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

# Source.Python Imports

# Core

from core import AutoUnload

# Events

from events.manager import event_manager

# Loggers

from loggers import _sp_logger

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

# >> FORWARD IMPORTS

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

# Source.Python Imports

# Events

from _events import EventVarType

from _events import GameEvent

from _events import GameEventDescriptor

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

# >> ALL DECLARATION

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

__all__ = ('Event',

'EventVarType',

'GameEvent',

'GameEventDescriptor',

)

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

# >> GLOBAL VARIABLES

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

# Get the sp.events logger

events_logger = _sp_logger.events

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

# >> CLASSES

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

class Event(AutoUnload):

"""Event decorator class."""

def __init__(self, *event_names):

"""Store the event names."""

self._event_names = ()

self.callback = None

# Validate event names

if not event_names:

raise ValueError('At least one event name is required.')

for event_name in event_names:

if not isinstance(event_name, str):

raise ValueError('Event name must be a string.')

self._event_names = event_names

def __call__(self, callback):

"""Store the callback and register the events."""

# Store the callback

self.callback = callback

# Loop through all event names

for event_name in self._event_names:

# Register the event

event_manager.register_for_event(event_name, self.callback)

# Return the callback

return self.callback

def _unload_instance(self):

"""Unregister the events."""

# Was no callback registered?

if self.callback is None:

return

# Loop through all event names

for event_name in self._event_names:

# Unregister the event

event_manager.unregister_for_event(event_name, self.callback)</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="">events</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/events.html at master · Source-Python-Dev-Team/Source.Python · GitHub

Repository navigation

Expand file tree

Breadcrumbs

events.html

Latest commit

History

Breadcrumbs

events.html

File metadata and controls