v3.6.1 Documentation
Fungus.ControlStage Class Reference

Controls the stage on which character portraits are displayed. More...

Inheritance diagram for Fungus.ControlStage:
Fungus.ControlWithDisplay< StageDisplayType >

Public Member Functions

override void OnEnter ()
 
override string GetSummary ()
 
override Color GetButtonColor ()
 
override void OnCommandAdded (Block parentBlock)
 

Protected Member Functions

virtual void Show (Stage stage, bool visible)
 
virtual void MoveToFront (Stage stage)
 
virtual void UndimAllPortraits (Stage stage)
 
virtual void DimNonSpeakingPortraits (Stage stage)
 
virtual void OnComplete ()
 
- Protected Member Functions inherited from Fungus.ControlWithDisplay< StageDisplayType >
virtual bool IsDisplayNone< TEnum > (TEnum enumValue)
 

Protected Attributes

Stage stage
 
Stage replacedStage
 
bool useDefaultSettings = true
 
float fadeDuration
 
bool waitUntilFinished = false
 
- Protected Attributes inherited from Fungus.ControlWithDisplay< StageDisplayType >
TDisplayEnum display
 

Properties

virtual Stage _Stage [get]
 
virtual bool UseDefaultSettings [get]
 
- Properties inherited from Fungus.ControlWithDisplay< StageDisplayType >
virtual TDisplayEnum Display [get]
 

Detailed Description

Controls the stage on which character portraits are displayed.

Definition at line 35 of file ControlStage.cs.

Member Function Documentation

◆ DimNonSpeakingPortraits()

virtual void Fungus.ControlStage.DimNonSpeakingPortraits ( Stage  stage)
protectedvirtual

Definition at line 101 of file ControlStage.cs.

◆ GetButtonColor()

override Color Fungus.ControlStage.GetButtonColor ( )

Definition at line 206 of file ControlStage.cs.

◆ GetSummary()

override string Fungus.ControlStage.GetSummary ( )

Definition at line 187 of file ControlStage.cs.

◆ MoveToFront()

virtual void Fungus.ControlStage.MoveToFront ( Stage  stage)
protectedvirtual

Definition at line 73 of file ControlStage.cs.

◆ OnCommandAdded()

override void Fungus.ControlStage.OnCommandAdded ( Block  parentBlock)

Definition at line 211 of file ControlStage.cs.

◆ OnComplete()

virtual void Fungus.ControlStage.OnComplete ( )
protectedvirtual

Definition at line 106 of file ControlStage.cs.

◆ OnEnter()

override void Fungus.ControlStage.OnEnter ( )

Definition at line 116 of file ControlStage.cs.

◆ Show()

virtual void Fungus.ControlStage.Show ( Stage  stage,
bool  visible 
)
protectedvirtual

Definition at line 54 of file ControlStage.cs.

◆ UndimAllPortraits()

virtual void Fungus.ControlStage.UndimAllPortraits ( Stage  stage)
protectedvirtual

Definition at line 90 of file ControlStage.cs.

Member Data Documentation

◆ fadeDuration

float Fungus.ControlStage.fadeDuration
protected

Definition at line 49 of file ControlStage.cs.

◆ replacedStage

Stage Fungus.ControlStage.replacedStage
protected

Definition at line 42 of file ControlStage.cs.

◆ stage

Stage Fungus.ControlStage.stage
protected

Definition at line 38 of file ControlStage.cs.

◆ useDefaultSettings

bool Fungus.ControlStage.useDefaultSettings = true
protected

Definition at line 45 of file ControlStage.cs.

◆ waitUntilFinished

bool Fungus.ControlStage.waitUntilFinished = false
protected

Definition at line 52 of file ControlStage.cs.

Property Documentation

◆ _Stage

virtual Stage Fungus.ControlStage._Stage
get

Definition at line 39 of file ControlStage.cs.

◆ UseDefaultSettings

virtual bool Fungus.ControlStage.UseDefaultSettings
get

Definition at line 46 of file ControlStage.cs.


The documentation for this class was generated from the following file: