&hSrSSKJrJr SSKJr SSKJr SSKrSSK J r SSK J r SSK Jr "S S 5r"S S \5r"S S\5r"SS\\5r"SS\\"S55r"SS\5r\r\r"SS\5r"SS\5r"SS\5r"SS\5r"SS\5rS r"S!S"5rS#r"S$S%5rS&r S*S'jr!S*S(jr"S*S)jr#g)+a pygame module with basic game object classes This module contains several simple classes to be used within games. There are the main Sprite class and several Group classes that contain Sprites. The use of these classes is entirely optional when using Pygame. The classes are fairly lightweight and only provide a starting place for the code that is common to most games. The Sprite class is intended to be used as a base class for the different types of objects in the game. There is also a base Group class that simply stores sprites. A game could create new types of Group classes that operate on specially customized Sprite instances they contain. The basic Sprite class can draw the Sprites it contains to a Surface. The Group.draw() method requires that each Sprite have a Surface.image attribute and a Surface.rect. The Group.clear() method requires these same attributes and can be used to erase all the Sprites with background. There are also more advanced Groups: pygame.sprite.RenderUpdates() and pygame.sprite.OrderedUpdates(). Lastly, this module contains several collision functions. These help find sprites inside multiple groups that have intersecting bounding rectangles. To find the collisions, the Sprites are required to have a Surface.rect attribute assigned. The groups are designed for high efficiency in removing and adding Sprites to them. They also allow cheap testing to see if a Sprite already exists in a Group. A given Sprite can exist in any number of groups. A game could use some groups to control object rendering, and a completely separate set of groups to control interaction or player movement. Instead of adding type attributes or bools to a derived Sprite class, consider keeping the Sprites inside organized Groups. This will allow for easier lookup later in the game. Sprites and Groups manage their relationships with the add() and remove() methods. These methods can accept a single or multiple group arguments for membership. The default initializers for these classes also take a single group or list of groups as arguments for initial membership. It is safe to repeatedly add and remove the same Sprite from a Group. While it is possible to design sprite and group classes that don't derive from the Sprite and AbstractGroup classes below, it is strongly recommended that you extend those when you create a new Sprite or Group class. Sprites are not thread safe, so lock them yourself if using threads. )GenericTypeVar)WeakSet)warnN)Rect) get_ticks) from_surfacec\rSrSrSrSrSrSrSrSr Sr S r S r S r S r\S 5r\R"S5rSrg)Spritecasimple base class for visible game objects pygame.sprite.Sprite(*groups): return Sprite The base class for visible game objects. Derived classes will want to override the Sprite.update() method and assign Sprite.image and Sprite.rect attributes. The initializer can accept any number of Group instances that the Sprite will become a member of. When subclassing the Sprite class, be sure to call the base initializer before adding the Sprite to Groups. cP[5UlU(aUR"U6 ggN)set _Sprite__gaddselfgroupss E/var/www/auris/envauris/lib/python3.13/site-packages/pygame/sprite.py__init__Sprite.__init__rs5  HHf  cURRnUHVn[US5(a3U"U5(d$URU5 URU5 MEMGUR"U6 MX g)zadd the sprite to groups Sprite.add(*groups): return None Any number of Group instances can be passed as arguments. The Sprite will be added to the Groups it is not already a member of. _spritegroupN)r __contains__hasattr add_internalrrrhasgroups rr Sprite.addwsbhh##Eun--5zz&&t,%%e,"% rcURRnUHVn[US5(a3U"U5(a$URU5 URU5 MEMGUR"U6 MX g)zremove the sprite from groups Sprite.remove(*groups): return None Any number of Group instances can be passed as arguments. The Sprite will be removed from the Groups it is currently a member of. rN)rrrremove_internalremovers rr$ Sprite.removesbhh##Eun--u::))$/((/ U# rc:URRU5 g)zZ For adding this sprite to a group internally. :param group: The group we are adding to. N)rrrr s rrSprite.add_internals  Urc:URRU5 g)zb For removing this sprite from a group internally. :param group: The group we are removing from. N)rr$r's rr#Sprite.remove_internals rcg)ammethod to control sprite behavior Sprite.update(*args, **kwargs): The default implementation of this method does nothing; it's just a convenient "hook" that you can override. This method is called by Group.update() with whatever arguments you give it. There is no need to use this method if not using the convenience method by the same name in the Group class. N)rargskwargss rupdate Sprite.updatesrcURHnURU5 M URR5 g)a$remove the Sprite from all Groups Sprite.kill(): return None The Sprite is removed from all the Groups that contain it. This won't change anything about the state of the Sprite. It is possible to continue to use the Sprite after this method has been called, including adding it to Groups. N)rr#clearr's rkill Sprite.kills.XXE  ! !$ ' rc,[UR5$)zlist of Groups that contain this Sprite Sprite.groups(): return group_list Returns a list of all the Groups that contain this Sprite. )listrrs rr Sprite.groupssDHH~rc,[UR5$)zdoes the sprite belong to any groups Sprite.alive(): return bool Returns True when the Sprite belongs to one or more Groups. )boolrr7s ralive Sprite.alivesDHH~rcbSURRS[UR5S3$)N) __class____name__lenrr7s r__repr__Sprite.__repr__s*4>>**+;s488}oYOOrcUR$)a Dynamic, read only property for protected _layer attribute. This will get the _layer variable if it exists. If you try to get it before it is set it will raise an attribute error. Layer property can only be set before the sprite is added to a group, after that it is read only and a sprite's layer in a group should be set via the group's change_layer() method. :return: layer as an int, or raise AttributeError. _layerr7s rlayer Sprite.layers{{rcPUR5(dXlg[S5eNzbCan't set layer directly after adding to group. Use group.change_layer(sprite, new_layer) instead.r;rGAttributeErrorrvalues rrHrI$zz||K  r)__grGN)rA __module__ __qualname____firstlineno____doc__rrr$rr#r/r3rr;rCpropertyrHsetter__static_attributes__r,rrr r csf  !$$$   P   \\  rr c,^\rSrSrSrU4SjrSrU=r$) WeakSpritezA subclass of Sprite that references its Groups weakly. This means that any group this belongs to that is not referenced anywhere else is garbage collected automatically. cd>[TU]"U6 [UR5URS'g)Nr)superrrr__dict__)rrr@s rrWeakSprite.__init__s' &!&-doo&> l#rr,)rArRrSrTrUrrX __classcell__)r@s@rrZrZs ??rrZc\rSrSrSrSrSrSr\S5r \ RS5r \S5r \ RS 5r S r S r g ) DirtySpriteiaa more featureful subclass of Sprite with more attributes pygame.sprite.DirtySprite(*groups): return DirtySprite Extra DirtySprite attributes with their default values: dirty = 1 If set to 1, it is repainted and then set to 0 again. If set to 2, it is always dirty (repainted each frame; flag is not reset). If set to 0, it is not dirty and therefore not repainted again. blendmode = 0 It's the special_flags argument of Surface.blit; see the blendmodes in the Surface.blit documentation source_rect = None This is the source rect to use. Remember that it is relative to the top left corner (0, 0) of self.image. visible = 1 Normally this is 1. If set to 0, it will not be repainted. (If you change visible to 1, you must set dirty to 1 for it to be erased from the screen.) _layer = 0 0 is the default value but this is able to be set differently when subclassing. cSUlSUlSUl[USS5UlSUl[ R"U/UQ76 g)NrrG)dirty blendmode_visiblegetattrrG source_rectr rrs rrDirtySprite.__init__&sD  dHa0 &v&rc@XlURS:aSUlgg)z9set the visible value (0 or 1) and makes the sprite dirtyrdN)rgre)rvals r _set_visibleDirtySprite._set_visible2s ::>DJ rcUR$)z'return the visible value of that sprite)rgr7s r _get_visibleDirtySprite._get_visible8s }}rc"UR5$)zp You can make this sprite disappear without removing it from the group assign 0 for invisible and 1 for visible )rqr7s rvisibleDirtySprite.visible<s   ""rc&URU5 gr)rnrNs rrtruDs % rcUR$)z Layer property can only be set before the sprite is added to a group, after that it is read only and a sprite's layer in a group should be set via the group's change_layer() method. Overwrites dynamic property from sprite class for speed. rFr7s rrHDirtySprite.layerHs{{rcPUR5(dXlg[S5erKrLrNs rrHrxSrPrcjSURRS[UR55S3$)Nr>z DirtySprite(in r?)r@rArBrr7s rrCDirtySprite.__repr___s1''((8T[[]9K8LI V r)rGrgrfreriN)rArRrSrTrUrrnrqrVrtrWrHrCrXr,rrrbrbss> ' ## ^^!! \\   rrbc\rSrSrSrSrg)WeakDirtySpriteiezUA subclass of WeakSprite and DirtySprite that combines the benefits of both classes. r,N)rArRrSrTrUrXr,rrr}r}esrr}c\rSrSrSrSrSrSrSSjrSr S r S r S r S r S rSrSrSrSSjrSrSrSrSrSrSrg) AbstractGroupika<base class for containers of sprites AbstractGroup does everything needed to behave as a normal group. You can easily subclass a new group class from this or the other groups below if you want to add more features. Any AbstractGroup-derived sprite groups act like sequences and support iteration, len, and so on. Tc 0Ul/Ulgr) spritedict lostspritesr7s rrAbstractGroup.__init__zsrc,[UR5$)aNget a list of sprites in the group Group.sprites(): return list Returns an object that can be looped over with a 'for' loop. (For now, it is always a list, but this could change in a future version of pygame.) Alternatively, you can get the same information by iterating directly over the sprite group, e.g. 'for sprite in group'. )r6rr7s rspritesAbstractGroup.sprites~sDOO$$rNc"SURU'g)z For adding a sprite to this group internally. :param sprite: The sprite we are adding. :param layer: the layer to add to, if the group type supports layers NrrspriterHs rrAbstractGroup.add_internals#'rcURUnU(aURRU5 URU g)z_ For removing a sprite from this group internally. :param sprite: The sprite we are removing. N)rrappend)rr lost_rects rr#AbstractGroup.remove_internals5 OOF+     # #I . OOF #rcXR;$)zc For checking if a sprite is in this group internally. :param sprite: The sprite we are checking. rrrs r has_internalAbstractGroup.has_internals ((rc@URUR55$)zcopy a group with all the same sprites Group.copy(): return Group Returns a copy of the group that is an instance of the same class and has the same sprites in it. )r@rr7s rcopyAbstractGroup.copys~~ LLN  rc4[UR55$r)iterrr7s r__iter__AbstractGroup.__iter__DLLN##rc$URU5$r)rrs rrAbstractGroup.__contains__sxxrcJUHdn[U[5(a<URU5(d$URU5 URU5 MRMTUR"U6 Mf g![ [ 4a [US5(aTUR5H=nURU5(aMURU5 URU5 M? MURU5(d&URU5 URU5 GMGMf=f)z|add sprite(s) to group Group.add(sprite, list, group, ...): return None Adds a sprite or sequence of sprites to a group. rN isinstancer rrr TypeErrorrMrrrrrsprs rrAbstractGroup.addsF&&))((00%%f-''-12HHf%">2 2 v~66#)>>#3C#'#4#4S#9#9 $ 1 1# 6 # 0 0 6$4"..v66))&1++D117 2A,,AD"8&D"!8D"!D"cJUHdn[U[5(a<URU5(a$URU5 URU5 MRMTUR"U6 Mf g![ [ 4a [US5(aTUR5H=nURU5(dMURU5 URU5 M? MURU5(a&URU5 URU5 GMGMf=f)zremove sprite(s) from group Group.remove(sprite, list, or group, ...): return None Removes a sprite or sequence of sprites from a group. rN) rr rr#r$rrMrrrs rr$AbstractGroup.removesF&&))$$V,,((0**40- 5KK(">25v~66#)>>#3C#0055 $ 4 4S 9 # 3 3D 9$4**622,,V4..t443 5rcU(dgUHIn[U[5(aURU5(d gM2UR"U6(d gMK g![[ 4ab [ US5(a4UR5HnURU5(aM  g MURU5(d gMf=f)aask if group has a sprite or sprites Group.has(sprite or group, ...): return bool Returns True if the given sprite or sprites are contained in the group. Alternatively, you can get the same information using the 'in' operator, e.g. 'sprite in group', 'subgroup in group'. FrT)rr rrrrMrrrs rrAbstractGroup.hassF&&))((00 1 )88V,$-$">2)v~66#)>>#3C#'#4#4S#9#9',$4 $0088#( 9 )s$AAC %C )C .C  C cVUR5HnUR"U0UD6 M g)zcall the update method of every member sprite Group.update(*args, **kwargs): return None Calls the update method of every member sprite. All arguments that were passed to this method are passed to the Sprite update function. N)rr/)rr-r.rs rr/AbstractGroup.update"s%llnF MM4 *6 *%rc j^UR5n[US5(a?URR[ UUR U4SjU5555 O>UH8nUR URURST5URU'M: /Ul URnU$)zdraw all sprites onto the surface Group.draw(surface, special_flags=0): return Rect_list Draws all of the member sprites onto the given surface. blitsc3V># UHoRURST4v M g7fr)imagerect).0r special_flagss r %AbstractGroup.draw..=s#"NUsCHHdMBgs&)N) rrrr/ziprblitrrr)rsurfacebgsurfrrrres ` rdrawAbstractGroup.draw.s,,. 7G $ $ OO " "MM"NU" '.||IIsxx}($   rcv[U5(aNURH nU"X5 M URR5HnU(dM U"X5 M gURnURH nU"X#U5 M URR5HnU(dM U"X$U5 M g)aMerase the previous position of all sprites Group.clear(surface, bgd): return None Clears the area under every drawn sprite in the group. The bgd argument should be Surface which is the same dimensions as the screen surface. The bgd could also be a function which accepts the given surface and the area to be cleared as arguments. N)callablerrvaluesr)rrbgdlost_clear_rect clear_rect surface_blits rr2AbstractGroup.clearLs C==#'#3#3G-$4"oo446 :,7#<""rcNSURRS[U5S3$)Nr>(z sprites)>)r@rArBr7s rrCAbstractGroup.__repr__~s&4>>**+1SYKzBBr)rrrNr)rArRrSrTrUrrrrr#rrrrrr$rr/rr2rrrrCrXr,rrrrksv L %  ' $)  $ !2F5@B +34<>2 )$#CrrTc\rSrSrSrSrSrg)Groupiamcontainer class for many Sprites pygame.sprite.Group(*sprites): return Group A simple container for Sprite objects. This class can be subclassed to create containers with more specific behaviors. The constructor takes any number of Sprite arguments to add to the Group. The group supports the following standard Python operations: in test if a Sprite is contained len the number of Sprites contained bool test if any Sprites are contained iter iterate through all the Sprites The Sprites in the Group are not ordered, so the Sprites are drawn and iterated over in no particular order. cL[RU5 UR"U6 gr)rrrrrs rrGroup.__init__st$ 'rr,N)rArRrSrTrUrrXr,rrrrs &rrc"\rSrSrSrSSjrSrg) RenderUpdatesizGroup class that tracks dirty updates pygame.sprite.RenderUpdates(*sprites): return RenderUpdates This class is derived from pygame.sprite.Group(). It has an enhanced draw method that tracks the changed areas of the screen. NcURnURn/UlURnUR5HnURUnU"UR UR SU5n U(a?U RU5(aU"U RU55 OU"U 5 U"U5 OU"U 5 XRU'M U$r) rrrrrrr colliderectunion) rrrrrre dirty_appendrold_rectnew_rects rrRenderUpdates.draws||   || llnFv.H#FLL&++t]SH''11 !9: * *X&&.OOF #% r)rr)rArRrSrTrUrrXr,rrrrs rrc4\rSrSrSrSrSrS SjrSrSr g) OrderedUpdatesiacRenderUpdates class that draws Sprites in order of addition pygame.sprite.OrderedUpdates(*sprites): return OrderedUpdates This class derives from pygame.sprite.RenderUpdates(). It maintains the order in which the Sprites were added to the Group for rendering. This makes adding and removing Sprites from the Group a little slower than regular Groups. c@/Ul[R"U/UQ76 gr) _spritelistrrrs rrOrderedUpdates.__init__st.g.rc6URR5$rrrr7s rrOrderedUpdates.spritess$$&&rNcd[RX5 URRU5 gr)rrrrrs rrOrderedUpdates.add_internals$""40 'rcd[RX5 URRU5 gr)rr#rr$rs rr#OrderedUpdates.remove_internals$%%d3 'rrr) rArRrSrTrUrrrr#rXr,rrrrs /'((rrc\rSrSrSr\"SSSS5rSrSSjrSr Sr S r SS jr S r S rS rSrSrSrSrSrSrSrSrSrSrSrg)LayeredUpdatesizLayeredUpdates Group handles layers, which are drawn like OrderedUpdates pygame.sprite.LayeredUpdates(*sprites, **kwargs): return LayeredUpdates This group is fully compatible with pygame.sprite.Sprite. New in pygame 1.8.0 rc0Ul/Ul[RU5 UR SS5UlUR "U0UD6 g)ainitialize an instance of LayeredUpdates with the given attributes You can set the default layer through kwargs using 'default_layer' and an integer for the layer. The default layer is 0. If the sprite you add has an attribute _layer, then that layer will be used. If **kwarg contains 'layer', then the passed sprites will be added to that layer (overriding the sprite._layer attribute). If neither the sprite nor **kwarg has a 'layer', then the default layer is used to add the sprites. default_layerrN) _spritelayersrrrget_default_layerr)rrr.s rrLayeredUpdates.__init__sF t$$jj!< '$V$rNc URURU'UcURnO[ US5(a [ USU5 URnURnX$U'[U5nS=pgUS- nXh::a'XhU- S--nXCUU::aUS-nOUS- nXh::aM'Xu:a"XCUU::aUS- nXu:a XCUU::aMURXq5 g![a URn[ USU5 Nf=f)WDo not use this method directly. It is used by the group to add a sprite internally. NrGrrdrl) _init_rectrrHrMrsetattrrrrrBinsert) rrrHrsprites_layerslenglowmidhighs rrLayeredUpdates.add_internals" #'// = 1 VX & & FHe ,""++!&v7| axk))Ccl+u4AgQw kj^CL9UB 1HCj^CL9UBs#1" 1++%0 1s C#DDczU(dgSU;aUSOSnUHgn[U[5(a<URU5(d$URXC5 URU5 MRMTUR"U0UD6 Mi g![ [ 4a [US5(aTUR5H=nURU5(aMURXS5 URU5 M? MURU5(d&URXC5 URU5 GMGM!f=f)aadd a sprite or sequence of sprites to a group LayeredUpdates.add(*sprites, **kwargs): return None If the sprite you add has an attribute _layer, then that layer will be used. If **kwarg contains 'layer', then the passed sprites will be added to that layer (overriding the sprite._layer attribute). If neither the sprite nor **kwarg has a 'layer', then the default layer is used to add the sprites. NrHrr)rrr.rHrrs rrLayeredUpdates.adds #*f#4w$F&&))((00%%f4''-12HHf//">2 2 v~66#)>>#3C#'#4#4S#9#9 $ 1 1# = # 0 0 6$4"..v66))&8++D117 2s-BAD:&D:98D:9D:cJURRU5 URUnX RLaURR U5 [ US5(a%URR UR5 URU URU g)zFDo not use this method directly. The group uses it to add a sprite. rN) rr$rrrrrrr)rrrs rr#LayeredUpdates.remove_internalIs '??6* ?? *    # #H - 66 " "    # #FKK 0 OOF #   v &rc6URR5$)zdreturn a ordered list of sprites (first back, last top). LayeredUpdates.sprites(): return sprites rr7s rrLayeredUpdates.spritesZs $$&&rcURnURnURn/UlURnURnUR 5Hun XIn U"U R U RSU5n XLa U"U 5 O>U RU 5(aU"U RU 55 OU"U 5 U"U 5 XU 'Mw U$)z~draw all sprites in the right order onto the passed surface LayeredUpdates.draw(surface, special_flags=0): return Rect_list N) rrrrrrrrrr) rrrrrrrer init_rectrrecnewrects rrLayeredUpdates.drawbs __ ||   || OO <<>C/C"399chhmLGW%&&s++ s!34 ) %%sO" rcURn[US5nURU5nUVs/sHoRUPM sn$s snf)zreturn a list with all sprites at that position LayeredUpdates.get_sprites_at(pos): return colliding_sprites Bottom sprites are listed first; the top ones are listed last. )rdrd)rrcollidelistall)rpos_spritesr colliding_idxis rget_sprites_atLayeredUpdates.get_sprites_at|sE##C ++H5 %23] ]333s?c URU$)zreturn the sprite at the index idx from the groups sprites LayeredUpdates.get_sprite(idx): return sprite Raises IndexOutOfBounds if the idx is not within range. r)ridxs r get_spriteLayeredUpdates.get_sprites$$rcFURU5nUR"U6 U$)z}remove all sprites from a layer and return them as a list LayeredUpdates.remove_sprites_of_layer(layer_nr): return sprites )get_sprites_from_layerr$)rlayer_nrrs rremove_sprites_of_layer&LayeredUpdates.remove_sprites_of_layers% --h7 WrcZ[[URR555$)zYreturn a list of unique defined layers defined. LayeredUpdates.layers(): return layers )sortedrrrr7s rlayersLayeredUpdates.layerss# c$,,335677rcURnURnURU5 URU5 [ U5nS=pgUS- nXh::a'XhU- S--nXCUU::aUS-nOUS- nXh::aM'Xu:a"XCUU::aUS- nXu:a XCUU::aMUR Xq5 [ US5(a [USU5 X$U'g)change the layer of the sprite LayeredUpdates.change_layer(sprite, new_layer): return None The sprite must have been added to the renderer already. This is not checked. rrdrlrGN)rrr$poprBrrr) rr new_layerrrrrrrs r change_layerLayeredUpdates.change_layers""++v6"7| axk))Ccl+y8AgQw kj^CL9YF 1HCj^CL9YFs# 68 $ $ FHi 0"+vrcLURRXR5$)zrreturn the layer that sprite is currently in If the sprite is not found, then it will return the default layer. )rrrrs rget_layer_of_sprite"LayeredUpdates.get_layer_of_sprites! !!%%f.A.ABBrc:URURS$)zDreturn the top layer LayeredUpdates.get_top_layer(): return layer rrr7s r get_top_layerLayeredUpdates.get_top_layers !!$"2"22"677rc:URURS$)zJreturn the bottom layer LayeredUpdates.get_bottom_layer(): return layer rr*r7s rget_bottom_layerLayeredUpdates.get_bottom_layers !!$"2"21"566rcBURXR55 g)zbring the sprite to front layer LayeredUpdates.move_to_front(sprite): return None Brings the sprite to front by changing the sprite layer to the top-most layer. The sprite is added at the end of the list of sprites in that top-most layer. N)r#r+rs r move_to_frontLayeredUpdates.move_to_fronts &"4"4"67rcHURXR5S- 5 g)zmove the sprite to the bottom layer LayeredUpdates.move_to_back(sprite): return None Moves the sprite to the bottom layer by moving it to a new layer below the current bottom layer. rdN)r#r.rs r move_to_backLayeredUpdates.move_to_backs  &"7"7"9A"=>rc URS$)zKreturn the topmost sprite LayeredUpdates.get_top_sprite(): return Sprite r)rr7s rget_top_spriteLayeredUpdates.get_top_sprites ##rc/nURnURnURH nXEU:Xa U"U5 MXEU:dM U$ U$)a return all sprites from a layer ordered as they where added LayeredUpdates.get_sprites_from_layer(layer): return sprites Returns all sprites from a layer. The sprites are ordered in the sequence that they where added. (The sprites are not removed from the layer. )rrr)rrHrsprites_append sprite_layersrs rr%LayeredUpdates.get_sprites_from_layers\ ** ##C!U*s##e+$rcURU5nURU5HnURXA5 M UR"USU06 g)zswitch the sprites from layer1_nr to layer2_nr LayeredUpdates.switch_layer(layer1_nr, layer2_nr): return None The layers number must exist. This method does not check for the existence of the given layers. rHN)rrr#r)r layer1_nr layer2_nrsprites1rs r switch_layerLayeredUpdates.switch_layersH// :..y9C   c -: 8,y,r)rrrrrr)rArRrSrTrUrrrrrr#rrrrrrr#r&r+r.r1r4r7rrArXr,rrrrs|aAq!J%(#$J)2V'"'4 4%8"+HC87 8 ?$, -rrc\rSrSrSrSrSSjrSSjr\S5r \S5r S r S r SS jr S rS rSrSrSrg) LayeredDirtyi&aLayeredDirty Group is for DirtySprites; subclasses LayeredUpdates pygame.sprite.LayeredDirty(*sprites, **kwargs): return LayeredDirty This group requires pygame.sprite.DirtySprite or any sprite that has the following attributes: image, rect, dirty, visible, blendmode (see doc of DirtySprite). It uses the dirty flag technique and is therefore faster than pygame.sprite.RenderUpdates if you have many static sprites. It also switches automatically between dirty rect updating and full screen drawing, so you do no have to worry which would be faster. As with the pygame.sprite.Group, you can specify some additional attributes through kwargs: _use_update: True/False (default is False) _default_layer: default layer where the sprites without a layer are added _time_threshold: threshold time for switching between dirty rect mode and fullscreen mode; defaults to updating at 80 frames per second, which is equal to 1000.0 / 80.0 New in pygame 1.8.0 c[R"U/UQ70UD6 SUlSUlSUlSUlUR 5H+up4US;dM [X5(dM[XU5 M- g)ainitialize group. pygame.sprite.LayeredDirty(*sprites, **kwargs): return LayeredDirty You can specify some additional attributes through kwargs: _use_update: True/False (default is False) _default_layer: default layer where the sprites without a layer are added _time_threshold: threshold time for switching between dirty rect mode and fullscreen mode; defaults to updating at 80 frames per second, which is equal to 1000.0 / 80.0 NFg)@) _use_update_time_thresholdr) rr_cliprFrG_bgditemsrr)rrr.keyrms rrLayeredDirty.__init__Asr 9w9&9  ,  HCJJwPP3' 'rNc>[US5(d [5e[US5(d [5e[US5(d [5e[U[5(d [ 5eUR S:XaSUl[ RXU5 g)rrertrfrrdN)rrMrrbrrerrrs rrLayeredDirty.add_internal]s~vw'' " "vy)) " "v{++ " "&+..+  <<1 FL##D%8rc zUR5nURnUcUnURnURnURn[ n UR n UbX lURn URU5 [5n UR(aiURUUU UUURUR5 U bUcSOUn UH nU "XX5 M URUU UU UU5 [U5nOwU bUcSOUn U "U SSU 5 UHSnUR (dMUc UR"OUn U "UR$UR&UR(U 5UU'MU U "U5/n[5nUU - UR*:aSUl OSUl /USS&URU5 U$)adraw all sprites in the right order onto the given surface LayeredDirty.draw(surface, bgsurf=None, special_flags=None): return Rect_list You can pass the background too. If a self.bgd is already set to some value that is not None, then the bgsurf argument has no effect. Passing a value to special_flags will pass that value as the special_flags argument to pass to all Surface.blit calls, overriding the sprite.blendmode attribute Nr)rrFT)get_cliprHrrrrrrIset_cliprrF_find_dirty_arearr_draw_dirty_internalr6rtrfrrrirG)rrrr orig_clip latest_clip local_spriteslocal_old_rect local_update rect_typesurf_blit_func local_bgd start_timeflagsr local_retrend_times rrLayeredDirty.drawss$$& jj  #K(( ''     III %[     ! !## $*2 'C"93>(  % %  \*I$*2 y&$>$;;;-:-BCMM E*8 388S__e+N3'%#;/0I; j 4#7#7 7$D #D  Q #rc UGHinUc UROUnURS:aUR(aURb\U"URR URR 5nURSUS- n URSUS- n OURnUS*n US*n URn URU5H8n U "XL5n U"URU U SU -U SU -U SU S4U5 M: GMUR(a+U"URURURU5X'URS:XdGMbSUlGMl g)Nrdrrl) rfrertrirtopleftsizeclipr r) _old_rect_rectr  _surf_blit_update_special_flagsrr] _spr_rect rect_offset_x rect_offset_y_spr_rect_cliprres rrS!LayeredDirty._draw_dirty_internalsSC%3%;CMMEyy1}??.!&chh&6&68L8L MI$'OOA$61$EM$'OOA$61$EM #I%.q\MM%.q\MM!*$33G !CIKrcrUGH0nURS:dMUR(a2U"URRURR5nOU"UR5nUR n UR n U "U5n U S:aU "XK5 XK U "U5n U S:aMU"URU55 XULdMU"X5nUR n UR n U "U5n U S:aU "XK5 XK U "U5n U S:aMU"URU55 GM3 g)Nrr))rerirrcrd collidelistunion_ipre) rHrfrgr ri_update_appendrr _union_rect_union_rect_collidelist_union_rect_union_iprs rrRLayeredDirty._find_dirty_areas#Cyy1}??"'(8(8#//:N:N"OK"'/K*5*A*A''2';';$+G4"f(4 /8A"f{//67>2"' "7K.9.E.E++6+?+?(/8Ab&,WZ8#J3G<b&#;#3#3E#:;5rcX lg)z?use to set background Group.clear(surface, bgd): return None N)rI)rrrs rr2LayeredDirty.clears  rcUR(a5URRURUR55 gURR[ U55 g)ztrepaint the given area LayeredDirty.repaint_rect(screen_rect): return None screen_rect is in screen coordinates. N)rHrrrerr screen_rects r repaint_rectLayeredDirty.repaint_rect"sG ::    # #K$4$4TZZ$@ A    # #D$5 6rcUc2[RR5R5UlOXlSUlg)zzclip the area where to draw; pass None (default) to reset the clip LayeredDirty.set_clip(screen_rect=None): return None NF)pygamedisplay get_surfaceget_rectrHrFr{s rrQLayeredDirty.set_clip/s4  335>>@DJ$J rcUR$)zMget the area where drawing will occur LayeredDirty.get_clip(): return Rect )rHr7s rrPLayeredDirty.get_clip;s zzrc`[RXU5 URS:XaSUlgg)r rrdN)rr#re)rrr"s rr#LayeredDirty.change_layerCs, ##D)< <<1 FL rcF[S[5 URU5 g)amset the threshold in milliseconds set_timing_treshold(time_ms): return None Defaults to 1000.0 / 80.0. This means that the screen will be painted using the flip method rather than the update method if the update method is taking so long to update the screen that the frame rate falls below 80 frames per second. Raises TypeError if time_ms is not int or float. zHThis function will be removed, use set_timing_threshold function insteadN)rDeprecationWarningset_timing_thresholdrtime_mss rset_timing_treshold LayeredDirty.set_timing_tresholdPs" V   !!'*rc[U[[45(aXlg[ SUR R S35e)anset the threshold in milliseconds set_timing_threshold(time_ms): return None Defaults to 1000.0 / 80.0. This means that the screen will be painted using the flip method rather than the update method if the update method is taking so long to update the screen that the frame rate falls below 80 frames per second. Raises TypeError if time_ms is not int or float. zExpected numeric value, got z insteadN)rintfloatrGrr@rArs rr!LayeredDirty.set_timing_thresholdcsA gU| , ,#* .w/@/@/I/I.J(S r)rIrHrGrFr)NN)rArRrSrTrUrrr staticmethodrSrRr2r}rQrPr#rrrXr,rrrDrD&sd4(89,Zx("("T<<> 7 ! +&rrDc\rSrSrSrSSjrSrSrSSjrSr S r S r \ S 5r \ RS 5r S rSrSrSrg) GroupSingleixaA group container that holds a single most recent item. This class works just like a regular group, but it only keeps a single sprite in the group. Whatever sprite has been added to the group last will be the only sprite in the group. You can access its one sprite as the .sprite attribute. Assigning to this attribute will properly remove the old sprite and then add the new one. Ncf[RU5 SUlUbURU5 ggr)rr_GroupSingle__spriterrs rrGroupSingle.__init__s.t$   HHV  rc,[UR5$r)rrr7s rrGroupSingle.copys4==))rc:URb UR/$/$rrr7s rrGroupSingle.spritess == $MM? " rcURb6URRU5 URUR5 Xlgr)rr#rs rrGroupSingle.add_internals5 == $ MM ) )$ /   / rcURSL$rrr7s rrGroupSingle.__bool__s}}D((rcUR$rrr7s r _get_spriteGroupSingle._get_sprites }}rcJURU5 URU5 U$r)rrs r _set_spriteGroupSingle._set_sprites# &!D! rc"UR5$)zN Property for the single sprite contained in this group :return: The sprite. )rr7s rrGroupSingle.sprites!!rc&URU5 gr)r)r sprite_to_sets rrrs 'rcxXRLaSUlXR;a[RX5 ggr)rrrr#rs rr#GroupSingle.remove_internals0 ]] " DM __ $  ) )$ 7 %rcURUL$rrrs rrGroupSingle.has_internal}}&&rcURUL$rrrs rrGroupSingle.__contains__rr)__spriter)rArRrSrTrUrrrrrrrrVrrWr#rrrXr,rrrrxse  *  ) "" ]]((8 ''rrcLURRUR5$)ancollision detection between two sprites, using rects. pygame.sprite.collide_rect(left, right): return bool Tests for collision between two sprites. Uses the pygame.Rect colliderect function to calculate the collision. It is intended to be passed as a collided callback function to the *collide functions. Sprites must have "rect" attributes. New in pygame 1.8.0 rr)leftrights r collide_rectrs 99  ,,rc*\rSrSrSrSrSrSrSrg)collide_rect_ratioia7A callable class that checks for collisions using scaled rects The class checks for collisions between two sprites using a scaled version of the sprites' rects. Is created with a ratio; the instance is then intended to be passed as a collided callback function to the *collide functions. New in pygame 1.8.1 cXlg)zcreate a new collide_rect_ratio callable Ratio is expected to be a floating point value used to scale the underlying sprite rect before checking for collisions. Nratiorrs rrcollide_rect_ratio.__init__s  rc SRURR[U5S-SR SUR R 555S9$) Turn the class into a string. <{klass} @{id:x} {attrs}> c36# UHupUSU<3v M g7f=Nr,rkvs rr.collide_rect_ratio.__repr__..J4IDAaS!<4Iklassidattrsformatr@rArjoinr^rJr7s rrCcollide_rect_ratio.__repr__T +11..))$x("((JDMM4G4G4IJJ2  rc<URnURnURnURnUR XS-U- Xc-U- 5nURnURnURnUR XS-U- Xc-U- 5nUR U5$)a=detect collision between two sprites using scaled rects pygame.sprite.collide_rect_ratio(ratio)(left, right): return bool Tests for collision between two sprites. Uses the pygame.Rect colliderect function to calculate the collision after scaling the rects by the stored ratio. Sprites must have "rect" attributes. )rrwidthheightinflater)rrrrleftrectrr rightrects r__call__collide_rect_ratio.__call__s 99##EME$96>F;RSJJ !!%%eme&;V^f=TU ##I..rrN rArRrSrTrUrrCrrXr,rrrrs   /rrc0URRURR- nURRURR- nUS-US--nURnURnXEU-S-:*$![a: URnSUR S-UR S--S--nXPlNZf=f![a: URnSUR S-UR S--S--nXqlNf=f)a`detect collision between two sprites using circles pygame.sprite.collide_circle(left, right): return bool Tests for collision between two sprites by testing whether two circles centered on the sprites overlap. If the sprites have a "radius" attribute, then that radius is used to create the circle; otherwise, a circle is created that is big enough to completely enclose the sprite's rect as given by the "rect" attribute. This function is intended to be passed as a collided callback function to the *collide functions. Sprites must have a "rect" and an optional "radius" attribute. New in pygame 1.8.0 rl?)rcenterxcenteryradiusrMrr) rr xdistance ydistancedistancesquared leftradiusr rightradiusrs rcollide_circler s" !!EJJ$6$66I !!EJJ$6$66IlY\1O![[ #ll  K7A= ==# !99X^^Q.!1CCKL  ! #JJ iooq093C3CQ3FF3NO " #s&' B 4 C AC CADDc*\rSrSrSrSrSrSrSrg)collide_circle_ratioi4aadetect collision between two sprites using scaled circles This callable class checks for collisions between two sprites using a scaled version of a sprite's radius. It is created with a ratio as the argument to the constructor. The instance is then intended to be passed as a collided callback function to the *collide functions. New in pygame 1.8.1 cXlg)acreates a new collide_circle_ratio callable instance The given ratio is expected to be a floating point value used to scale the underlying sprite radius before checking for collisions. When the ratio is ratio=1.0, then it behaves exactly like the collide_circle method. Nrrs rrcollide_circle_ratio.__init__@s  rc SRURR[U5S-SR SUR R 555S9$)rrrrc36# UHupUSU<3v M g7frr,rs rr0collide_circle_ratio.__repr__..Trrrrr7s rrCcollide_circle_ratio.__repr__LrrcXURnURRURR- nURRURR- nUS-US--nURnXs-nURn X-n XgU -S-:*$![ a: URnSUR S-URS--S--nXqlNbf=f![ a: URn SU R S-U RS--S--n XlNf=f)axdetect collision between two sprites using scaled circles pygame.sprite.collide_circle_radio(ratio)(left, right): return bool Tests for collision between two sprites by testing whether two circles centered on the sprites overlap after scaling the circle's radius by the stored ratio. If the sprites have a "radius" attribute, that is used to create the circle; otherwise, a circle is created that is big enough to completely enclose the sprite's rect as given by the "rect" attribute. Intended to be passed as a collided callback function to the *collide functions. Sprites must have a "rect" and an optional "radius" attribute. rlr)rrrrrrMrr) rrrrrrrrrrrs rrcollide_circle_ratio.__call__Ws)  II%% (:(:: II%% (:(:: #Q,A5 %J   ',,K   #;"AAA! %yyH!2X__a5G!GC OPJ$K  % ' I)//1"4y7G7G7J"Js!RSK&L  's&3 B C%AC"!C"%AD)(D)rNrr,rrrr4s    'BrrclURSURS- nURSURS- nURnURnUR XRU45$![a [UR5nNAf=f![a [UR5nNYf=f)acollision detection between two sprites, using masks. pygame.sprite.collide_mask(SpriteLeft, SpriteRight): bool Tests for collision between two sprites by testing if their bitmasks overlap. If the sprites have a "mask" attribute, that is used as the mask; otherwise, a mask is created from the sprite image. Intended to be passed as a collided callback function to the *collide functions. Sprites must have a "rect" and an optional "mask" attribute. New in pygame 1.8.0 rrd)rmaskrMr roverlap)rrxoffsetyoffsetleftmask rightmasks r collide_maskrsjjmdiil*Gjjmdiil*G,99.JJ    I'9 :: , +, . - .s$ A, B,B BB32B3cURRnU(a/nURnUR5H`nUb)U"X5(aUR 5 U"U5 M-M/U"UR5(dMHUR 5 U"U5 Mb U$Ub!UVs/sHos"X5(dMUPM sn$UVs/sHnU"UR5(dMUPM sn$s snfs snf)afind Sprites in a Group that intersect another Sprite pygame.sprite.spritecollide(sprite, group, dokill, collided=None): return Sprite_list Return a list containing all Sprites in a Group that intersect with another Sprite. Intersection is determined by comparing the Sprite.rect attribute of each Sprite. The dokill argument is a bool. If set to True, all Sprites that collide will be removed from the Group. The collided argument is a callback function used to calculate if two sprites are colliding. it should take two sprites as values, and return a bool value indicating if they are colliding. If collided is not passed, all sprites must have a "rect" value, which is a rectangle of the sprite area, which will be used to calculate the collision. )rrrrr3)rr dokillcollideddefault_sprite_collide_funccrashedr group_sprites r spritecolliders,#)++"9"9 !MMOL#F11 %%'<(2/|/@/@AA %%'<(,-2 -2\hv6TLU  " !L &|'8'8 9 !    s)C2=C2 C7)C7c0n[nU(a?UR5H)nU"XqX45nU(dMXU'UR5 M+ U$UHnU"XqX45nU(dMXU'M U$)aCdetect collision between a group and another group pygame.sprite.groupcollide(groupa, groupb, dokilla, dokillb): return dict Given two groups, this will find the intersections between all sprites in each group. It returns a dictionary of all sprites in the first group that collide. The value for each item in the dictionary is a list of the sprites in the second group it collides with. The two dokill arguments control if the sprites from either group will be automatically removed from all groups. Collided is a callback function used to calculate if two sprites are colliding. it should take two sprites as values, and return a bool value indicating if they are colliding. If collided is not passed, all sprites must have a "rect" value, which is a rectangle of the sprite area that will be used to calculate the collision. )rrr3) groupagroupbdokilladokillbrrsprite_collide_funcgroup_a_sprite collisions r groupcollider s}$G($nn.N+NGVIy*3'##% / N %N+NGVIy*3'% NrcURRnUbUHnU"X5(dMUs $ gUHnU"UR5(dMUs $ g)afinds any sprites in a group that collide with the given sprite pygame.sprite.spritecollideany(sprite, group): return sprite Given a sprite and a group of sprites, this will return any single sprite that collides with the given sprite. If there are no collisions, then this returns None. If you don't need all the features of the spritecollide function, this function will be a bit quicker. Collided is a callback function used to calculate if two sprites are colliding. It should take two sprites as values and return a bool value indicating if they are colliding. If collided is not passed, then all sprites must have a "rect" value, which is a rectangle of the sprite area, which will be used to calculate the collision. Nr)rr rrrs rspritecollideanyrsb,#)++"9"9!L--##" "L*<+<+<==##" rr)$rUtypingrrweakrefrwarningsrr pygame.rectr pygame.timer pygame.maskr r rZrbr}rr RenderPlain RenderClearrrrrDrrrrrrrr rr,rrrs *.D$ !$UUp??\ &\ ~j+ TCGGCL)TCnM2  E<(](8J-]J-Z O>Od C'-C'N - 7/7/t(>VJBJBZ;61h!H!r