User Tools

Site Tools


DzInteractiveLessonMgr

Manager that handles interactive lessons.

More...

Inherits :

Properties

DAZ Script
NumberprogressWidth

Methods

DAZ Script
voidbegin ( String path )
voidbegin ( Array instructions )
NumbercurrentIndex ()
StringcurrentPath ()
BooleancurrentQuery ()
NumbercurrentQuery ()
StringcurrentQuery ()
StringcurrentType ()
StringgetActionInstruction ( String classname, String info, String tag=“”, Boolean locateOnly=false )
StringgetActivityInstruction ( String activity, String info, String tag=“”, Boolean locateOnly=false )
StringgetDisplayInstruction ( String info, String button=“” )
StringgetInstruction ( String type, ByteArray query, String info, String tag=“”, Boolean locateOnly=false )
StringgetInstruction ( String type, String query, String info, String tag=“”, Boolean locateOnly=false )
StringgetInstruction ( String type, Boolean query, String info, String tag=“”, Boolean locateOnly=false )
StringgetInstruction ( String type, Number query, String info, String tag=“”, Boolean locateOnly=false )
StringgetLayoutInstruction ( String layout, String info, String tag=“”, Boolean locateOnly=false )
StringgetWidgetInstruction ( String widgetPath, String info, String tag=“”, Boolean locateOnly=false )
ArrayinstructionTypes ()
BooleanisRunning ()
voiditerate ()
voidskip ()
voidstop ()

Signals

voidskipped ()
voidstarted ()
voidstepped ()
voidstopped ( Boolean success )

Detailed Description

This class manages interactive lessons that the user can perform in the interface via lessonstripwgt_dz. There is only one instance of this manager in an application. This instance is created and owned by DzMainWindow. Request the instance from DzMainWindow via DzMainWindow::getInteractiveLessonMgr().

Properties


Number : progressWidth

The width of the progress indicator displayed above the instruction box.

Methods


void : begin( String path )

Starts the lesson using a list of instructions in a separate file.

Parameter(s):

  • path - The absolute path to a file that provides a list of instructions for the lesson.

See Also:

  • dzscript{api_reference/samples/education/interactive_lessons/start, Interactive Lessons}

void : begin( Array instructions )

Starts the lesson using the instructions list.

Parameter(s):

  • instructions - The list of instructions for the lesson.

See Also:

  • dzscript{api_reference/samples/education/interactive_lessons/start, Interactive Lessons}

Number : currentIndex()

Return Value:

  • The index of the current instruction within the lesson.

String : currentPath()

Return Value:

  • The path of the current lesson.

Boolean : currentQuery()

Return Value:

  • The query of the current instruction within the lesson.

Number : currentQuery()

TODO: Add description.


String : currentQuery()

TODO: Add description.


String : currentType()

Return Value:

  • The type of the current instruction within the lesson.

String : getActionInstruction( String classname, String info, String tag=“”, Boolean locateOnly=false )

Return Value:

  • A string representation of an “action” type instruction.

See Also:

  • JSON::parse()
  • dzscript{api_reference/samples/education/interactive_lessons/start, Interactive Lessons}

String : getActivityInstruction( String activity, String info, String tag=“”, Boolean locateOnly=false )

Return Value:

  • A string representation of an “activity” type instruction.

See Also:

  • JSON::parse()
  • dzscript{api_reference/samples/education/interactive_lessons/start, Interactive Lessons}

String : getDisplayInstruction( String info, String button=“” )

Return Value:

  • A string representation of a “display” type instruction.

See Also:

  • JSON::parse()
  • dzscript{api_reference/samples/education/interactive_lessons/start, Interactive Lessons}

String : getInstruction( String type, ByteArray query, String info, String tag=“”, Boolean locateOnly=false )

Return Value:

  • A string representation of an instruction.

See Also:

  • JSON::parse()
  • dzscript{api_reference/samples/education/interactive_lessons/start, Interactive Lessons}

String : getInstruction( String type, String query, String info, String tag=“”, Boolean locateOnly=false )

Return Value:

  • A string representation of an instruction if the type is valid, otherwise an empty string.

See Also:

  • JSON::parse()
  • dzscript{api_reference/samples/education/interactive_lessons/start, Interactive Lessons}

String : getInstruction( String type, Boolean query, String info, String tag=“”, Boolean locateOnly=false )

Return Value:

  • A string representation of an instruction.

See Also:

  • JSON::parse()
  • dzscript{api_reference/samples/education/interactive_lessons/start, Interactive Lessons}

String : getInstruction( String type, Number query, String info, String tag=“”, Boolean locateOnly=false )

Return Value:

  • A string representation of an instruction.

See Also:

  • JSON::parse()
  • dzscript{api_reference/samples/education/interactive_lessons/start, Interactive Lessons}

String : getLayoutInstruction( String layout, String info, String tag=“”, Boolean locateOnly=false )

Return Value:

  • A string representation of an “layout” type instruction.

See Also:

  • JSON::parse()
  • dzscript{api_reference/samples/education/interactive_lessons/start, Interactive Lessons}

String : getWidgetInstruction( String widgetPath, String info, String tag=“”, Boolean locateOnly=false )

Return Value:

  • A string representation of a “widget” type instruction.

See Also:

  • JSON::parse()
  • dzscript{api_reference/samples/education/interactive_lessons/start, Interactive Lessons}

Array : instructionTypes()

TODO: Add description.


Boolean : isRunning()

Return Value:

  • true if the lesson is currently running, otherwise false.

void : iterate()

TODO: Add description.


void : skip()

Skips the next instruction in the lesson.


void : stop()

Stops the lesson.

Signals


void : skipped()

Signature:“skipped()”

Emitted when an instruction in an interactive lesson has been skipped.


void : started()

Signature:“started()”

Emitted when an interactive lesson has started.


void : stepped()

Signature:“stepped()”

Emitted when an interactive lesson has stepped to the next instruction.


void : stopped( Boolean success )

Signature:“stopped(bool)”

Emitted when an interactive lesson is stopped.

Parameter(s):

  • success - Whether or not the lesson stopped because it has reached the end.