Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/notifications/src/modules/objects/triggers/DistanceTriggerBeacon.h @ 7689

Last change on this file since 7689 was 7301, checked in by dafrick, 14 years ago

Improving documentation for MultiTriggers, also some small bugfixes, simplifications and added features.

  • Property svn:eol-style set to native
File size: 1.9 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*/
33
34#ifndef _DistanceTriggerBeacon_H__
35#define _DistanceTriggerBeacon_H__
36
37#include "objects/ObjectsPrereqs.h"
38#include "core/XMLPort.h"
39#include "worldentities/StaticEntity.h"
40
41namespace orxonox
42{
43
44    /**
45    @brief
46        A DistanceTriggerBeacon can be used together with a DistanceTrigger or a DistanceMultiTrigger to make them only react to specific objects.
47        This can be done by attaching a DistanceTriggerBeacon to an object, giving it a unique name and setting the targetname in the DistanceTrigger (or DistanceMultiTrigger) to that name and the target to DistanceTriggerBeacon.
48    @author
49        Damian 'Mozork' Frick
50    */
51    class _ObjectsExport DistanceTriggerBeacon : public StaticEntity
52    {
53
54        public:
55            DistanceTriggerBeacon(BaseObject* creator); //!< Constructor.
56            virtual ~DistanceTriggerBeacon() {} //!< Destructor.
57
58    };
59
60}
61
62#endif // _DistanceTriggerBeacon_H__
Note: See TracBrowser for help on using the repository browser.