UTFWin::CascadeEffect class
#include <Spore ModAPI/Spore/UTFWin/CascadeEffect.h>

Base classes

class Effect
class ICascadeEffect

Constructors, destructors, conversion operators

CascadeEffect()
~CascadeEffect() virtual

Public functions

auto AddRef() -> int override
auto Release() -> int override
auto Cast(uint32_t typeID) const -> void* override
auto GetEventFlags() const -> int override: Gets the flags that represent which type of messages this IWinProc can handle.
auto HandleUIMessage(IWindow* pWindow, const Message& message) -> bool override: Method called every time a message is received on a window that has this IWinProc added.
auto SetSerializer(Serializer& dst) -> void override
auto GetProxyID() const -> uint32_t override: Returns the ID that identifies this type of element in a SPUI file.
auto ToWinProc() -> IWinProc* override: Get the IWinProc instance that represents this class.
auto GetDelay() const -> float override: Get initial delay of the cascade, in seconds.
auto SetDelay(float delay) -> void override: Set initial delay of the cascade, in seconds.
auto GetInterval() const -> float override: Get interval between steps, in seconds.
auto SetInterval(float interval) -> void override: Set interval between steps, in seconds.

Protected variables

float mfDelay
float mfInterval
Clock mClock
int field_30
int field_34
bool field_38
bool field_39
int field_3C

Function documentation

int UTFWin::CascadeEffect::GetEventFlags() const override

Gets the flags that represent which type of messages this IWinProc can handle.

This allows for better performance, since generally a procedure only needs to listen specific events. The flags are in the kEventFlag... values.

bool UTFWin::CascadeEffect::HandleUIMessage(IWindow* pWindow, const Message& message) override

Method called every time a message is received on a window that has this IWinProc added.

Parameters
pWindow	The window that received this message.
message	The message received.
Returns	Whether the message was handled or not.

This method is responsible of handling (or not) the message. This method receives the IWindow that is currently receiving the message; this way, the same IWinProc can be listening for more than one window. This method returns whether the message was handled or not; if it was handled, no other IWinProcs will be called on that window.

void UTFWin::CascadeEffect::SetDelay(float delay) override

Set initial delay of the cascade, in seconds.

Parameters
delay

void UTFWin::CascadeEffect::SetInterval(float interval) override

Set interval between steps, in seconds.

Parameters
interval

UTFWin::CascadeEffect class #include <Spore ModAPI/Spore/UTFWin/CascadeEffect.h>