Class HotspotSpaceComponent

• Defined in File HotspotSpaceComponent.h

Inheritance Relationships

Base Types

• public csp::multiplayer::ComponentBase (Class ComponentBase)

• public csp::multiplayer::IPositionComponent (Class IPositionComponent)

• public csp::multiplayer::IRotationComponent (Class IRotationComponent)

• public csp::multiplayer::IVisibleComponent (Class IVisibleComponent)

Class Documentation

class HotspotSpaceComponent : public csp::multiplayer::ComponentBase, public csp::multiplayer::IPositionComponent, public csp::multiplayer::IRotationComponent, public csp::multiplayer::IVisibleComponent

Data representation of an HotspotSpaceComponent.

Public Functions

HotspotSpaceComponent(SpaceEntity *Parent)

Constructs the Hotspot space component, and associates it with the specified Parent space entity.

Parameters

Parent – The Space entity that owns this component.

const csp::common::String &GetName() const

Gets the Name of the Hotspot.

Returns

The Name of the Hotspot.

void SetName(const csp::common::String &Value)

Sets the Name of this Hotspot.

Parameters

Value – The Name of this Hotspot.

bool GetIsTeleportPoint() const

Gets the IsTeleportPoint of this Hotspot.

void SetIsTeleportPoint(bool InValue)

Sets this Hotspot to be a teleport point.

Parameters

InValue – The teleport point state flag value.

bool GetIsSpawnPoint() const

Gets the IsSpawnPoint of this Hotspot.

void SetIsSpawnPoint(bool InValue)

Sets this Hotspot to be a spawn point.

Parameters

InValue – The spawn point state flag value.

csp::common::String GetUniqueComponentId() const

Gets a unique identifier for this component in the hierarchy.

Note

This does not give a complete hierarchy path, only the entityId of the parent for the component.

Returns

A string composed of ‘parentId:componentId’.