PowerSlide.DialogueSlide Class Reference

Detailed Description

A dialogue slide. Essentially this is like a single cue card in a series of dialogue.

Inheritance diagram for PowerSlide.DialogueSlide:

Public Member Functions
override Slide	getSlideByID (int uniqueID)
	Gets a slide by a unique ID. More...
string	ApplyMood (string url)
	Swaps {mood} with the mood of this slide. More...
override void	load (JSObject json)
	Loads a slide from the given JSON. More...
Public Member Functions inherited from PowerSlide.Slide
	Slide ()
void	EndTimingLead ()
	Ends this slides timing lead. More...
void	TimingLeadBy (ITimingLeader leader)
	The timeline will now have its timing lead by the given leader. More...
void	cue ()
	Cues this slide right now. More...
SlideEvent	createEvent (string type)
	Creates an event relative to this slide. More...
Public Member Functions inherited from Dom.EventTarget
void	ClearEvents ()
	Clears all events on this document. More...
bool	dispatchEvent (Event e)
	Runs an event of the given name. More...
void	addEventListener (string name, EventListener listener)
	Adds an event listener to this document. More...
void	addEventListener (string name, EventListener listener, bool useCapture)
	Adds an event listener to this document. More...
void	removeEventListener (string name, object evtHandlerInternal)
	Removes an event listener from this document. More...
void	addEventListener (string name, AnimationEventDelegate method)
void	addEventListener (string name, AudioProcessingEventDelegate method)
void	addEventListener (string name, BeforeInputEventDelegate method)
void	addEventListener (string name, BeforeUnloadEventDelegate method)
void	addEventListener (string name, BlobEventDelegate method)
void	addEventListener (string name, ClipboardEventDelegate method)
void	addEventListener (string name, CloseEventDelegate method)
void	addEventListener (string name, CompositionEventDelegate method)
void	addEventListener (string name, CustomEventDelegate method)
void	addEventListener (string name, CSSFontFaceLoadEventDelegate method)
void	addEventListener (string name, DeviceLightEventDelegate method)
void	addEventListener (string name, DeviceMotionEventDelegate method)
void	addEventListener (string name, DeviceOrientationEventDelegate method)
void	addEventListener (string name, DeviceProximityEventDelegate method)
void	addEventListener (string name, DomEventDelegate method)
void	addEventListener (string name, DOMTransactionEventDelegate method)
void	addEventListener (string name, DragEventDelegate method)
void	addEventListener (string name, EditingBeforeInputEventDelegate method)
void	addEventListener (string name, ErrorEventDelegate method)
void	addEventListener (string name, FetchEventDelegate method)
void	addEventListener (string name, FocusEventDelegate method)
void	addEventListener (string name, GamepadEventDelegate method)
void	addEventListener (string name, HashChangeEventDelegate method)
void	addEventListener (string name, IDBVersionChangeEventDelegate method)
void	addEventListener (string name, InputEventDelegate method)
void	addEventListener (string name, KeyboardEventDelegate method)
void	addEventListener (string name, MediaStreamEventDelegate method)
void	addEventListener (string name, MessageEventDelegate method)
void	addEventListener (string name, MouseEventDelegate method)
void	addEventListener (string name, MutationEventDelegate method)
void	addEventListener (string name, OfflineAudioCompletionEventDelegate method)
void	addEventListener (string name, PageTransitionEventDelegate method)
void	addEventListener (string name, PointerEventDelegate method)
void	addEventListener (string name, PopStateEventDelegate method)
void	addEventListener (string name, ProgressEventDelegate method)
void	addEventListener (string name, RelatedEventDelegate method)
void	addEventListener (string name, RTCDataChannelEventDelegate method)
void	addEventListener (string name, RTCIdentityErrorEventDelegate method)
void	addEventListener (string name, RTCIdentityEventDelegate method)
void	addEventListener (string name, RTCPeerConnectionIceEventDelegate method)
void	addEventListener (string name, SensorEventDelegate method)
void	addEventListener (string name, StorageEventDelegate method)
void	addEventListener (string name, TextEventDelegate method)
void	addEventListener (string name, TimeEventDelegate method)
void	addEventListener (string name, TouchEventDelegate method)
void	addEventListener (string name, TrackEventDelegate method)
void	addEventListener (string name, TransitionEventDelegate method)
void	addEventListener (string name, UIEventDelegate method)
void	addEventListener (string name, UserProximityEventDelegate method)
void	addEventListener (string name, WebGLContextEventDelegate method)
void	addEventListener (string name, WheelEventDelegate method)
void	addEventListener (string name, Nitro.DynamicMethod< Nitro.Void > listener)
void	addEventListener (string name, Nitro.DynamicMethod< Nitro.Void > listener, bool capture)
void	addEventListener (string name, ContextEventDelegate method)
void	addEventListener (string name, SlideEventDelegate method)
void	addEventListener (string name, PowerUI.SpriteEventDelegate method)
void	addEventListener (string name, SVGEventDelegate method)
	Adds an event listener to this document. More...
