AW Developer's Guide | AW Interfaces | AW Methods | AW Types and Misc API


IMoaAwSpriteCallback



Interface ID: IID_IMoaAwSpriteCallback
Pointer type: PIMoaAwSpriteCallback
Inheritance: IMoaUnknown
Header file: awiservc.h
This interface provides Authorware specific callback services for Sprite Xtras. Specifically, it provides a mechanism for Sprite Xtras to define Authorware events and to generate those events at runtime. Any Sprite Xtra that uses this interface must implement the IMoaAwEventSender interface in its Asset class. For more information on implementing authorware events, see the Authorware Developer's Guide
.

Methods

Accessing the piece

GetPiece()

Event sending

SendSpriteEvent()
SendSpriteEventWithReply()

GetPiece()

Syntax

GetPiece(PIMoaAwSpriteCallback This,
PIMoaAwPiece FAR * ppIMoaAwPiece)

Parameters

This
Pointer to the IMoaAwSpriteCallback interface

ppIMoaAwPiece
Pointer to the returned interface

Returns

MoaError

Description

Returns an interface that can be used to access the piece to which this sprite belongs.


SendSpriteEvent()

Syntax

SendSpriteEvent(PIMoaAwSpriteCallback This,
MoaMmSymbol eventName,
MoaLong nArgs,
PMoaMmValue pArgs)

Parameters

This
Pointer to the IMoaAwSpriteCallback interface

eventName
Symbol for this event; e.g., "#mouseClick"

nArgs
Number of arguments in pArgs

pArgs
Pointer to list of arguments passed with the event

Returns

kMoaErr_NoErr Function call succeeded

Description

Sends an event to Authorware without expecting a reply.


SendSpriteEventWithReply()

Syntax

SendSpriteEventWithReply(PIMoaAwSpriteCallback This,
MoaMmSymbol eventName,
MoaLong nArgs,
PMoaMmValue pArgs,
PMoaVoid replyRefcon)

Parameters

This
Pointer to the IMoaAwSpriteCallback interface

eventName
Symbol naming this event; for example, #mouseClick"

nArgs
Number of arguments in pArgs

pArgs
Pointer to list of arguments passed with the event

replyRefcon
Data passed back to HandleReply method of pSender

Returns

kMoaErr_NoErr Function call succeeded

Description

Sends an event to Authorware, expecting a reply. The reply is sent by calling the HandleReply() method of the IMoaAwEventSender interface implemented by the sender's Asset class.


Copyright © 1996-2007 Adobe Macromedia Software LLC, Inc.