Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

Ignore:
Timestamp:
May 23, 2011, 2:52:25 PM (14 years ago)
Author:
ssgier
Message:

added comments

File:
1 edited

Legend:

Unmodified
Added
Removed
  • code/branches/pickup/src/modules/pickup/items/ShrinkPickup.h

    r8535 r8536  
    5353    @ingroup PickupItems
    5454    */
     55
     56    /**
     57    @brief
     58        The ShrinkPickup is a Pickupable that causes the pawn to shrink to a certain size for a certain time with a certain speed, all of them specified in the following variables:
     59        - The @b shrinkFactor It determines how much the ship is going to shrink (e.g. the factor 2 would make the ship shrinking to half its size).
     60        - The @b duration Specifies how long the ship will keep small.
     61        - The @b shrinkSpeed Defines how fast the ship shrinks and grows.
     62
     63
     64        An example of a XML implementation of a HealthPickup would be:
     65        @code
     66        <HealthPickup
     67            shrinkFactor = "5.0"
     68            duration = "5.0"
     69            shrinkSpeed = "5.0"
     70        />
     71        @endcode
     72
     73    @author
     74        Sandro Sgier
     75
     76    @ingroup PickupItems
     77    */
     78
    5579    class _PickupExport ShrinkPickup : public Pickup, public Tickable
    5680    {
Note: See TracChangeset for help on using the changeset viewer.