This reference page is linked to from the following overview topics: MAXScript Extension Plug-ins, Plug-in Base Classes.

Search for all occurrences

#include <mxsPlugin.h>

Inheritance diagram for MSPlugin:

[legend]

List of all members.

Public Member Functions
	MSPlugin ()
virtual	~MSPlugin ()
void	init (MSPluginClass *pc)
ScripterExport void	gc_trace ()
ScripterExport void	collect ()
void	DeleteThis ()
ScripterExport void	RefDeleted ()
void	init_locals ()
void	call_handler (Value handler, Value *arg_list, int count, TimeValue t, BOOL disable_on_error=FALSE)
Value *	_call_handler (Value handler, Value *arg_list, int count, TimeValue t, BOOL disable_on_error=FALSE)
FPStatus	call_handler (MCHAR handler_name, FPParams params, FPValue &result, TimeValue t, BOOL disable_on_error=FALSE)
FPStatus	call_handler (Value handler, FPParams params, FPValue &result, TimeValue t, BOOL disable_on_error=FALSE)
void	post_create (ReferenceTarget *me, BOOL loading)
void	call_all_set_handlers ()
void	disable ()
void	enable ()
BOOL	enabled ()
int	get_local_index (Value *prop)
Value *	get_local (int index)
void	set_local (int index, Value *val)
ScripterExport IParamBlock2 *	GetParamBlockByID (BlockID id)
virtual HWND	AddRollupPage (HINSTANCE hInst, MCHAR dlgTemplate, DLGPROC dlgProc, MCHAR title, LPARAM param=0, DWORD flags=0, int category=ROLLUP_CAT_STANDARD)=0
virtual void	DeleteRollupPage (HWND hRollup)=0
virtual IRollupWindow *	GetRollupWindow ()=0
ScripterExport RefResult	NotifyRefChanged (Interval changeInt, RefTargetHandle hTarget, PartID &partID, RefMessage message)
ScripterExport RefTargetHandle	clone_from (MSPlugin obj, ReferenceTarget obj_as_ref, RemapDir &remap)
void	RefAdded (RefMakerHandle rm)
void	NotifyTarget (int msg, RefMakerHandle rm)
virtual ReferenceTarget *	get_delegate ()=0
IOResult	Save (ISave *isave)
IOResult	Load (ILoad *iload)
void	post_load (ILoad *iload, int which)
void	dump_local_vars_and_externals (int indentLevel)
Public Attributes
MSPluginClass *	pc
Value **	locals
short	flags
int	version
ReferenceTarget *	ref
Tab< IParamBlock2 * >	pblocks
ILoad *	iload

Constructor & Destructor Documentation

MSPlugin ( ) [inline]

{ flags = 0; }

virtual ~MSPlugin ( ) [virtual]

Member Function Documentation

void init ( MSPluginClass * pc )

Search for all occurrences

ScripterExport void gc_trace ( ) [virtual]

Search for all occurrences

Reimplemented from Collectable.

ScripterExport void collect ( ) [virtual]

Search for all occurrences

Implements Collectable.

void DeleteThis ( )

Search for all occurrences

Reimplemented in MSCustAttrib, MSPluginObject< TYPE >, MSPluginSimpleObject, MSSimpleObjectXtnd, MSPluginSimpleManipulator, MSPluginModifier, MSModifierXtnd, MSPluginSimpleMod, MSSimpleModXtnd, MSPluginTexmap, MSTexmapXtnd, MSPluginMtl, MSMtlXtnd, MSPluginSpecialFX< TYPE >, MSPluginTrackViewUtility, MSPluginObject< ShapeObject >, MSPluginObject< HelperObject >, MSPluginObject< GeomObject >, MSPluginObject< GenCamera >, MSPluginObject< GenLight >, MSObjectXtnd< GenCamera, MSPluginCamera >, MSObjectXtnd< HelperObject, MSPluginHelper >, MSObjectXtnd< GeomObject, MSPluginGeomObject >, MSObjectXtnd< ShapeObject, MSPluginShape >, MSObjectXtnd< GenLight, MSPluginLight >, MSPluginSpecialFX< Effect8 >, MSPluginSpecialFX< Atmospheric >, MSSpecialFXXtnd< Effect, MSPluginEffect >, and MSSpecialFXXtnd< Atmospheric, MSPluginAtmos >.

