IHotspot Interface Reference

Detailed Description

Hotspot: Contains functions and data for manipluating Hotspots in rooms - Eg:

    H.BlueCup.Cursor = "Drink";
    if  ( H.Tree.UseCount > 0 )
        H.Tree.Description = "Someone's cut it down";

Inherits IQuestClickableInterface.

Properties
string	Description [get, set]
	Gets/Sets the name shown to players.
string	ScriptName [get]
	The name used in scripts.
MonoBehaviour	Instance [get]
	Access to the actual game object component in the scene.
bool	Clickable [get, set]
	Gets or Sets whether clicking on the object triggers an event.
float	Baseline [get, set]
	Gets or sets the baseline used for sorting.
Vector2	WalkToPoint [get, set]
	Gets or sets the walk to point.
Vector2	LookAtPoint [get, set]
	Gets or sets the look at point.
string	Cursor [get, set]
bool	FirstUse [get]
	Returns true the first time the player "uses" the object.
bool	FirstLook [get]
	Returns true the first time the player "looked" at the object.
int	UseCount [get]
	Returns the number of times player has "used" at the object. 0 when it's the first click on the object.
int	LookCount [get]
	Returns the number of times player has "looked" at the object. 0 when it's the first click on the object.
Hotspot	Data [get]
	Access to the base class with extra functionality used by the PowerQuest.

Public Member Functions
void	Show ()
	Set's visible & clickable (Same as Enable())
void	Hide ()
	Set's invisible & non-clickable (Same as Disable())
void	Enable ()
	Set's visible & clickable.
void	Disable ()
	Set's invisible & non-clickable.

Property Documentation

Description

string Description

getset

Gets/Sets the name shown to players.

ScriptName

string ScriptName

get

The name used in scripts.

Instance

MonoBehaviour Instance

get

Access to the actual game object component in the scene.

Clickable

bool Clickable

getset

Gets or Sets whether clicking on the object triggers an event.

Baseline

float Baseline

getset

Gets or sets the baseline used for sorting.

WalkToPoint

Vector2 WalkToPoint

getset

Gets or sets the walk to point.

LookAtPoint

Vector2 LookAtPoint

getset

Gets or sets the look at point.

FirstUse

bool FirstUse

get

Returns true the first time the player "uses" the object.

FirstLook

bool FirstLook

get

Returns true the first time the player "looked" at the object.

UseCount

int UseCount

get

Returns the number of times player has "used" at the object. 0 when it's the first click on the object.

LookCount

int LookCount

get

Returns the number of times player has "looked" at the object. 0 when it's the first click on the object.

Data

Hotspot Data

get

Access to the base class with extra functionality used by the PowerQuest.

Member Function Documentation

Show()

void Show

(

)

Set's visible & clickable (Same as Enable())

Hide()

void Hide

(

)

Set's invisible & non-clickable (Same as Disable())

Enable()

void Enable

(

)

Set's visible & clickable.

Disable()

void Disable

(

)

Set's invisible & non-clickable.