From 06600d9eeba05c85c785f8fca679267f3eba7fc6 Mon Sep 17 00:00:00 2001
From: Eric Froemling
Date: Wed, 20 May 2020 19:14:50 -0700
Subject: [PATCH] Tidying
---
assets/src/ba_data/python/ba/_messages.py | 16 ++++++++--------
docs/ba_module.md | 16 ++++++++--------
2 files changed, 16 insertions(+), 16 deletions(-)
diff --git a/assets/src/ba_data/python/ba/_messages.py b/assets/src/ba_data/python/ba/_messages.py
index ed309833..e97a561a 100644
--- a/assets/src/ba_data/python/ba/_messages.py
+++ b/assets/src/ba_data/python/ba/_messages.py
@@ -92,14 +92,14 @@ PlayerType = TypeVar('PlayerType', bound='ba.Player')
class PlayerDiedMessage:
- """A message saying a ba.PlayerSpaz has died.
+ """A message saying a ba.Player has died.
category: Message Classes
Attributes:
killed
- If True, the spaz was killed;
+ If True, the player was killed;
If False, they left the game or the round ended.
how
@@ -132,10 +132,10 @@ class PlayerDiedMessage:
return self._killerplayer
def getplayer(self, playertype: Type[PlayerType]) -> PlayerType:
- """Return the spaz that died.
+ """Return the ba.Player that died.
- The current activity is required as an argument so the exact type of
- PlayerSpaz can be determined by the type checker.
+ The type of player for the current activity should be passed so that
+ the type-checker properly identifies the returned value as one.
"""
player: Any = self._player
assert isinstance(player, playertype)
@@ -313,10 +313,10 @@ class HitMessage:
def get_source_player(
self, playertype: Type[PlayerType]) -> Optional[PlayerType]:
- """Return the spaz that died.
+ """Return the source-player if there is one and they still exist.
- The current activity is required as an argument so the exact type of
- PlayerSpaz can be determined by the type checker.
+ The type of player for the current activity should be passed so that
+ the type-checker properly identifies the returned value as one.
"""
player: Any = self._source_player
assert isinstance(player, (playertype, type(None)))
diff --git a/docs/ba_module.md b/docs/ba_module.md
index f0de70cc..dc9024c2 100644
--- a/docs/ba_module.md
+++ b/docs/ba_module.md
@@ -2466,10 +2466,10 @@ and short description of the game.
get_source_player(self, playertype: Type[PlayerType]) -> Optional[PlayerType]
-Return the spaz that died.
+Return the source-player if there is one and they still exist.
-The current activity is required as an argument so the exact type of
-PlayerSpaz can be determined by the type checker.
+The type of player for the current activity should be passed so that
+the type-checker properly identifies the returned value as one.
@@ -3823,7 +3823,7 @@ is_alive() method return True. False is returned otherwise.
<top level class>
-A message saying a ba.PlayerSpaz has died.
+A message saying a ba.Player has died.
Category: Message Classes
@@ -3837,7 +3837,7 @@ is_alive() method return True. False is returned otherwise.
bool
-If True, the spaz was killed;
+
If True, the player was killed;
If False, they left the game or the round ended.
@@ -3862,10 +3862,10 @@ If False, they left the game or the round ended.
getplayer(self, playertype: Type[PlayerType]) -> PlayerType
-Return the spaz that died.
+Return the ba.Player that died.
-The current activity is required as an argument so the exact type of
-PlayerSpaz can be determined by the type checker.
+The type of player for the current activity should be passed so that
+the type-checker properly identifies the returned value as one.