Class HotspotSequenceSystem

Inheritance Relationships

Base Type

Class Documentation

class HotspotSequenceSystem : public csp::systems::SystemBase

Public facing system that allows the management of groupings of hotspots in a space.

Public Types

typedef std::function<void(const csp::multiplayer::SequenceHotspotChangedParams&)> HotspotSequenceChangedCallbackHandler

Public Functions

HotspotSequenceSystem(csp::systems::SequenceSystem *SequenceSystem, csp::systems::SpaceSystem *SpaceSystem, csp::multiplayer::EventBus *InEventBus)
void CreateHotspotGroup(const csp::common::String &GroupName, const csp::common::Array<csp::common::String> &HotspotIds, HotspotGroupResultCallback Callback)

Create a Hotspot group.

Parameters
void RenameHotspotGroup(const csp::common::String &GroupName, const csp::common::String &NewGroupName, HotspotGroupResultCallback Callback)

Rename a Hotspot group.

Parameters

  • CurrentGroupName – csp::common::String : The unique grouping name

  • NewGroupName – csp::common::String : The unique grouping name

  • Callback – HotspotGroupResultCallback : callback to call when a response is received

void UpdateHotspotGroup(const csp::common::String &GroupName, const csp::common::Array<csp::common::String> &HotspotIds, HotspotGroupResultCallback Callback)

Update a Hotspot group.

Parameters
void GetHotspotGroup(const csp::common::String &GroupName, HotspotGroupResultCallback Callback)

Get a Hotspot group by name.

Parameters

  • GroupName – csp::common::String : The unique grouping name

  • Callback – HotspotGroupResultCallback : callback to call when a response is received

void GetHotspotGroups(HotspotGroupsResultCallback Callback)

Get all Hotspot groups for the current space and logged in user.

Parameters

Callback – HotspotGroupsResultCallback : callback to call when a response is received

void DeleteHotspotGroup(const csp::common::String &GroupName, NullResultCallback Callback)

Delete a Hotspot group by name.

Parameters

  • GroupName – csp::common::String : The unique grouping name

  • Callback – NullResultCallback : callback to call when a response is received

~HotspotSequenceSystem()
void RemoveItemFromGroups(const csp::common::String &ItemName, csp::systems::NullResultCallback Callback)

This will delete any groups which only contain this item For any groups which contanin the given item and additional items, it will just update the group by removing the given item.

Parameters

  • ItemName – csp::common::String : An item to update all sequences containing.

  • Callback – NullResultCallback : callback to call when a response is received

void SetHotspotSequenceChangedCallback(HotspotSequenceChangedCallbackHandler Callback)

Sets a callback to be fired when a hotspot sequence is changed.

Parameters

Callback – HotspotSequenceChangedCallbackHandler: Callback to receive data for the hotspot sequence that has been changed.

virtual void RegisterSystemCallback() override

Registers the system to listen for the named event.

virtual void DeregisterSystemCallback() override

Deregisters the system from listening for the named event.

virtual void OnEvent(const std::vector<signalr::value> &EventValues) override

Deserialises the event values of the system.

Parameters

EventValues – std::vector<signalr::value> : event values to deserialise