v3.6.1 Documentation
Fungus.Portrait Class Reference

Controls a character portrait. More...

Inheritance diagram for Fungus.Portrait:
Fungus.ControlWithDisplay< DisplayType >

Public Member Functions

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

Protected Attributes

Stage stage
 
Character character
 
Character replacedCharacter
 
Sprite portrait
 
PositionOffset offset
 
RectTransform fromPosition
 
RectTransform toPosition
 
FacingDirection facing
 
bool useDefaultSettings = true
 
float fadeDuration = 0.5f
 
float moveDuration = 1f
 
Vector2 shiftOffset
 
bool move
 
bool shiftIntoPlace
 
bool waitUntilFinished = false
 
- Protected Attributes inherited from Fungus.ControlWithDisplay< DisplayType >
TDisplayEnum display
 

Properties

virtual Stage _Stage [get, set]
 Stage to display portrait on. More...
 
virtual Character _Character [get, set]
 Character to display. More...
 
virtual Sprite _Portrait [get, set]
 Portrait to display. More...
 
virtual PositionOffset Offset [get, set]
 Move the portrait from/to this offset position. More...
 
virtual RectTransform FromPosition [get, set]
 Move the portrait from this position. More...
 
virtual RectTransform ToPosition [get, set]
 Move the portrait to this position. More...
 
virtual FacingDirection Facing [get, set]
 Direction character is facing. More...
 
virtual bool UseDefaultSettings [get, set]
 Use Default Settings. More...
 
virtual bool Move [get, set]
 Move portrait into new position. More...
 
virtual bool ShiftIntoPlace [get, set]
 Start from offset position. More...
 
- Properties inherited from Fungus.ControlWithDisplay< DisplayType >
virtual TDisplayEnum Display [get]
 

Additional Inherited Members

- Protected Member Functions inherited from Fungus.ControlWithDisplay< DisplayType >
virtual bool IsDisplayNone< TEnum > (TEnum enumValue)
 

Detailed Description

Controls a character portrait.

Definition at line 14 of file Portrait.cs.

Member Function Documentation

◆ GetButtonColor()

override Color Fungus.Portrait.GetButtonColor ( )

Definition at line 247 of file Portrait.cs.

◆ GetSummary()

override string Fungus.Portrait.GetSummary ( )

Definition at line 158 of file Portrait.cs.

◆ OnCommandAdded()

override void Fungus.Portrait.OnCommandAdded ( Block  parentBlock)

Definition at line 252 of file Portrait.cs.

◆ OnEnter()

override void Fungus.Portrait.OnEnter ( )

Definition at line 113 of file Portrait.cs.

Member Data Documentation

◆ character

Character Fungus.Portrait.character
protected

Definition at line 20 of file Portrait.cs.

◆ facing

FacingDirection Fungus.Portrait.facing
protected

Definition at line 38 of file Portrait.cs.

◆ fadeDuration

float Fungus.Portrait.fadeDuration = 0.5f
protected

Definition at line 44 of file Portrait.cs.

◆ fromPosition

RectTransform Fungus.Portrait.fromPosition
protected

Definition at line 32 of file Portrait.cs.

◆ move

bool Fungus.Portrait.move
protected

Definition at line 53 of file Portrait.cs.

◆ moveDuration

float Fungus.Portrait.moveDuration = 1f
protected

Definition at line 47 of file Portrait.cs.

◆ offset

PositionOffset Fungus.Portrait.offset
protected

Definition at line 29 of file Portrait.cs.

◆ portrait

Sprite Fungus.Portrait.portrait
protected

Definition at line 26 of file Portrait.cs.

◆ replacedCharacter

Character Fungus.Portrait.replacedCharacter
protected

Definition at line 23 of file Portrait.cs.

◆ shiftIntoPlace

bool Fungus.Portrait.shiftIntoPlace
protected

Definition at line 56 of file Portrait.cs.

◆ shiftOffset

Vector2 Fungus.Portrait.shiftOffset
protected

Definition at line 50 of file Portrait.cs.

◆ stage

Stage Fungus.Portrait.stage
protected

Definition at line 17 of file Portrait.cs.

◆ toPosition

RectTransform Fungus.Portrait.toPosition
protected

Definition at line 35 of file Portrait.cs.

◆ useDefaultSettings

bool Fungus.Portrait.useDefaultSettings = true
protected

Definition at line 41 of file Portrait.cs.

◆ waitUntilFinished

bool Fungus.Portrait.waitUntilFinished = false
protected

Definition at line 59 of file Portrait.cs.

Property Documentation

◆ _Character

virtual Character Fungus.Portrait._Character
getset

Character to display.

Definition at line 71 of file Portrait.cs.

◆ _Portrait

virtual Sprite Fungus.Portrait._Portrait
getset

Portrait to display.

Definition at line 76 of file Portrait.cs.

◆ _Stage

virtual Stage Fungus.Portrait._Stage
getset

Stage to display portrait on.

Definition at line 66 of file Portrait.cs.

◆ Facing

virtual FacingDirection Fungus.Portrait.Facing
getset

Direction character is facing.

Definition at line 96 of file Portrait.cs.

◆ FromPosition

virtual RectTransform Fungus.Portrait.FromPosition
getset

Move the portrait from this position.

Definition at line 86 of file Portrait.cs.

◆ Move

virtual bool Fungus.Portrait.Move
getset

Move portrait into new position.

Definition at line 106 of file Portrait.cs.

◆ Offset

virtual PositionOffset Fungus.Portrait.Offset
getset

Move the portrait from/to this offset position.

Definition at line 81 of file Portrait.cs.

◆ ShiftIntoPlace

virtual bool Fungus.Portrait.ShiftIntoPlace
getset

Start from offset position.

Definition at line 111 of file Portrait.cs.

◆ ToPosition

virtual RectTransform Fungus.Portrait.ToPosition
getset

Move the portrait to this position.

Definition at line 91 of file Portrait.cs.

◆ UseDefaultSettings

virtual bool Fungus.Portrait.UseDefaultSettings
getset

Use Default Settings.

Definition at line 101 of file Portrait.cs.


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