Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

Ignore:
Timestamp:
Nov 23, 2008, 4:31:36 PM (15 years ago)
Author:
dafrick
Message:

Some cleanup…

File:
1 edited

Legend:

Unmodified
Added
Removed

  • code/branches/questsystem2/src/orxonox/objects/quest/QuestEffectBeacon.h

    r2226 r2251  
    3030    @file QuestEffectBeacon.h
    3131    @brief
    32         Definition of the QuestEffectBeacon class.
     32    Definition of the QuestEffectBeacon class.
    3333*/
    3434
    … …  
    6161        A QuestEffectBeacon can be inactive or active.
    6262       
    63         Creating a QuestEffectBeacon through XML goes as follows:
    64        
    65         <QuestEffectBeacon times=n> //Where 'n' is eighter a number >= 0, which means the QuestEffectBeacon can be executed n times. Or n = -1, which means the QuestEffectBeacon can be executed an infinite number of times.
     63    Creating a QuestEffectBeacon through XML goes as follows:
     64   
     65    <QuestEffectBeacon times=n> //Where 'n' is eighter a number >= 0, which means the QuestEffectBeacon can be executed n times. Or n = -1, which means the QuestEffectBeacon can be executed an infinite number of times.
    6666            <effects>
    6767                <QuestEffect /> //A list of QuestEffects, invoked when the QuestEffectBeacon is executed, see QuestEffect for the full XML representation.
    … …  
    7070            </effects>
    7171            <events>
    72                 <execute>
    73                     <EventListener event=eventIdString />
    74                 </execute>
    75             </events>
    76             <attached>
    77                <PlayerTrigger name=eventIdString /> //A PlayerTrigger triggering the execution of the QuestEffectBeacon.
    78             </attached>
    79         </QuestEffectBeacon>
     72        <execute>
     73            <EventListener event=eventIdString />
     74        </execute>
     75        </events>
     76        <attached>
     77           <PlayerTrigger name=eventIdString /> //A PlayerTrigger triggering the execution of the QuestEffectBeacon.
     78        </attached>
     79    </QuestEffectBeacon>
    8080    @author
    8181        Damian 'Mozork' Frick
    … …  
    8383    class _OrxonoxExport QuestEffectBeacon : public PositionableEntity
    8484    {
    85         public:
    86             QuestEffectBeacon(BaseObject* creator);
    87             virtual ~QuestEffectBeacon();
    88            
    89             virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode); //!< Method for creating a QuestEffectBeacon object through XML.
    90            
    91             virtual void processEvent(Event& event); //!< Processes an event for this QuestEffectBeacon.
    92            
    93             bool execute(bool b, PlayerTrigger* trigger); //!< Executes the QuestEffects of the QuestEffectBeacon.
    94            
    95             /**
    96             @brief Tests whether the QuestEffectBeacon is active.
    97             @return Returns true if the QuestEffectBeacon is active, fals if not.
    98             */
    99             inline bool isActive(void)
    100                { return this->status_ == QuestEffectBeaconStatus::active; }
    101            
    102             bool setActive(bool activate); //!< Set the status of the QuestEffectBeacon.
    103            
    104         protected:
     85    public:
     86        QuestEffectBeacon(BaseObject* creator);
     87        virtual ~QuestEffectBeacon();
     88       
     89        virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode); //!< Method for creating a QuestEffectBeacon object through XML.
     90       
     91        virtual void processEvent(Event& event); //!< Processes an event for this QuestEffectBeacon.
     92       
     93        bool execute(bool b, PlayerTrigger* trigger); //!< Executes the QuestEffects of the QuestEffectBeacon.
     94       
     95        /**
     96        @brief Tests whether the QuestEffectBeacon is active.
     97        @return Returns true if the QuestEffectBeacon is active, fals if not.
     98        */
     99        inline bool isActive(void)
     100           { return this->status_ == QuestEffectBeaconStatus::active; }
     101       
     102        bool setActive(bool activate); //!< Set the status of the QuestEffectBeacon.
     103       
     104    protected:
    105105            bool decrementTimes(void); //!< Decrement the number of times the QuestEffectBeacon can still be executed.
    106106           
Note: See TracChangeset for help on using the changeset viewer.