Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/mac_osx2/src/modules/objects/triggers/DistanceTriggerBeacon.h @ 8620

Last change on this file since 8620 was 7601, checked in by dafrick, 14 years ago

Adding all classes in modules/objects to Objects module (in doxygen).
Created TriggerBase which is the base class of Trigger and MultiTrigger and now provides the shared functionality and data.
Updated some of the documentation in MultiTrigger and Script.

  • Property svn:eol-style set to native
File size: 2.1 KB
Line 
1/*
2 *   ORXONOX - the hottest 3D action shooter ever to exist
3 *                    > www.orxonox.net <
4 *
5 *
6 *   License notice:
7 *
8 *   This program is free software; you can redistribute it and/or
9 *   modify it under the terms of the GNU General Public License
10 *   as published by the Free Software Foundation; either version 2
11 *   of the License, or (at your option) any later version.
12 *
13 *   This program is distributed in the hope that it will be useful,
14 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
15 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16 *   GNU General Public License for more details.
17 *
18 *   You should have received a copy of the GNU General Public License
19 *   along with this program; if not, write to the Free Software
20 *   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
21 *
22 *   Author:
23 *      Damian 'Mozork' Frick
24 *   Co-authors:
25 *      ...
26 *
27*/
28
29/**
30    @file DistanceTriggerBeacon.h
31    @brief Definition of the DistanceTriggerBeacon class.
32    @ingroup Triggers
33*/
34
35#ifndef _DistanceTriggerBeacon_H__
36#define _DistanceTriggerBeacon_H__
37
38#include "objects/ObjectsPrereqs.h"
39#include "core/XMLPort.h"
40#include "worldentities/StaticEntity.h"
41
42namespace orxonox
43{
44
45    /**
46    @brief
47        A DistanceTriggerBeacon can be used together with a @ref orxonox::DistanceTrigger "DistanceTrigger" or a @ref orxonox::DistanceMultiTrigger "DistanceMultiTrigger" to make them only react to specific objects.
48        This can be done by attaching a DistanceTriggerBeacon to an object, giving it a unique name and setting the targetname in the @ref orxonox::DistanceTrigger "DistanceTrigger" (or @ref orxonox::DistanceMultiTrigger "DistanceMultiTrigger") to that name and the target to DistanceTriggerBeacon.
49
50    @author
51        Damian 'Mozork' Frick
52
53    @ingroup Triggers
54    */
55    class _ObjectsExport DistanceTriggerBeacon : public StaticEntity
56    {
57
58        public:
59            DistanceTriggerBeacon(BaseObject* creator); //!< Constructor.
60            virtual ~DistanceTriggerBeacon() {} //!< Destructor.
61
62    };
63
64}
65
66#endif // _DistanceTriggerBeacon_H__
Note: See TracBrowser for help on using the repository browser.