PixelCrushers.DialogueSystem.DisplaySettings.CameraSettings Class Reference
Collaboration diagram for PixelCrushers.DialogueSystem.DisplaySettings.CameraSettings:

Public Member Functions

 CameraSettings ()
 
 CameraSettings (CameraSettings source)
 

Public Attributes

Camera sequencerCamera = null
 The camera (or prefab) to use for sequences.
 
GameObject alternateCameraObject = null
 An alternate camera object to use instead of sequencerCamera.
 
GameObject cameraAngles = null
 The camera angle object (or prefab) to use for the "Camera()" sequence command.
 
bool keepCameraPositionAtConversationEnd = false
 If conversation's sequences use Main Camera, leave camera in current position at end of conversation instead of restoring pre-conversation position.
 
bool showSubtitleOnEmptyContinue = false
 
string defaultSequence = "Delay({{end}})"
 The default sequence to use if the dialogue entry doesn't have a sequence defined in its Sequence field.
 
string defaultPlayerSequence = string.Empty
 
string defaultResponseMenuSequence = string.Empty
 
EntrytagFormat entrytagFormat = EntrytagFormat.ActorName_ConversationID_EntryID
 The format to use for the entrytag keyword.
 
bool reportMissingAudioFiles = false
 By default, Audio() and AudioWait() sequencer commands don't report missing audio files to reduce Console spam during development.
 
bool disableInternalSequencerCommands = false
 Set true to disable the internal sequencer commands – for example, if you want to replace them with your own.
 

Constructor & Destructor Documentation

◆ CameraSettings() [1/2]

PixelCrushers.DialogueSystem.DisplaySettings.CameraSettings.CameraSettings ( )
inline

◆ CameraSettings() [2/2]

PixelCrushers.DialogueSystem.DisplaySettings.CameraSettings.CameraSettings ( CameraSettings  source)
inline

Member Data Documentation

◆ alternateCameraObject

GameObject PixelCrushers.DialogueSystem.DisplaySettings.CameraSettings.alternateCameraObject = null

An alternate camera object to use instead of sequencerCamera.

Use this, for example, if you have an Oculus VR GameObject that's a parent of two cameras. Currently this must be an object in the scene, not a prefab.

◆ cameraAngles

GameObject PixelCrushers.DialogueSystem.DisplaySettings.CameraSettings.cameraAngles = null

The camera angle object (or prefab) to use for the "Camera()" sequence command.

See Camera() for more information.

◆ defaultPlayerSequence

string PixelCrushers.DialogueSystem.DisplaySettings.CameraSettings.defaultPlayerSequence = string.Empty

◆ defaultResponseMenuSequence

string PixelCrushers.DialogueSystem.DisplaySettings.CameraSettings.defaultResponseMenuSequence = string.Empty

◆ defaultSequence

string PixelCrushers.DialogueSystem.DisplaySettings.CameraSettings.defaultSequence = "Delay({{end}})"

The default sequence to use if the dialogue entry doesn't have a sequence defined in its Sequence field.

See dialogueCreation and sequencer for more information. The special keyword "{{end}}" gets replaced by the default duration for the subtitle being displayed.

◆ disableInternalSequencerCommands

bool PixelCrushers.DialogueSystem.DisplaySettings.CameraSettings.disableInternalSequencerCommands = false

Set true to disable the internal sequencer commands – for example, if you want to replace them with your own.

◆ entrytagFormat

EntrytagFormat PixelCrushers.DialogueSystem.DisplaySettings.CameraSettings.entrytagFormat = EntrytagFormat.ActorName_ConversationID_EntryID

The format to use for the entrytag keyword.

◆ keepCameraPositionAtConversationEnd

bool PixelCrushers.DialogueSystem.DisplaySettings.CameraSettings.keepCameraPositionAtConversationEnd = false

If conversation's sequences use Main Camera, leave camera in current position at end of conversation instead of restoring pre-conversation position.

◆ reportMissingAudioFiles

bool PixelCrushers.DialogueSystem.DisplaySettings.CameraSettings.reportMissingAudioFiles = false

By default, Audio() and AudioWait() sequencer commands don't report missing audio files to reduce Console spam during development.

Set this true to report missing audio files.

◆ sequencerCamera

Camera PixelCrushers.DialogueSystem.DisplaySettings.CameraSettings.sequencerCamera = null

The camera (or prefab) to use for sequences.

If unassigned, the sequencer will use the main camera; when the sequence is done, it will restore the main camera's original position.

◆ showSubtitleOnEmptyContinue

bool PixelCrushers.DialogueSystem.DisplaySettings.CameraSettings.showSubtitleOnEmptyContinue = false

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