Gungame.core.players.shortcuts.deleteAttribute
From GunGame5 Documentation
(Difference between revisions)
| Line 66: | Line 66: | ||
* [[gungame.core.players.shortcuts]] | * [[gungame.core.players.shortcuts]] | ||
** [[gungame.core.playersPlayer|Player]] | ** [[gungame.core.playersPlayer|Player]] | ||
| - | ** [[gungame.core.players.shortcuts. | + | ** [[gungame.core.players.shortcuts.addAttribute|addAttribute(''filter, attribute, value'')]] |
** [[gungame.core.players.shortcuts.addAttributeCallBack|addAttributeCallBack]](''attribute, function, addon'') | ** [[gungame.core.players.shortcuts.addAttributeCallBack|addAttributeCallBack]](''attribute, function, addon'') | ||
** [[gungame.core.players.shortcuts.removeAttributeCallBack|removeAttributeCallBack]](''attribute'') | ** [[gungame.core.players.shortcuts.removeAttributeCallBack|removeAttributeCallBack]](''attribute'') | ||
** [[gungame.core.players.shortcuts.removeCallBacksForAddon|removeCallBacksForAddon]](''addon'')|}} | ** [[gungame.core.players.shortcuts.removeCallBacksForAddon|removeCallBacksForAddon]](''addon'')|}} | ||
Revision as of 20:13, 27 April 2009
Function: deleteAttribute
Module: gungame.core.players.shortcuts
Class: Player
GunGame Version: 5.1
Function Overview
Table of Contents
Contents |
Description
A shortcut function for Player.__delattr__() and Player.__delitem__() that allows the scripter to delete a custom Player attribute on a single userid or multiple userids using a filter as provided by playerlib.getPlayerList().
Arguments
deleteAttribute(filter, attribute)
- filter
- userid
- A str() filter as used by playerlib.getPlayerList()
- attribute
- The str() name of the attribute
Examples
- Deleting the attribute:
# ../<MOD>/addons/eventscripts/gungame/scripts/custom/gg_sample/gg_sample.py import es from gungame.core.players.shortcuts import setAttribute from gungame.core.players.shortcuts import deleteAttribute def load(): # Set the custom attribute "myattribute" on all connected players setAttribute('#all', 'myattribute', 0) def unload(): # Remove the custom attribute "myattribute" from all players deleteAttribute('#all', 'myattribute') def gg_start(): # Set the custom attribute "myattribute" on all connected players # (due to the fact that all custom player attributes are removed # when the GunGame match ends, we need to re-instantiated the # custom attribute "myattribute" when a new GunGame round starts) setAttribute('#all', 'myattribute', 0) def player_activate(event_var): # Set the custom attribute "myattribute" for this userid setAttribute(event_var['userid'], 'myattribute', 0) def player_disconnect(event_var): # Delete the custom attribute "myattribute" from this userid deleteAttribute(event_var['userid'], 'myattribute')
Notes
- If you set any custom Player attributes, insure that you remove them when the player disconnects (optional) or when your addon is unloaded (required):
def unload(): deleteAttribute('#all', 'yourattributename') def player_disconnect(event_var): setAttribute(event_var['userid'], 'yourattributename')
