Gungame.core.players.shortcuts.deleteAttribute

From GunGame5 Documentation

(Difference between revisions)
Jump to: navigation, search
Line 1: Line 1:
{{Function|
{{Function|
 +
 +
name=deleteAttribute|
Line 5: Line 7:
-
name=deleteAttribute|
+
class=[[gungame.core.players.Player|Player]]|
-
class=[[gungame.core.players.Player|Player]]|
+
ggversion=5.1|
 +
 
 +
 
 +
description=A shortcut function for [[gungame.core.players.Player|Player.__delattr__()]] and [[gungame.core.players.Player|Player.__delitem__()]] that allows the scripter to delete a custom [[gungame.core.players.Player|Player]] attribute on a single userid or multiple userids using a filter as provided by [http://python.eventscripts.com/pages/Playerlib#Notes playerlib.getPlayerList()].|
 +
arguments=<source lang="python">deleteAttribute(filter, attribute)</source>
 +
* '''filter'''
 +
** ''userid''
 +
** ''A str() filter as used by [http://python.eventscripts.com/pages/Playerlib#Notes playerlib.getPlayerList()]''
 +
* '''attribute'''
 +
** ''The str() name of the attribute''|
 +
 
 +
 
 +
examples=* Deleting the attribute:
 +
<source lang="python"># ../<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')</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:
 +
<source lang="python">def load():
 +
    setAttribute('#all', 'yourattributename', 0)
-
ggversion=5.1
+
def player_activate(event_var):
 +
    setAttribute(event_var['userid'], 'yourattributename', 0)
 +
def gg_start():
 +
    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.
 +
** Other scripts can also access your custom attributes via the [[gungame.core.players.Player|Player.__getitem__()]] or  [[gungame.core.players.Player|Player.__getattr__()]] methods.
 +
* When GunGame starts a new GunGame round, all custom [[gungame.core.players.Player|Player]] attributes are deleted, and need to be re-instantiated. If you use the [http://www.eventscripts.com/pages/Block_load load()], [http://www.eventscripts.com/pages/Player_activate player_activate()], and gg_start() functions to set custom [[gungame.core.players.Player|Player]] attributes in your script, you will not have to worry about the custom attributes being inaccessible.|
-
}}
+
seealso=* [[gungame.core.players]]
 +
** [[gungame.core.playersPlayer|Player]]
 +
* [[gungame.core.players.shortcuts]]
 +
** [[gungame.core.playersPlayer|Player]]
 +
** [[gungame.core.players.shortcuts.deleteAttribute|deleteAttribute(''attribute'')]]
 +
** [[gungame.core.players.shortcuts.addAttributeCallBack|addAttributeCallBack]](''attribute, function, addon'')
 +
** [[gungame.core.players.shortcuts.removeAttributeCallBack|removeAttributeCallBack]](''attribute'')
 +
** [[gungame.core.players.shortcuts.removeCallBacksForAddon|removeCallBacksForAddon]](''addon'')|}}

Revision as of 20:04, 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=* In order to effectively set a custom attribute on all players, use the setAttribute() function in your addon's load(), player_activate(), and gg_start() functions: 

def load():
    setAttribute('#all', 'yourattributename', 0)
 
def player_activate(event_var):
    setAttribute(event_var['userid'], 'yourattributename', 0)
 
def gg_start():
    setAttribute(event_var['userid'], 'yourattributename', 0)
  • If you set any custom 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 deleteAttribute() function.
  • Once a custom Player attribute has been set, you can access the attribute via the Player.__getitem__() or Player.__getattr__() methods.
  • When GunGame starts a new GunGame round, all custom Player attributes are deleted, and need to be re-instantiated. If you use the load(), player_activate(), and gg_start() functions to set custom Player attributes in your script, you will not have to worry about the custom attributes being inaccessible.

Notes

{{{notes}}}

See Also

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