ScripterExport void RefDeleted ( )

Search for all occurrences

Reimplemented in MSCustAttrib, MSPluginObject< TYPE >, MSPluginSimpleObject, MSPluginSimpleManipulator, MSPluginModifier, MSPluginSimpleMod, MSPluginTexmap, MSPluginMtl, MSPluginSpecialFX< TYPE >, MSPluginObject< ShapeObject >, MSPluginObject< HelperObject >, MSPluginObject< GeomObject >, MSPluginObject< GenCamera >, MSPluginObject< GenLight >, MSPluginSpecialFX< Effect8 >, and MSPluginSpecialFX< Atmospheric >.

void init_locals ( )

Search for all occurrences

void call_handler	(	Value *	handler,
		Value **	arg_list,
		int	count,
		TimeValue	t,
		BOOL	disable_on_error = `FALSE`
	)

Search for all occurrences

Value* _call_handler	(	Value *	handler,
		Value **	arg_list,
		int	count,
		TimeValue	t,
		BOOL	disable_on_error = `FALSE`
	)

Search for all occurrences

FPStatus call_handler	(	MCHAR *	handler_name,
		FPParams *	params,
		FPValue &	result,
		TimeValue	t,
		BOOL	disable_on_error = `FALSE`
	)

Search for all occurrences

FPStatus call_handler	(	Value *	handler,
		FPParams *	params,
		FPValue &	result,
		TimeValue	t,
		BOOL	disable_on_error = `FALSE`
	)

Search for all occurrences

void post_create	(	ReferenceTarget *	me,
		BOOL	loading
	)

Search for all occurrences

void call_all_set_handlers ( )

Search for all occurrences

void disable ( ) [inline]

Search for all occurrences

{ flags |= MSP_DISABLED; }

void enable ( ) [inline]

Search for all occurrences

{ flags &= ~MSP_DISABLED; }

BOOL enabled ( ) [inline]

Search for all occurrences

{ return !(flags & MSP_DISABLED); }

int get_local_index ( Value * prop )

Search for all occurrences

Value* get_local ( int index ) [inline]

Search for all occurrences

{ return locals[index]; }

void set_local	(	int	index,
		Value *	val
	)		`[inline]`

Search for all occurrences

{ locals[index] = heap_ptr(val); }

ScripterExport IParamBlock2* GetParamBlockByID ( BlockID id )

Search for all occurrences

Reimplemented in MSCustAttrib, MSPluginObject< TYPE >, MSPluginSimpleObject, MSSimpleObjectXtnd, MSPluginSimpleManipulator, MSSimpleManipulatorXtnd, MSPluginModifier, MSModifierXtnd, MSPluginSimpleMod, MSSimpleModXtnd, MSPluginTexmap, MSTexmapXtnd, MSPluginMtl, MSMtlXtnd, MSPluginSpecialFX< TYPE >, MSPluginTrackViewUtility, MSPluginObject< ShapeObject >, MSPluginObject< HelperObject >, MSPluginObject< GeomObject >, MSPluginObject< GenCamera >, MSPluginObject< GenLight >, MSObjectXtnd< GenCamera, MSPluginCamera >, MSObjectXtnd< HelperObject, MSPluginHelper >, MSObjectXtnd< GeomObject, MSPluginGeomObject >, MSObjectXtnd< ShapeObject, MSPluginShape >, MSObjectXtnd< GenLight, MSPluginLight >, MSPluginSpecialFX< Effect8 >, MSPluginSpecialFX< Atmospheric >, MSSpecialFXXtnd< Effect, MSPluginEffect >, and MSSpecialFXXtnd< Atmospheric, MSPluginAtmos >.

virtual HWND AddRollupPage	(	HINSTANCE	hInst,
		MCHAR *	dlgTemplate,
		DLGPROC	dlgProc,
		MCHAR *	title,
		LPARAM	param = `0`,
		DWORD	flags = `0`,
		int	category = `ROLLUP_CAT_STANDARD`
	)		`[pure virtual]`