Show / Hide Table of Contents

Class RoomBase

Base class for room in a level graph.

Inheritance
System.Object
RoomBase
CustomEditorControlsRoom
Dungeon1Room
GungeonRoom
MetroidvaniaRoom
Room
Namespace: Edgar.Unity
Assembly: cs.temp.dll.dll
Syntax
public abstract class RoomBase : ScriptableObject

Fields

Position

Position of the room in the graph editor.

Declaration
public Vector2 Position
Field Value
Type Description
Vector2
Remarks

This value is not used by the dungeon generator.

Methods

GetDisplayName()

Gets the display name of the room that is display in the graph editor.

Declaration
public abstract string GetDisplayName()
Returns
Type Description
System.String

GetEditorStyle(Boolean)

Gets the style for the level graph editor. Override this to change how are room nodes displayed in the editor.

Declaration
public virtual RoomEditorStyle GetEditorStyle(bool isFocused)
Parameters
Type Name Description
System.Boolean isFocused
Returns
Type Description
RoomEditorStyle

GetRoomTemplates()

Gets all the room templates that are available for the room.

Declaration
public abstract List<GameObject> GetRoomTemplates()
Returns
Type Description
System.Collections.Generic.List<GameObject>
Remarks

This method is used in the default implementation of the input setup task. If null or an empty list is returned, the input setup will use the default room template from the level graph.

OnValidate()

Declaration
protected virtual void OnValidate()

ToString()

Declaration
public override string ToString()
Returns
Type Description
System.String
In This Article
Back to top Generated by DocFX