Simulator::cToggleToolStrategy class
#include <Spore ModAPI/Spore/Simulator/cToggleToolStrategy.h>

Base classes

class cToolStrategy

Public static variables

static const uint32_t STRATEGY_ID
static const uint32_t TYPE

Public functions

auto OnSelect(cSpaceToolData* pTool) -> bool override
Called when the user clicks on the tool button to select it.
auto OnDeselect(cSpaceToolData* pTool) -> bool override
Called when the user clicks on the tool button to unselect it (that is, if the tool was previously selected and the user clicks again).
auto SelectedUpdate(cSpaceToolData* pTool, const Vector3& position) -> void override
Unlike Update, it's not executed if the game is paused.

Function documentation

bool Simulator::cToggleToolStrategy::OnSelect(cSpaceToolData* pTool) override

Called when the user clicks on the tool button to select it.

Parameters
pTool The space tool.

The return value is ignored.

bool Simulator::cToggleToolStrategy::OnDeselect(cSpaceToolData* pTool) override

Called when the user clicks on the tool button to unselect it (that is, if the tool was previously selected and the user clicks again).

Parameters
pTool The space tool.

The return value is ignored.

The default implementation does nothing, just returns true.