PowerQuest
IRoom Interface Reference

Detailed Description

Room: Contains functions and data for manipluating Rooms - eg. if ( R.Kitchen.Visited ) {...}.

Properties

RoomComponent Instance [get]
 Access to the actual game object component in the scene. More...
 
string Description [get]
 Gets/Sets the name shown to players. More...
 
string ScriptName [get]
 The name used in scripts. More...
 
bool Visited [get]
 Returns true if the room has ever been visited by the plyaer. More...
 
bool FirstTimeVisited [get]
 Returns true if it's currently the first time the player has visited the room. More...
 
int TimesVisited [get]
 Returns The number of times the room has been visited. More...
 
int ActiveWalkableArea [get, set]
 Gets or sets the index currently active walkable area for the room. These are added in the editor. More...
 
bool PlayerVisible [get, set]
 Gets or sets whether the player character is visisble in this room. More...
 
float VerticalResolution [get, set]
 Sets the vertical resolution of this room (How many pixels high the camera view will be). If non-zero, it'll override the default set in PowerQuest. More...
 
float Zoom [get, set]
 Sets the vertical resolution of this room (How many pixels high the camera view will be) as a multiplier of the default vertical resolution set in PowerQuest. For temporary zoom changes use Camera.Zoom. More...
 
Room Data [get]
 Access to the base class with extra functionality used by the PowerQuest. More...
 

Public Member Functions

Hotspot GetHotspot (string name)
 Retreives a hotspot by name. More...
 
Prop GetProp (string name)
 Retreives a prop by name. More...
 
Region GetRegion (string name)
 Retreives a region by name. More...
 
Vector2 GetPoint (string name)
 Retreives a position by name. More...
 
void SetPoint (string name, Vector2 location)
 Moves a named room position to another location. More...
 
void SetPoint (string name, string fromPosition)
 Moves a named room position to the location of another named position. More...
 
List< Hotspot > GetHotspots ()
 Get the room's hotspot. More...
 
List< Prop > GetProps ()
 Get the room's prop. More...
 
GetScript< T > ()
 Access to the specific quest script for the room. Use the specific room script as the templated parameter so you can access specific members of the script. Eg: GetScript<RoomKitchen>().m_tapOn = true;. More...
 

Property Documentation

◆ Instance

RoomComponent Instance
get

Access to the actual game object component in the scene.

◆ Description

string Description
get

Gets/Sets the name shown to players.

◆ ScriptName

string ScriptName
get

The name used in scripts.

◆ Visited

bool Visited
get

Returns true if the room has ever been visited by the plyaer.

◆ FirstTimeVisited

bool FirstTimeVisited
get

Returns true if it's currently the first time the player has visited the room.

◆ TimesVisited

int TimesVisited
get

Returns The number of times the room has been visited.

◆ ActiveWalkableArea

int ActiveWalkableArea
getset

Gets or sets the index currently active walkable area for the room. These are added in the editor.

◆ PlayerVisible

bool PlayerVisible
getset

Gets or sets whether the player character is visisble in this room.

◆ VerticalResolution

float VerticalResolution
getset

Sets the vertical resolution of this room (How many pixels high the camera view will be). If non-zero, it'll override the default set in PowerQuest.

◆ Zoom

float Zoom
getset

Sets the vertical resolution of this room (How many pixels high the camera view will be) as a multiplier of the default vertical resolution set in PowerQuest. For temporary zoom changes use Camera.Zoom.

◆ Data

Room Data
get

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

Member Function Documentation

◆ GetHotspot()

Hotspot GetHotspot ( string  name)

Retreives a hotspot by name.

◆ GetProp()

Prop GetProp ( string  name)

Retreives a prop by name.

◆ GetRegion()

Region GetRegion ( string  name)

Retreives a region by name.

◆ GetPoint()

Vector2 GetPoint ( string  name)

Retreives a position by name.

◆ SetPoint() [1/2]

void SetPoint ( string  name,
Vector2  location 
)

Moves a named room position to another location.

◆ SetPoint() [2/2]

void SetPoint ( string  name,
string  fromPosition 
)

Moves a named room position to the location of another named position.

◆ GetHotspots()

List<Hotspot> GetHotspots ( )

Get the room's hotspot.

◆ GetProps()

List<Prop> GetProps ( )

Get the room's prop.

◆ GetScript< T >()

T GetScript< T > ( )

Access to the specific quest script for the room. Use the specific room script as the templated parameter so you can access specific members of the script. Eg: GetScript<RoomKitchen>().m_tapOn = true;.

Type Constraints
T :RoomScript<T>