DART_Wizardry::Wizard_of_Oz Class Reference

Allows control of a DART application that has a "Puppet of Oz" behavior running. More...

List of all members.

Public Member Functions
	getPropertyDescriptionList ()
	wooAddCueButtonWizard (me, caller)
	This gets called by CueButtonWizards to tell the wizard that they are interested in receiving information about changes in the button list.
	wooDelCueButtonWizard (me, caller)
	Don't forget to unsubscribe.
	beginSprite (me)
	endSprite (me)
	subscribeValue (me, pValue, caller)
	Adds a new variable to the list of variables that are exported to the client to be executed there.
	unsubscribeValue (me, pValue, caller)
	updateString (me, stringID, newValue)
	This is the callback where incoming data is send to It handles both the cue list and the value evaluation.
Public Attributes
	allCueNamesID
	test
	cueTriggerID
	test this
	currentWizardInstance
	We set the instance of the Wizard to this global variable so that other scripts can use it.
Private Attributes
	pServerAddress
	comment here
	cueButtonSubscriberList
	List of all the cue button wizards that are interested to be informed when the list of cues to be displayed changes.
	valueSubscriptionList
	List of all the values that should be send to the puppet for evaluation there.
	valueSubscribers
	The list of subscribers to these values (used for sending notifications on change).
	valueSubscribeID
	The id of the shared string used for passing information to the puppet.
	valueReportID
	The id of the shared string used for getting information from the puppet.

---

Detailed Description

Allows control of a DART application that has a "Puppet of Oz" behavior running.

Attaching the wizard behavior to a sprite on the score will turn the application into a Wizard that allows you to control and monitor applications that have the puppet behavior attached.

In most cases you will not want to use these capabilities directly but rather use the derived behaviors (WizardButton, WizardLingo, etc...) but feel free to write your own behaviors that make usage of the value evaluation and message- passing capabilities of the Wizard/Puppet interface.

Properties:

• pServerAddress -- This should be the IP address of the machine where the Puppet application is running.

Place this behavior on the server machine (gives commands) on a Wizardry container sprite

Copyright 2004, Georgia Tech Research Corporation, Atlanta, Georgia 30332-0415 --All Rights Reserved-- (See LICENSE cast member for full license information)

---

Member Function Documentation

DART_Wizardry::Wizard_of_Oz::beginSprite (  me   )

DART_Wizardry::Wizard_of_Oz::endSprite (  me   )

DART_Wizardry::Wizard_of_Oz::getPropertyDescriptionList (   )

DART_Wizardry::Wizard_of_Oz::subscribeValue (  me  , pValue  , caller  )

Adds a new variable to the list of variables that are exported to the client to be executed there. The result of the evaluation is reported back to the caller Parameters: pValue  The string expression that should be evaluated on the client caller  The scriptInstance that wants to be informed whenever the result of the evaluation changes.

DART_Wizardry::Wizard_of_Oz::unsubscribeValue (  me  , pValue  , caller  )

DART_Wizardry::Wizard_of_Oz::updateString (  me  , stringID  , newValue  )

This is the callback where incoming data is send to It handles both the cue list and the value evaluation. Parameters: stringID  The ID of the string that has changed. newValue  The new value of the string. =)

DART_Wizardry::Wizard_of_Oz::wooAddCueButtonWizard (  me  , caller  )

This gets called by CueButtonWizards to tell the wizard that they are interested in receiving information about changes in the button list. Parameters: caller  The instance of the script that made the call and wants to be notified.

DART_Wizardry::Wizard_of_Oz::wooDelCueButtonWizard (  me  , caller  )

Don't forget to unsubscribe. Parameters: caller  The instance of the script that wants to be removed from the list.

---

Member Data Documentation

DART_Wizardry::Wizard_of_Oz::allCueNamesID

test

DART_Wizardry::Wizard_of_Oz::cueButtonSubscriberList [private]

List of all the cue button wizards that are interested to be informed when the list of cues to be displayed changes.

DART_Wizardry::Wizard_of_Oz::cueTriggerID

test this

DART_Wizardry::Wizard_of_Oz::currentWizardInstance

We set the instance of the Wizard to this global variable so that other scripts can use it.

DART_Wizardry::Wizard_of_Oz::pServerAddress [private]

comment here

DART_Wizardry::Wizard_of_Oz::valueReportID [private]

The id of the shared string used for getting information from the puppet.

DART_Wizardry::Wizard_of_Oz::valueSubscribeID [private]

The id of the shared string used for passing information to the puppet.

DART_Wizardry::Wizard_of_Oz::valueSubscribers [private]

The list of subscribers to these values (used for sending notifications on change).

DART_Wizardry::Wizard_of_Oz::valueSubscriptionList [private]

List of all the values that should be send to the puppet for evaluation there.

---