Gungame.core.players.shortcuts.removeCallBacksForAddon

From GunGame5 Documentation

Revision as of 20:30, 27 April 2009 by GunGame5WikiAdmin (Talk | contribs)
(diff) ← Older revision | Current revision (diff) | Newer revision → (diff)
Jump to: navigation, search


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

Function: removeCallBacksForAddon

Module: gungame.core.players.shortcuts
Class: Player
GunGame Version: 5.1

Function Overview

Table of Contents

Contents


Description

A shortcut function for the static class method Player.removeCallBacksForAddon() that allows the scripter to remove all custom Player attribute callbacks that have been associated with the named addon.

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')
 
def player_disconnect(event_var):
    setAttribute(event_var['userid'], 'yourattributename')
  • Deleting an attribute using this function will remove any custom attribute callbacks that were set by addAttributeCallBack().
  • If you try to delete a custom attribute that does not exist using this method, no error will be raised.
  • If you attempt to delete any required GunGame attributes, an error will be raised.

See Also

Retrieved from "http://wiki.gungame.net/pages/Gungame.core.players.shortcuts.removeCallBacksForAddon"
Personal tools