void	addEventListener (string name, SVGZoomEventDelegate method)

Static Public Member Functions
static DialogueSlide[]	LoadOptions (JSObject json, DialogueSlide parent)
	Loads the given json as a set of options. More...

Public Attributes
bool	WaitForCue
	True if this slide waits for a cue. It's true if the slide does not have a defined duration. (because progression of dialogue is almost never regular enough for automatic durations to be usable). More...
Speaker[]	speakers
	One or more speakers who say this. Note that a single 'speaker' object can be multiple actual speakers. For example, it might be referring to a 'clan member' object. In the scene, there could be 5 clan members. More...
DialogueSlide	parent
	The parent slide of an option slide. More...
string	template
	An optional template to use. More...
string	slidesToGoTo
	When this slide runs, the set of slides to go to next. More...
string	audioFilePath
	Path to an audio file. If an audio file runs throughout the duration of dialogue, put it in a second dialogue track. More...
string	mood
	The mood of the speaker. Can be extracted from the SSML or directly declared in the slide. Note that plain text adopts the mood of the previous slide. More...
Public Attributes inherited from PowerSlide.Slide
bool	ignore
	True if this slide should be entirely ignored. More...
JSObject	rawJson
	The json the slide originated from. More...
int	index
	The index of this slide in its track. Note that these aren't unique. More...
Track	track
	The track this slide belongs to. More...
ITimingLeader	timing
	The timing leader for this slide (if it has one). More...
Css.Value	start
	Specified start value. More...
Css.Value	duration
	Specified duration value. More...
float	computedStart =0f
	The computed start value. More...
float	computedDuration =0f
	The computed duration. More...
Action[]	Actions
	Actions to trigger. More...
Public Attributes inherited from Dom.EventTarget
EventsSet	Events
	A set of events for this document. See addEventListener. More...

Package Functions
override void	Start ()
	This slide is now starting. More...
override void	End ()
	This dialogue is now offscreen. More...
void	LoadSpeaker (int index, JSObject data)
	Sets up a speaker at the given index in the Speakers set. More...
Package Functions inherited from PowerSlide.Slide
void	EndIfDone (bool backwards, float progress)
	Ends this slide if it's done. More...
virtual void	SetPause (bool paused)
	Called when the timeline is paused/ resumed and this slide is running. More...
void	LoadAction (int index, JSObject data)
	Sets up an action at the given index in the Actions set. More...

Package Attributes
string	markup
	The markup to show. More...
Package Attributes inherited from PowerSlide.Slide
int	uniqueID
	A unique ID (locally). Used to obtain a slide from e.g. a click event. More...
Slide	NextRunning
	The linked list of running slides. More...
Slide	PreviousRunning
	The linked list of running slides. More...

Properties
int	speakerCount [get]
	The number of speakers. Checks if speakers is null. More...
DialogueSlide[]	options [get]
	The complete options set. More...
bool	cued [get]
	A dialogue slide is classed as cued if it waits for a cue and it's not an options menu. Note that options menu's are cued, but you almost never want to visually display something like 'click to continue' on them. More...
bool	isOptions [get]
	True if this is an options slide. More...
Properties inherited from PowerSlide.Slide
float	computedEnd [get]
	The computed end value. More...
EventTarget	eventTarget [get]
	The event target to use. More...
Element	element [get]
	The element which the timeline is running on. More...
int	trackID [get]
	The ID of the track that this slide belongs to. More...
Timeline	timeline [get]
	The timeline that this slide is in. More...
bool	isActive [get]
	True if this slide has had start called but not end. I.e. it's actively running. More...
JSObject	this[string index] [get]
	Reads from the JSON. Specify custom values with this. More...
Properties inherited from Dom.EventTarget
static DispatchStack	dispatchStackRef [get]
	The active dispatch stack. Use event.deepPath to access it (available during dispatch only). More...
virtual EventTarget	eventTargetParentNode [get]
	The parent node as used by EventTarget during capture. Can be null. More...
virtual NodeList	eventTargetChildren [get]
	The childNode set as used by EventTarget during capture. Can be null. More...

Private Member Functions
void	PlayAudio ()
	Begins playing any audio More...
string	GetFromSet (string language, bool fallbackOnDefault, Dictionary< string, string > set)
	Gets a value from a localised set at the given language code. Optionally falls back onto the default language choice (usually 'en'). More...
