Gungame.core.players.shortcuts.deleteAttribute

From GunGame5 Documentation

(Difference between revisions)
Jump to: navigation, search
Line 51: Line 51:
def player_disconnect(event_var):
def player_disconnect(event_var):
     # Delete the custom attribute "myattribute" from this userid
     # Delete the custom attribute "myattribute" from this userid
-
     deleteAttribute(event_var['userid'], 'myattribute')</source>
+
     deleteAttribute(event_var['userid'], 'myattribute')</source>|
-
notes=* In order to effectively set a custom attribute on all players, use the [[gungame.core.players.shortcuts.setAttribute|setAttribute()]] function in your addon's [http://www.eventscripts.com/pages/Block_load load()], [http://www.eventscripts.com/pages/Player_activate player_activate()], and gg_start() functions:
+
notes=* If you set any custom [[gungame.core.players.Player|Player]] attributes, insure that you remove them when the player disconnects (optional) or when your addon is unloaded (required):
-
<source lang="python">def load():
+
**<source lang="python">def unload():
-
     setAttribute('#all', 'yourattributename', 0)
+
     deleteAttribute('#all', 'yourattributename', 0)
-
def player_activate(event_var):
+
def player_disconnect(event_var):
-
    setAttribute(event_var['userid'], 'yourattributename', 0)
+
-
 
+
-
def gg_start():
+
     setAttribute(event_var['userid'], 'yourattributename', 0)</source>
     setAttribute(event_var['userid'], 'yourattributename', 0)</source>
-
* If you set any custom [[gungame.core.players.Player|Player]] attributes, insure that you remove them when the player disconnects (optional) or when your addon is unloaded (required). This can be accomplished via the [[gungame.core.players.shortcuts.deleteAttribute|deleteAttribute()]] function.
 
* Once a custom [[gungame.core.players.Player|Player]] attribute has been set, you can access the attribute via the [[gungame.core.players.Player|Player.__getitem__()]] or  [[gungame.core.players.Player|Player.__getattr__()]] methods.
* Once a custom [[gungame.core.players.Player|Player]] attribute has been set, you can access the attribute via the [[gungame.core.players.Player|Player.__getitem__()]] or  [[gungame.core.players.Player|Player.__getattr__()]] methods.
** Other scripts can also access your custom attributes via the [[gungame.core.players.Player|Player.__getitem__()]] or  [[gungame.core.players.Player|Player.__getattr__()]] methods.
** Other scripts can also access your custom attributes via the [[gungame.core.players.Player|Player.__getitem__()]] or  [[gungame.core.players.Player|Player.__getattr__()]] methods.

Revision as of 20:09, 27 April 2009


deleteAttribute is the correct title for this article. The title you see above is incorrect due to technical limitations.

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)


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', 0)

  def player_disconnect(event_var):

setAttribute(event_var['userid'], 'yourattributename', 0)

See Also

Retrieved from "http://wiki.gungame.net/pages/Gungame.core.players.shortcuts.deleteAttribute"
Views
Personal tools
Navigation
Toolbox