PowerQuest 0.17.3
IRegion Interface Reference

Detailed Description

Region: Contains functions and data for manipluating Regions in rooms - Eg.

    if ( Regions.DiscoFloor.GetCharacterOnRegion( C.Dave ) )
        Regions.DiscoFloor.Tint = Color.blue;
    Regions.Chasm.Walkable = false;

Properties

string ScriptName [get]
 The name used in scripts. More...
 
MonoBehaviour Instance [get]
 Access to the actual game object component in the scene. More...
 
bool Enabled [get, set]
 Gets or Sets whether walking on to the region triggers OnEnterRegion and OnExitRegion events, or tints things. More...
 
bool Walkable [get, set]
 Gets or sets whether the player can walk on this hotspot. Use to create obstructions. More...
 
Color Tint [get, set]
 
Region Data [get]
 Access to the base class with extra functionality used by the PowerQuest. More...
 

Public Member Functions

bool GetCharacterOnRegion (ICharacter character=null)
 Returns true if the specified character is standing inside the region. More...
 
bool ContainsCharacter (ICharacter character=null)
 Returns true if the specified character is standing inside the region. More...
 
bool ContainsPoint (Vector2 position)
 Returns true if the specified position is inside the region. More...
 

Property Documentation

◆ ScriptName

string ScriptName
get

The name used in scripts.

◆ Instance

MonoBehaviour Instance
get

Access to the actual game object component in the scene.

◆ Enabled

bool Enabled
getset

Gets or Sets whether walking on to the region triggers OnEnterRegion and OnExitRegion events, or tints things.

◆ Walkable

bool Walkable
getset

Gets or sets whether the player can walk on this hotspot. Use to create obstructions.

◆ Data

Region Data
get

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

Member Function Documentation

◆ GetCharacterOnRegion()

bool GetCharacterOnRegion ( ICharacter  character = null)

Returns true if the specified character is standing inside the region.

If null is passed as the chracter, the function returns true for ANY character standing inside the region.

Note that if a character has changed room or been Enabled/Disabled this frame, this function can return the old result.

◆ ContainsCharacter()

bool ContainsCharacter ( ICharacter  character = null)

Returns true if the specified character is standing inside the region.

If null is passed as the chracter, the function returns true for ANY character standing inside the region.

Note that if a character has changed room or been Enabled/Disabled this frame, this function can return the old result.

◆ ContainsPoint()

bool ContainsPoint ( Vector2  position)

Returns true if the specified position is inside the region.