Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

Changeset 5936 for code


Ignore:
Timestamp:
Oct 13, 2009, 9:49:54 PM (15 years ago)
Author:
dafrick
Message:

Updated documentation in PlayerTrigger.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • code/trunk/src/orxonox/interfaces/PlayerTrigger.h

    r5781 r5936  
    4343    /**
    4444    @brief
    45         A PlayerTrigger is a trigger which is normally triggered by ControllableEntities and can as such return a pointer to the ControllableEntity which triggered it.
     45        A PlayerTrigger is a trigger which is normally triggered by Pawns and can as such return a pointer to the Pawn which triggered it.
    4646    @author
    4747        Damian 'Mozork' Frick
    … …  
    5555        /**
    5656        @brief Returns the player that triggered the PlayerTrigger.
    57         @return Returns a pointer to the ControllableEntity that triggered the PlayerTrigger.
     57        @return Returns a pointer to the Pawn that triggered the PlayerTrigger.
    5858        */
    5959        inline Pawn* getTriggeringPlayer(void) const
    … …  
    6161
    6262        /**
    63         @brief Checks whether the PlayerTrigger normally returns a ControllableEntity.
    64         @return Returns true if the PlayerTrigger normally returns a ControllableEntity.
     63        @brief Checks whether the PlayerTrigger normally returns a Pawn.
     64        @return Returns true if the PlayerTrigger normally returns a Pawn.
    6565        */
    6666        inline bool isForPlayer(void) const
    … …  
    7070        /**
    7171        @brief Set the player that triggered the PlayerTrigger. This is normally done by classes inheriting vom PlayerTrigger.
    72         @param player A pointer to the ControllableEntity that triggered the PlayerTrigger.
     72        @param player A pointer to the Pawn that triggered the PlayerTrigger.
    7373        */
    7474        inline void setTriggeringPlayer(Pawn* player)
    … …  
    7676
    7777            /**
    78             @brief Set whether the PlayerTrigger normally is triggered by ControllableEntities.
    79             @param isForPlayer Should be true when the PlayerTrigger should be set to normally be triggered by ControllableEntities, false if not.
     78            @brief Set whether the PlayerTrigger normally is triggered by Pawns.
     79            @param isForPlayer Should be true when the PlayerTrigger should be set to normally be triggered by Pawns, false if not.
    8080            */
    8181        inline void setForPlayer(bool isForPlayer)
    … …  
    8484    private:
    8585        Pawn* player_; //!< The player that triggered the PlayerTrigger.
    86         bool isForPlayer_; //!< Is true when the PlayerTrigger should be set to normally be triggered by ControllableEntities.
     86        bool isForPlayer_; //!< Is true when the PlayerTrigger should be set to normally be triggered by Pawns.
    8787
    8888    };
Note: See TracChangeset for help on using the changeset viewer.