o OZh@sndZddlmZmZddlmZddlmZddlZddl m Z ddl m Z ddl mZGd d d ZGd d d eZGd ddeZGdddeeZGdddeedZGdddeZeZeZGdddeZGdddeZGdddeZGdddeZGdddeZd d!ZGd"d#d#Zd$d%ZGd&d'd'Zd(d)Z d0d*d+Z!d0d,d-Z"d0d.d/Z#dS)1a 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@szeZdZdZddZddZddZdd Zd d Zd d Z ddZ ddZ ddZ ddZ eddZejddZdS)Spriteasimple 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. cGst|_|r |j|dSdSN)set _Sprite__gaddselfgroupsr) __class____name__lenr r(rrr__repr__szSprite.__repr__cC|jS)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. _layerr(rrrlayersz Sprite.layercC|s ||_dStdNzbCan't set layer directly after adding to group. Use group.change_layer(sprite, new_layer) instead.r+r5AttributeErrorrvaluerrrr6  N)r0 __module__ __qualname____doc__rr rrrr#r%rr+r2propertyr6setterrrrrr cs    r cs eZdZdZfddZZS) 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. cs tj|t|j|jd<dS)Nr )superrrr __dict__rr/rrrs zWeakSprite.__init__)r0r>r?r@r __classcell__rrrFrrCsrCc@sdeZdZdZddZddZddZedd Zej d d Zed d Z e j d d Z ddZ dS) DirtySpriteaa 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. cGs<d|_d|_d|_t|dd|_d|_tj|g|RdS)Nrr5)dirty blendmode_visiblegetattrr5 source_rectr rrrrrr&s zDirtySprite.__init__cCs||_|jdkr d|_dSdS)z9set the visible value (0 or 1) and makes the sprite dirtyrIN)rLrJ)rvalrrr _set_visible2s  zDirtySprite._set_visiblecCr3)z'return the visible value of that sprite)rLr(rrr _get_visible8szDirtySprite._get_visiblecC|S)z You can make this sprite disappear without removing it from the group assign 0 for invisible and 1 for visible )rRr(rrrvisible<szDirtySprite.visiblecC||dSr )rQr;rrrrTDcCr3)a 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. r4r(rrrr6Hs zDirtySprite.layercCr7r8r9r;rrrr6Sr=cCsd|jjdt|dS)Nr-z DirtySprite(in r.)r/r0r1rr(rrrr2_szDirtySprite.__repr__N) r0r>r?r@rrQrRrArTrBr6r2rrrrrHs      rHc@seZdZdZdS)WeakDirtySpritez]A subclass of WeakSprite and DirtySprite that combines the benefits of both classes. N)r0r>r?r@rrrrrWesrWc@seZdZdZdZddZddZ d)dd Zd d Zd d Z ddZ ddZ ddZ ddZ ddZddZddZ d*ddZdd Zd!d"Zd#d$Zd%d&Zd'd(ZdS)+ AbstractGroupaTbase 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. TcCsi|_g|_dSr ) spritedict lostspritesr(rrrrzs zAbstractGroup.__init__cCr&)a~get 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'. )r'rYr(rrrsprites~s zAbstractGroup.spritesNcCsd|j|<dS)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 NrYrspriter6rrrrs zAbstractGroup.add_internalcCs&|j|}|r |j||j|=dS)zw For removing a sprite from this group internally. :param sprite: The sprite we are removing. N)rYrZappend)rr^Z lost_rectrrrrs   zAbstractGroup.remove_internalcCs ||jvS)z{ For checking if a sprite is in this group internally. :param sprite: The sprite we are checking. r\rr^rrr has_internal zAbstractGroup.has_internalcCs||S)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/r[r(rrrcopys zAbstractGroup.copycC t|Sr )iterr[r(rrr__iter__ zAbstractGroup.__iter__cCs ||Sr )rr`rrrr zAbstractGroup.__contains__c Gs|D]T}t|tr||s||||qz|j|WqttfyVt|drE|D]}||sC||||q2n||sT||||YqwdS)zadd sprite(s) to group Group.add(sprite, list, group, ...): return None Adds a sprite or sequence of sprites to a group. rN isinstancer rarr TypeErrorr:rr[rr[r^sprrrrr s,            zAbstractGroup.addc Gs|D]T}t|tr||r||||qz|j|WqttfyVt|drE|D]}||rC||||q2n||rT||||YqwdS)zremove sprite(s) from group Group.remove(sprite, list, or group, ...): return None Removes a sprite or sequence of sprites from a group. rN) rjr rarrrkr:rr[rlrrrrs,            zAbstractGroup.removec Gs|sdS|D]F}t|tr||sdSqz |j|s WdSWqttfyLt|drA|D] }||s?YdSq3n ||sJYdSYqwdS)a;ask 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)rjr rarrkr:rr[rlrrrrs.          zAbstractGroup.hascOs"|D] }|j|i|qdS)acall 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)r[r#)rr!r"r^rrrr#"s zAbstractGroup.updaterc sn|}t|dr|jt||fdd|Dn|D]}||j|jd|j|<qg|_ |j }|S)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. blitsc3s |] }|j|jdfVqdSr )imagerect).0rm special_flagsrr =s z%AbstractGroup.draw..N) r[rrYr#ziprnblitrorprZ)rsurfacebgsurfrsr[rmrJrrrrdraw.s"    zAbstractGroup.drawcCst|r |jD]}|||q|jD] }|r|||qdS|j}|jD]}||||q&|jD] }|r>||||q4dS)a}erase 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)callablerZrYvaluesrv)rrwbgdZlost_clear_rectZ clear_rect surface_blitrrrr$Ls      zAbstractGroup.clearcCs&|D] }||||qdS)zqremove all sprites Group.empty(): return None Removes all the sprites from the group. N)r[rr`rrremptyes   zAbstractGroup.emptycCrdr )r*r[r(rrr__bool__qrgzAbstractGroup.__bool__cCrd)zreturn number of sprites in group Group.len(group): return int Returns the number of sprites contained in the group. )r1r[r(rrr__len__ts zAbstractGroup.__len__cCsd|jjdt|dS)Nr-(z sprites)>)r/r0r1r(rrrr2~szAbstractGroup.__repr__r Nr)r0r>r?r@rrr[rrrarcrfrr rrr#ryr$r~rrr2rrrrrXks.     # !   rXTc@seZdZdZddZdS)Groupacontainer 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. cGst||j|dSr )rXrr rr[rrrrs zGroup.__init__N)r0r>r?r@rrrrrrs rc@seZdZdZdddZdS) RenderUpdateszGroup 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. Nrc Cs|j}|j}g|_|j}|D]1}|j|}||j|jd|} |r8| |r/|| |n || ||n|| | |j|<q|Sr ) rvrZr_r[rYrorp colliderectunion) rrwrxrsr}rJ dirty_appendr^old_rectZnew_rectrrrrys     zRenderUpdates.drawr)r0r>r?r@ryrrrrrs rc@s2eZdZdZddZddZd ddZd d ZdS) OrderedUpdatesa{RenderUpdates 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. cGsg|_tj|g|RdSr ) _spritelistrrrrrrrszOrderedUpdates.__init__cC |jSr rrcr(rrrr[rhzOrderedUpdates.spritesNcCt|||j|dSr )rrrr_r]rrrr zOrderedUpdates.add_internalcCrr )rrrrr`rrrrrzOrderedUpdates.remove_internalr )r0r>r?r@rr[rrrrrrrs    rc@seZdZdZeddddZddZd*ddZdd Zd d Z d d Z d+ddZ ddZ ddZ ddZddZddZddZddZddZd d!Zd"d#Zd$d%Zd&d'Zd(d)ZdS),LayeredUpdateszLayeredUpdates 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 rcOs8i|_g|_t||dd|_|j|i|dS)a+initialize 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. Z default_layerrN) _spritelayersrrXrget_default_layerr )rr[r"rrrrs   zLayeredUpdates.__init__Nc Cs|j|j|<|dur"z|j}Wnty!|j}t|d|Yn wt|dr-t|d||j}|j}|||<t |}d}}|d}||krd|||d}||||kr\|d}n|d}||ksG||kr||||kr|d7}||kr||||ksp| ||dS)gDo not use this method directly. It is used by the group to add a sprite internally. Nr5rrIrO) _init_rectrYr6r:rsetattrrrrr1insert) rr^r6r[sprites_layerslenglowmidhighrrrrs4      zLayeredUpdates.add_internalc Os|sdSd|vr |dnd}|D]Z}t|tr(||s'|||||qz |j|i|Wqttfyjt|drX|D]}||sV|||||qDn||sh|||||YqwdS)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. Nr6rri)rr[r"r6r^rmrrrr s2             zLayeredUpdates.addcCsX|j||j|}||jur|j|t|dr"|j|j|j|=|j|=dS)zVDo not use this method directly. The group uses it to add a sprite. rpN) rrrYrrZr_rrpr)rr^rrrrrIs      zLayeredUpdates.remove_internalcCr)ztreturn a ordered list of sprites (first back, last top). LayeredUpdates.sprites(): return sprites rr(rrrr[ZrbzLayeredUpdates.spritesc Cs|j}|j}|j}g|_|j}|j}|D]1} || } || j| jd|} | |ur.|| n| | r;|| | n|| || | || <q|S)zdraw all sprites in the right order onto the passed surface LayeredUpdates.draw(surface, special_flags=0): return Rect_list N) rYrvrZr_rr[rorprr) rrwrxrsrYr}rJr init_rectrmrecZnewrectrrrrybs"    zLayeredUpdates.drawcs,|jt|d}|}fdd|DS)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. )rIrIcsg|]}|qSrr)rqi_spritesrr sz1LayeredUpdates.get_sprites_at..)rrcollidelistall)rposrpZ colliding_idxrrrget_sprites_at|s  zLayeredUpdates.get_sprites_atcCs |j|S)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)ridxrrr get_spriter)zLayeredUpdates.get_spritecCs||}|j||S)zremove all sprites from a layer and return them as a list LayeredUpdates.remove_sprites_of_layer(layer_nr): return sprites )get_sprites_from_layerr)rZlayer_nrr[rrrremove_sprites_of_layers  z&LayeredUpdates.remove_sprites_of_layercCstt|jS)zireturn a list of unique defined layers defined. LayeredUpdates.layers(): return layers )sortedr rr{r(rrrlayersszLayeredUpdates.layersc Cs|j}|j}||||t|}d}}|d}||kr=|||d}||||kr5|d}n|d}||ks ||krY||||krY|d7}||krY||||ksI|||t|drjt|d||||<dS)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. rrIrOr5N)rrrpopr1rrr) rr^ new_layerr[rrrrrrrr change_layers(        zLayeredUpdates.change_layercCs|j||jS)zreturn the layer that sprite is currently in If the sprite is not found, then it will return the default layer. )rrrr`rrrget_layer_of_spriter z"LayeredUpdates.get_layer_of_spritecC|j|jdS)zTreturn the top layer LayeredUpdates.get_top_layer(): return layer rrr(rrr get_top_layerr zLayeredUpdates.get_top_layercCr)zZreturn the bottom layer LayeredUpdates.get_bottom_layer(): return layer rrr(rrrget_bottom_layerr zLayeredUpdates.get_bottom_layercCs|||dS)abring 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)rrr`rrr move_to_fronts zLayeredUpdates.move_to_frontcCs|||ddS)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. rIN)rrr`rrr move_to_backs zLayeredUpdates.move_to_backcCs |jdS)z[return the topmost sprite LayeredUpdates.get_top_sprite(): return Sprite rrr(rrrget_top_spriterbzLayeredUpdates.get_top_spritecCsHg}|j}|j}|jD]}|||kr||q |||kr!|Sq |S)a2return 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. )r_rr)rr6r[Zsprites_appendZ sprite_layersrmrrrrs     z%LayeredUpdates.get_sprites_from_layercCs:||}||D]}|||q |j|d|idS)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. r6N)rrrr )rZ layer1_nrZ layer2_nrZsprites1rmrrr switch_layers zLayeredUpdates.switch_layerr r)r0r>r?r@rrrrr rr[ryrrrrrrrrrrrrrrrrrrs,  %+    $   rc@s~eZdZdZddZdddZdddZed d Zed d Z d dZ ddZ dddZ ddZ ddZddZddZdS) LayeredDirtya.LayeredDirty 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 cOsdtj|g|Ri|d|_d|_d|_d|_|D]\}}|dvr/t||r/t|||qdS)a initialize 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_cliprr_bgditemsrr)rr[r"keyrPrrrrAs  zLayeredDirty.__init__NcCsbt|dstt|dstt|dstt|ts t|jdkr(d|_t|||dS)rrJrTrKrrIN)rr:rjrHrkrJrrr]rrrr]s     zLayeredDirty.add_internalc Csn|}|j}|dur |}|j}|j}|j}t} |j} |dur"||_|j} ||t } |j rd| ||| |||j |j | durU|durGdn|} |D] }| | ||| qK||| || ||t|}n5| durw|durndn|} | | dd| |D]}|jr|dur|jn|} | |j|j|j| ||<qy| |g}t }|| |jkrd|_ nd|_ g|dd<|||S)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_cliprrrYrZrrvrset_cliprr_find_dirty_arear_r_draw_dirty_internalr'rTrKrorprNr)rrwrxrsZ orig_clipZ latest_clipZ local_spritesZlocal_old_rectZ local_updateZ rect_typeZsurf_blit_funcZ local_bgd start_timeflagsrZ local_retrmend_timerrrryssn       zLayeredDirty.drawc Cs|D]}|dur |jn|}|jdkrm|jrm|jdur6||jj|jj}|jd|d} |jd|d} n |j}|d } |d } |j} ||D] } | || } ||j | | d| | d| | d| df|qKq|jr|||j |j|j|||<|jdkrd|_qdS)NrIrrO) rKrJrTrNrptopleftsizecliprro) _old_rect_rectrZ _surf_blit_updateZ_special_flagsrmrZ _spr_rectZ rect_offset_xZ rect_offset_yZ_spr_rect_cliprrrrrrs@       z!LayeredDirty._draw_dirty_internalc Cs|D]q}|jdkrs|jr||jj|jj}n||j}|j} |j} | |} | dkr:| || || =| |} | dks)||||||urs|||}|j} |j} | |} | dkrl| || || =| |} | dks[|||qdS)Nrr)rJrNrprrZ collidelistZunion_ipr) rrrrrZ_update_appendrrmZ _union_rectZ_union_rect_collidelistZ_union_rect_union_iprrrrrs6      zLayeredDirty._find_dirty_areacCs ||_dS)zOuse to set background Group.clear(surface, bgd): return None N)r)rrwr|rrrr$rbzLayeredDirty.clearcCs2|jr|j||jdS|jt|dS)zrepaint the given area LayeredDirty.repaint_rect(screen_rect): return None screen_rect is in screen coordinates. N)rrZr_rrrZ screen_rectrrr repaint_rect"szLayeredDirty.repaint_rectcCs*|dur tj|_n||_d|_dS)zclip the area where to draw; pass None (default) to reset the clip LayeredDirty.set_clip(screen_rect=None): return None NF)pygamedisplayZ get_surfaceZget_rectrrrrrrr/s zLayeredDirty.set_clipcCr3)z]get the area where drawing will occur LayeredDirty.get_clip(): return Rect )rr(rrrr;szLayeredDirty.get_clipcCs&t||||jdkrd|_dSdS)rrrIN)rrrJ)rr^rrrrrCs  zLayeredDirty.change_layercCstdt||dS)aset 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_thresholdrZtime_msrrrset_timing_tresholdPs  z LayeredDirty.set_timing_tresholdcCs,t|ttfr ||_dStd|jjd)aset 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)rjintfloatrrkr/r0rrrrrcs  z!LayeredDirty.set_timing_thresholdr )NN)r0r>r?r@rrry staticmethodrrr$rrrrrrrrrrr&s   \ *    rc@s~eZdZdZdddZddZddZdd d Zd d Zd dZ ddZ e ddZ e j ddZ ddZddZddZdS) GroupSingleaA 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. NcCs*t|d|_|dur||dSdSr )rXr_GroupSingle__spriter r`rrrrs zGroupSingle.__init__cCr&r )rrr(rrrrcrhzGroupSingle.copycCs|jdur |jgSgSr rr(rrrr[s zGroupSingle.spritescCs,|jdur|j|||j||_dSr )rrr]rrrrs    zGroupSingle.add_internalcCs |jduSr rr(rrrrrhzGroupSingle.__bool__cCr3r rr(rrr _get_spriteszGroupSingle._get_spritecCs|||||Sr )rr`rrr _set_sprites  zGroupSingle._set_spritecCrS)zf Property for the single sprite contained in this group :return: The sprite. )rr(rrrr^szGroupSingle.spritecCrUr )r)rZ sprite_to_setrrrr^rVcCs.||jurd|_||jvrt||dSdSr )rrYrXrr`rrrrs  zGroupSingle.remove_internalcC |j|uSr rr`rrrrarhzGroupSingle.has_internalcCrr rr`rrrrrhzGroupSingle.__contains__r )r0r>r?r@rrcr[rrrrrAr^rBrrarrrrrrxs      rcCs|j|jS)acollision 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 rpr)leftrightrrr collide_rects rc@(eZdZdZddZddZddZdS) collide_rect_ratioaOA 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 cC ||_dS)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. Nratiorrrrrrr,zcollide_rect_ratio.__init__cC2dj|jjt|d@ddd|jDdS)/ Turn the class into a string. <{klass} @{id:x} {attrs}> cs"|] \}}|d|VqdS=Nrrqkvrrrrt z.collide_rect_ratio.__repr__..klassidattrsformatr/r0rjoinrErr(rrrr2  zcollide_rect_ratio.__repr__cCsl|j}|j}|j}|j}|||||||}|j}|j}|j}|||||||}||S)aedetect 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. )rrpwidthheightZinflater)rrrrleftrectrr rightrectrrr__call__s  zcollide_rect_ratio.__call__Nr0r>r?r@rr2rrrrrrs   rc Cs|jj|jj}|jj|jj}|d|d}z|j}Wnty:|j}d|jd|jdd}||_Ynwz|j}Wnty]|j}d|jd|jdd}||_Ynw|||dkS)adetect 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 rO?)rpcenterxcenteryradiusr:rr) rr xdistance ydistancedistancesquared leftradiusr rightradiusrrrrcollide_circle s$      rc@r) collide_circle_ratioaydetect 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 cCr)a9creates 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. Nrrrrrr@s zcollide_circle_ratio.__init__cCr)rrrrcsrrrrrrrrtTrz0collide_circle_ratio.__repr__..rrr(rrrr2Lrzcollide_circle_ratio.__repr__c Cs|j}|jj|jj}|jj|jj}|d|d}z|j}Wnty=|j}d|jd|jdd}||_Ynw||9}z|j} Wntyd|j} d| jd| jdd} | |_Ynw| |9} ||| dkS)adetect 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. rOr)rrprrr r:rr) rrrrr r r r rrrrrrrWs*      zcollide_circle_ratio.__call__Nrrrrrr4s   rcCs|jd|jd}|jd|jd}z|j}Wnty't|j}Ynwz|j}Wnty;t|j}Ynw||||fS)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 rrI)rpmaskr:rrooverlap)rrZxoffsetZyoffsetZleftmaskZ rightmaskrrr collide_masks    rcsjj|r3g}|j}|D]!}dur#|r"|||q|jr0|||q|SdurAfdd|DSfdd|DS)a-find 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. Ncsg|] }|r|qSrrrq group_sprite)collidedr^rrrs  z!spritecollide..csg|] }|jr|qSr)rpr)default_sprite_collide_funcrrrs )rprr_r[r%)r^rZdokillrcrashedr_rr)rrr^r spritecollides,     rc Cshi}t}|r |D]}|||||}|r|||<|q |S|D]}|||||}|r1|||<q"|S)awdetect 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. )rr[r%) ZgroupaZgroupbZdokillaZdokillbrrZsprite_collide_funcZgroup_a_sprite collisionrrr groupcollides  rcCsP|jj}|dur|D] }|||r|Sq dS|D] }||jr%|SqdS)a finds 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)r^rrrrrrrspritecollideanys  rr )$r@typingrrweakrefrwarningsrrZ pygame.rectrZ pygame.timerZ pygame.maskrr rCrHrWrXrZ RenderPlainZ RenderClearrrrrrrrrrrrrrrrrrsHB      _OTG:+M  4$