DART_Core::ActorParent Class Reference

This parent script is supposed to be the base of all actors It provides primary cue handling, isOkToAttach and a little bit of getPropertyDescriptionList. More...

List of all members.

Public Member Functions
	isOKToAttach (me, aSpriteType, aSpriteNum)
	GetActorHandle (me)
	getPropertyDescriptionList (aScript)
	beginSprite (me)
	enterFrame (me)
	endSprite (me)
	StartActor (me, mycastmember)
	StopActor (me)
	DeleteActor (me)
	PauseActor (me)
	UnPauseActor (me)
	MuteSound (me)
	UnMuteSound (me)
	IncrementVolumeLevel (me, incamount)
	DecrementVolumeLevel (me, incamount)
	GetCurrentSoundLevel (me)
	SetVolumeLevel (me, volumelevel)
	initCues (me)
	Initializes the cue subsystem of the actor by setting all lists to empty.
	addCue (me, cueType, cueName, caller, param)
	Called by a cue to be added to the list of cues to fire.
	delCue (me, cueType, caller)
	Remove the cue associated with this caller.
	processCue (me, cueType, param)
	This function should be called from all actors when they want to signal that the given event has occured.
	DeleteCue (me, cueName)
	DeleteAllCues (me)
Public Attributes
	ActorNames
	list of actor names
Private Attributes
	IsCamera
	FALSE in the case of actors.

---

Detailed Description

This parent script is supposed to be the base of all actors It provides primary cue handling, isOkToAttach and a little bit of getPropertyDescriptionList.

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_Core::ActorParent::addCue (  me  , cueType  , cueName  , caller  , param  )

Called by a cue to be added to the list of cues to fire. Parameters: cueType  On of (#StartCue, #StopCue, #PauseCue, #UnpauseCue, #DeleteActorCue, #TimeCue, #FrameCue) cueName  The name of the cue that should be fired on the event. caller  The reference to the calling cue. Needed for unsubscription later on param  Only used by Time and Frame Cues to indicate when and which frame should trigger the cue

DART_Core::ActorParent::beginSprite (  me   )

DART_Core::ActorParent::DecrementVolumeLevel (  me  , incamount  )

DART_Core::ActorParent::delCue (  me  , cueType  , caller  )

Remove the cue associated with this caller. Parameters: cueType  On of (#StartCue, #StopCue, #PauseCue, #UnpauseCue, #DeleteActorCue, #TimeCue, #FrameCue) caller  The reference to the cue that added something using addCue

DART_Core::ActorParent::DeleteActor (  me   )

DART_Core::ActorParent::DeleteAllCues (  me   )

DART_Core::ActorParent::DeleteCue (  me  , cueName  )

DART_Core::ActorParent::endSprite (  me   )

DART_Core::ActorParent::enterFrame (  me   )

DART_Core::ActorParent::GetActorHandle (  me   )

DART_Core::ActorParent::GetCurrentSoundLevel (  me   )

DART_Core::ActorParent::getPropertyDescriptionList (  aScript   )

DART_Core::ActorParent::IncrementVolumeLevel (  me  , incamount  )

DART_Core::ActorParent::initCues (  me   )

Initializes the cue subsystem of the actor by setting all lists to empty. Todo: Do we need the DoneCue? Changed.

DART_Core::ActorParent::isOKToAttach (  me  , aSpriteType  , aSpriteNum  )

DART_Core::ActorParent::MuteSound (  me   )

DART_Core::ActorParent::PauseActor (  me   )

DART_Core::ActorParent::processCue (  me  , cueType  , param  )

This function should be called from all actors when they want to signal that the given event has occured. Parameters: cueType  The type of event and therefore type of cue that happened param  An optional parameter (the time or frame that was reached) for the event that occured.

DART_Core::ActorParent::SetVolumeLevel (  me  , volumelevel  )

DART_Core::ActorParent::StartActor (  me  , mycastmember  )

DART_Core::ActorParent::StopActor (  me   )

DART_Core::ActorParent::UnMuteSound (  me   )

DART_Core::ActorParent::UnPauseActor (  me   )

---

Member Data Documentation

DART_Core::ActorParent::ActorNames

list of actor names

DART_Core::ActorParent::IsCamera [private]

FALSE in the case of actors.

---