Inheritance diagram for IScriptTagCmdData:

Public Types
enum	{ kDefaultIID = IID_ISCRIPTTAGCMDDATA }

Public Member Functions
virtual void	SetScriptList (const ScriptList &scriptList, const EngineContext &context)=0

virtual void	SetTag (const IScriptLabel::ScriptLabelValue &label, const IScriptLabel::ScriptLabelKey &key=IScriptLabel::kDefaultScriptLabelKey)=0

virtual void	SetTags (const IScriptLabel::ScriptLabelKeyValueList &labels, bool16 replaceExistingLabels=kFalse)=0

virtual ErrorCode	GetScriptList (ScriptList &scriptList) const =0

virtual const RequestContext &	GetRequestContext () const =0

virtual const IScriptLabel::ScriptLabelKeyValueList &	GetTags () const =0

virtual bool16	GetReplaceExistingLabels () const =0

Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0

virtual void	AddRef () const =0

virtual void	Release () const =0

Detailed Description

An interface used by the kSetScriptingTagCmdBoss. Use IScriptUtils::SetScriptingTag() or IScriptUtils::SetScriptingTags() to access this command. This interface is included in the SDK for reference purposes only and plug-in developers should not invoke any of the "Set" APIs in this interface.

Member Function Documentation

virtual bool16 IScriptTagCmdData::GetReplaceExistingLabels ( ) const

pure virtual

Return whether to replace existing labels

virtual const RequestContext& IScriptTagCmdData::GetRequestContext ( ) const

pure virtual

Return the request context

virtual ErrorCode IScriptTagCmdData::GetScriptList ( ScriptList & scriptList ) const

pure virtual

Return the script list

virtual const IScriptLabel::ScriptLabelKeyValueList& IScriptTagCmdData::GetTags ( ) const

pure virtual

Return the label

virtual void IScriptTagCmdData::SetScriptList	(	const ScriptList &	scriptList,
		const EngineContext &	context
	)

pure virtual

Set the target object(s) and context

virtual void IScriptTagCmdData::SetTag	(	const IScriptLabel::ScriptLabelValue &	label,
		const IScriptLabel::ScriptLabelKey &	key = `IScriptLabel::kDefaultScriptLabelKey`
	)

pure virtual

Set a label

virtual void IScriptTagCmdData::SetTags	(	const IScriptLabel::ScriptLabelKeyValueList &	labels,
		bool16	replaceExistingLabels = `kFalse`
	)

pure virtual

Set multiple labels

Parameters

replaceExistingLabels if kTrue instructs command to replace any and all existing labels with the newly supplied ones