Class Room

Inheritance
object
UnityEngine.Object
UnityEngine.Component
UnityEngine.Behaviour
UnityEngine.MonoBehaviour
Mirror.NetworkBehaviour
DewNetworkBehaviour
SingletonDewNetworkBehaviour<Room>
Room
Implements
Inherited Members
Namespace: Global
Assembly: Dew.Core.dll
Syntax
[RequireComponent(typeof(RoomMap))]
[RequireComponent(typeof(RoomMonsters))]
[RequireComponent(typeof(RoomProps))]
[RequireComponent(typeof(RoomRifts))]
[RequireComponent(typeof(RoomRewards))]
[RequireComponent(typeof(RoomModifiers))]
[RequireComponent(typeof(RoomEditorMaintenance))]
public class Room : SingletonDewNetworkBehaviour<Room>, ILogicUpdate

Fields

availableCameraAngles

Declaration
public float[] availableCameraAngles
Field Value
Type Description
float[]

ClientEvent_OnFootstep

Called everywhere everytime a footstep is done on an entity.

Declaration
public SafeAction<Entity> ClientEvent_OnFootstep
Field Value
Type Description
SafeAction<Entity>

ClientEvent_OnPrepareAsNonHostileRoom

Declaration
public SafeAction ClientEvent_OnPrepareAsNonHostileRoom
Field Value
Type Description
SafeAction

ClientEvent_OnRoomClear

Declaration
public SafeAction ClientEvent_OnRoomClear
Field Value
Type Description
SafeAction

ClientEvent_OnRoomStart

Declaration
public SafeAction ClientEvent_OnRoomStart
Field Value
Type Description
SafeAction

ClientEvent_WaypointLocked

Declaration
public SafeAction<Room_Waypoint> ClientEvent_WaypointLocked
Field Value
Type Description
SafeAction<Room_Waypoint>

ClientEvent_WaypointUnlocked

Declaration
public SafeAction<Room_Waypoint> ClientEvent_WaypointUnlocked
Field Value
Type Description
SafeAction<Room_Waypoint>

defaultSurface

Declaration
public DewSurfaceData defaultSurface
Field Value
Type Description
DewSurfaceData

metadata

Declaration
[ReadOnly]
public DewRoomMetadata metadata
Field Value
Type Description
DewRoomMetadata

music

Declaration
public DewMusicItem music
Field Value
Type Description
DewMusicItem

onRemoveObstacles

This is called on server when this room needs to clear any progression obstacles.
e.g. Barriers, Locked Shrines of Despair

Declaration
public SafeAction onRemoveObstacles
Field Value
Type Description
SafeAction

onRoomClear

Called on server when all combat sections are cleared / a hero steps on clear condition section.

Declaration
[FoldoutGroup("Events", 0)]
public UnityEvent onRoomClear
Field Value
Type Description
UnityEngine.Events.UnityEvent

openRoomExitOnClear

Declaration
[ToggleLeft]
public bool openRoomExitOnClear
Field Value
Type Description
bool

playerPathablePoints

Available everywhere.

Declaration
public readonly List<Vector3> playerPathablePoints
Field Value
Type Description
System.Collections.Generic.List<T><UnityEngine.Vector3>

Properties

didClearRoom

Available on server.

Declaration
public bool didClearRoom { get; }
Property Value
Type Description
bool

didRemoveObstacles

Available on server.

Declaration
public bool didRemoveObstacles { get; set; }
Property Value
Type Description
bool

heroSpawnPos

Available on server.

Declaration
public Vector3 heroSpawnPos { get; }
Property Value
Type Description
UnityEngine.Vector3

heroSpawnRot

Available on server.

Declaration
public Quaternion heroSpawnRot { get; }
Property Value
Type Description
UnityEngine.Quaternion

isActive

Declaration
public bool isActive { get; }
Property Value
Type Description
bool

isNonHostileRoom

Is this room modified to be a non-hostile room? Available everywhere.

Declaration
public bool isNonHostileRoom { get; set; }
Property Value
Type Description
bool

isRevisit

Are we revisiting this room? Available everywhere.

Declaration
public bool isRevisit { get; set; }
Property Value
Type Description
bool

map