void	UsePrevious (bool mood)
	Uses the speaker set from a previous slide which defined them. More...

Private Attributes
DialogueSlide[]	options_
	The raw options provided by this slide, if it is an options slide. More...
DialogueSlide[]	expandedOptions_
	Options can potentially be "remote" so dialogue trees can be easily extended. These are the options expanded fully (i.e. remote URLs are loaded). More...

Additional Inherited Members
Protected Member Functions inherited from Dom.EventTarget
T	GetFirstDelegate< T > (string name)
	Gets the first delegate event handler for the given event name. More...
virtual bool	HandleLocalEvent (Event e, bool bubblePhase)
	Handles triggering event handlers here. Elements can (and in PowerUI's case, do) override this. PowerUI overrides it to handle e.g. onclick="" attributes too. More...
Static Package Attributes inherited from Dom.EventTarget
static DispatchStack	PooledStack
	The current head of the pooled dispatched stacks. More...
Events inherited from PowerSlide.Slide
static SlideEventDelegate	OnLoad
	Use this and partial class extensions to add custom info loaded from JSON. More...

Member Function Documentation

string PowerSlide.DialogueSlide.ApplyMood ( string  url)

inline

Swaps {mood} with the mood of this slide.

override void PowerSlide.DialogueSlide.End ( )

inlinepackagevirtual

This dialogue is now offscreen.

Reimplemented from PowerSlide.Slide.

string PowerSlide.DialogueSlide.GetFromSet ( string  language, bool  fallbackOnDefault, Dictionary< string, string >  set  )

inlineprivate

Gets a value from a localised set at the given language code. Optionally falls back onto the default language choice (usually 'en').

override Slide PowerSlide.DialogueSlide.getSlideByID ( int  uniqueID)

inlinevirtual

Gets a slide by a unique ID.

Reimplemented from PowerSlide.Slide.

override void PowerSlide.DialogueSlide.load ( JSObject  json)

inlinevirtual

Loads a slide from the given JSON.

Reimplemented from PowerSlide.Slide.

static DialogueSlide [] PowerSlide.DialogueSlide.LoadOptions ( JSObject  json, DialogueSlide  parent  )

inlinestatic

Loads the given json as a set of options.

void PowerSlide.DialogueSlide.LoadSpeaker ( int  index, JSObject  data  )

inlinepackage

Sets up a speaker at the given index in the Speakers set.

void PowerSlide.DialogueSlide.PlayAudio ( )

inlineprivate

Begins playing any audio

override void PowerSlide.DialogueSlide.Start ( )

inlinepackagevirtual

This slide is now starting.

Reimplemented from PowerSlide.Slide.

void PowerSlide.DialogueSlide.UsePrevious ( bool  mood)

inlineprivate

Uses the speaker set from a previous slide which defined them.

Member Data Documentation

string PowerSlide.DialogueSlide.audioFilePath

Path to an audio file. If an audio file runs throughout the duration of dialogue, put it in a second dialogue track.

DialogueSlide [] PowerSlide.DialogueSlide.expandedOptions_

private

Options can potentially be "remote" so dialogue trees can be easily extended. These are the options expanded fully (i.e. remote URLs are loaded).

string PowerSlide.DialogueSlide.markup

package

The markup to show.

string PowerSlide.DialogueSlide.mood

The mood of the speaker. Can be extracted from the SSML or directly declared in the slide. Note that plain text adopts the mood of the previous slide.

DialogueSlide [] PowerSlide.DialogueSlide.options_

private

The raw options provided by this slide, if it is an options slide.

DialogueSlide PowerSlide.DialogueSlide.parent

The parent slide of an option slide.

string PowerSlide.DialogueSlide.slidesToGoTo

When this slide runs, the set of slides to go to next.

Speaker [] PowerSlide.DialogueSlide.speakers

One or more speakers who say this. Note that a single 'speaker' object can be multiple actual speakers. For example, it might be referring to a 'clan member' object. In the scene, there could be 5 clan members.

string PowerSlide.DialogueSlide.template

An optional template to use.

bool PowerSlide.DialogueSlide.WaitForCue

True if this slide waits for a cue. It's true if the slide does not have a defined duration. (because progression of dialogue is almost never regular enough for automatic durations to be usable).

Property Documentation

bool PowerSlide.DialogueSlide.cued

get

A dialogue slide is classed as cued if it waits for a cue and it's not an options menu. Note that options menu's are cued, but you almost never want to visually display something like 'click to continue' on them.

bool PowerSlide.DialogueSlide.isOptions

get

True if this is an options slide.

DialogueSlide [] PowerSlide.DialogueSlide.options

get

The complete options set.

int PowerSlide.DialogueSlide.speakerCount

get

The number of speakers. Checks if speakers is null.