nuclide/src/shared/NSBrushTrigger.h

34 lines
1.2 KiB
C++

/*
* Copyright (c) 2016-2022 Vera Visions LLC.
*
* Permission to use, copy, modify, and distribute this software for any
* purpose with or without fee is hereby granted, provided that the above
* copyright notice and this permission notice appear in all copies.
*
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
* WHATSOEVER RESULTING FROM LOSS OF MIND, USE, DATA OR PROFITS, WHETHER
* IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
* OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
/** This entity class represents brush volume based triggers.
It's primary function is to consistently set up triggers.
In your sub-class you'll probably want to call `InitBrushTrigger()`
inside its `::Respawn()` reimplementation.
*/
class NSBrushTrigger:NSEntity
{
public:
void NSBrushTrigger(void);
/* overrides */
virtual int GetValue(entity);
/** Sets up a brush trigger volume based on the brush information. */
nonvirtual void InitBrushTrigger(void);
};