Declaration
public RoomMap map { get; }
Property Value
Type Description
RoomMap

modifiers

Declaration
public RoomModifiers modifiers { get; }
Property Value
Type Description
RoomModifiers

monsters

Declaration
public RoomMonsters monsters { get; }
Property Value
Type Description
RoomMonsters

numOfActivatedCombatAreas

Declaration
public int numOfActivatedCombatAreas { get; }
Property Value
Type Description
int

props

Declaration
public RoomProps props { get; }
Property Value
Type Description
RoomProps

rewards

Declaration
public RoomRewards rewards { get; }
Property Value
Type Description
RoomRewards

rifts

Declaration
public RoomRifts rifts { get; }
Property Value
Type Description
RoomRifts

sections

Declaration
public IList<RoomSection> sections { get; }
Property Value
Type Description
System.Collections.Generic.IList<T><RoomSection>

unlockedWaypoints

Declaration
public IReadOnlyList<Room_Waypoint> unlockedWaypoints { get; }
Property Value
Type Description
System.Collections.Generic.IReadOnlyList<T><Room_Waypoint>

Methods

AddUnlockedWaypoint(Room_Waypoint)

Declaration
public void AddUnlockedWaypoint(Room_Waypoint waypoint)
Parameters
Type Name Description
Room_Waypoint waypoint

Awake()

Declaration
protected override void Awake()
Overrides
SingletonDewNetworkBehaviour<Room>.Awake()

ClearRoom()

Declaration
public void ClearRoom()

GetFinalSection()

Get a section closest to exit rift.

Declaration
public RoomSection GetFinalSection()
Returns
Type Description
RoomSection

GetHeroSpawnPosition()

Get randomly offset spawn position.

Declaration
public Vector3 GetHeroSpawnPosition()
Returns
Type Description
UnityEngine.Vector3

GetHeroSpawnRotation()

Get spawn rotation.

Declaration
public Quaternion GetHeroSpawnRotation()
Returns
Type Description
UnityEngine.Quaternion

GetRoomRandom(int)

Get a random instance for this room. States for these random instances are persistent.

Declaration
public DewRandom GetRoomRandom(int offset)
Parameters
Type Name Description
int offset
Returns
Type Description
DewRandom

GetSectionFromWorldPos(Vector3)

Declaration
public RoomSection GetSectionFromWorldPos(Vector3 pos)
Parameters
Type Name Description
UnityEngine.Vector3 pos
Returns
Type Description
RoomSection

OnLateStart()

Declaration
public override void OnLateStart()
Overrides

OnLateStartServer()

Declaration
public override void OnLateStartServer()
Overrides

OnStartClient()

Declaration
public override void OnStartClient()
Overrides

OnStartServer()

Declaration
public override void OnStartServer()
Overrides

OverrideHeroSpawn(Vector3, Quaternion)

Declaration
public void OverrideHeroSpawn(Vector3 pos, Quaternion rot)
Parameters
Type Name Description
UnityEngine.Vector3 pos
UnityEngine.Quaternion rot

RemoveCombat(bool)

Disables enemy spawns, and removes any existing enemies or camps.
It is recommended to call this with Dew.CallDelayed() if you're calling it in RoomModifierBase.OnCreate().

Declaration
public void RemoveCombat(bool clearRoomOnEnteringLastSection)
Parameters
Type Name Description
bool clearRoomOnEnteringLastSection

RemoveObstacles()

Remove any kind of progression-blocking obstacles, like barriers, locked teleport shrines and such.
It is recommended to call this with Dew.CallDelayed() if you're calling it in RoomModifierBase.OnCreate().

Declaration
public void RemoveObstacles()

RemoveUnlockedWaypoint(Room_Waypoint)

Declaration
public void RemoveUnlockedWaypoint(Room_Waypoint waypoint)
Parameters
Type Name Description
Room_Waypoint waypoint

SetCameraAngleIndex_Local(int)

Declaration
public void SetCameraAngleIndex_Local(int index)
Parameters
Type Name Description
int index

StartRoom()

Declaration
public void StartRoom()

StopRoom()

Declaration
public void StopRoom()

SyncCameraAngle()

Declaration
public void SyncCameraAngle()

Implements

Extension Methods