C# Class ACR_CollectionLib.ACR_CollectionLib

Inheritance: CLRScriptFramework.CLRScriptBase, ICLRScriptImplementation

Afficher le fichier Open project: ALandFarAway/ALFA-Base-Resources Class Usage Examples

Méthodes publiques

Свойство	Type	Description
ScriptParameterTypes	System.Type[]
m_FloatList	List>.Dictionary
m_StringList	List>.Dictionary

Méthodes publiques

Méthode	Description
ACR_CollectionLib ( [ Intrinsics, [ Host ) : System
CloneScriptProgram ( ) : IGeneratedScriptProgram	This routine is invoked when the script context is being cloned for the creation of a script situation. Its purpose is to create a new SampleManagedNWScript object and transfer any state desired to the new script object.
ExecuteScript ( [ ObjectSelf, [ ScriptParameters, [ DefaultReturnCode ) : Int32	This routine is the main entry point symbol for the script. It is invoked when the packaged script is executed.
ExecuteScriptSituation ( [ ScriptSituationId, [ Locals, [ ObjectSelf ) : void	This routine is invoked when a script situation created by the script is resumed for execution (for example, a DelayCommand continuation). Its purpose is to perform the appropriate resume action for this continuation. Note that a script situation may be resumed after the original script object has been deleted, or even after the host process has been exited and restarted (in the save of a saved game that has been loaded).
LoadScriptGlobals ( [ Globals ) : void	This routine is invoked when the script context was restored from the interopability script stack for a script situation. Its purpose is to restore any 'global' (i.e. member variable) state that was passed to the initial StoreState request. The globals may only include standard NWScript types (Int32, UInt32, Single, and engine structures).
SaveScriptGlobals ( ) : object[]	This helper function saves the value of all 'globals' to an object array for use with storing a saved state (e.g. a script situation).
ScriptMain ( [ ScriptParameters, [ DefaultReturnCode ) : Int32

Private Methods

Méthode	Description
ACR_CollectionLib ( [ Other ) : System
HandleFloatList ( string sCollectionName, METHOD_CODE nMethodCode, float fParam1, int nParam1, int nParam2 ) : Int32
HandleIntList ( string sCollectionName, METHOD_CODE nMethodCode, int nParam1, int nParam2 ) : Int32
HandleStringList ( string sCollectionName, METHOD_CODE nMethodCode, string sParam1, int nParam1, int nParam2 ) : Int32
SetReturnFloat ( float fValue ) : void
SetReturnInt ( int nValue ) : void
SetReturnObject ( uint uValue ) : void
SetReturnString ( string sValue ) : void

Method Details

ACR_CollectionLib() public méthode

public ACR_CollectionLib ( [ Intrinsics, [ Host ) : System
Intrinsics	[
Host	[
Résultat	System

CloneScriptProgram() public méthode

This routine is invoked when the script context is being cloned for the creation of a script situation. Its purpose is to create a new SampleManagedNWScript object and transfer any state desired to the new script object.

public CloneScriptProgram ( ) : IGeneratedScriptProgram
Résultat	IGeneratedScriptProgram

ExecuteScript() public méthode

This routine is the main entry point symbol for the script. It is invoked when the packaged script is executed.

public ExecuteScript ( [ ObjectSelf, [ ScriptParameters, [ DefaultReturnCode ) : Int32
ObjectSelf	[	Supplies the "OBJECT_SELF" object id of /// the object that the script is being executed over. This may be the /// invalid object id (Script.OBJECT_INVALID) if no object is /// associated with the execute script request.
ScriptParameters	[	Supplies the parameter values for /// the script. If the type deriving from IGeneratedScriptProgram /// declares a ScriptParameterTypes public field, then parameters may /// be passed in via this array (in which case the parameter types /// have already been converted and validated). Otherwise, no /// arguments are provided.
DefaultReturnCode	[	Supplies the requested default /// return code to use if the script is a "main"-style script that /// would not conventionally return a value.
Résultat	System.Int32

ExecuteScriptSituation() public méthode

This routine is invoked when a script situation created by the script is resumed for execution (for example, a DelayCommand continuation). Its purpose is to perform the appropriate resume action for this continuation. Note that a script situation may be resumed after the original script object has been deleted, or even after the host process has been exited and restarted (in the save of a saved game that has been loaded).

public ExecuteScriptSituation ( [ ScriptSituationId, [ Locals, [ ObjectSelf ) : void
ScriptSituationId	[	Supplies the ScriptSituationId that /// was provided to the initial StoreState request, which is intended /// to uniquely identify the site within which the script situation was /// created.
Locals	[	Supplies an array of local variables that were /// provided to the initial StoreState request. The locals may only /// include standard NWScript types (Int32, UInt32, Single, and engine /// structures).
ObjectSelf	[	Supplies the "OBJECT_SELF" object id of /// the object that the script is being executed over. This may be the /// invalid object id (Script.OBJECT_INVALID) if no object is /// associated with the execute script request.
Résultat	void

LoadScriptGlobals() public méthode

This routine is invoked when the script context was restored from the interopability script stack for a script situation. Its purpose is to restore any 'global' (i.e. member variable) state that was passed to the initial StoreState request. The globals may only include standard NWScript types (Int32, UInt32, Single, and engine structures).

public LoadScriptGlobals ( [ Globals ) : void
Globals	[	Supplies an array of global variables that /// were provided to the initial StoreState request.
Résultat	void

SaveScriptGlobals() public méthode

This helper function saves the value of all 'globals' to an object array for use with storing a saved state (e.g. a script situation).

public SaveScriptGlobals ( ) : object[]
Résultat	object[]

ScriptMain() public méthode

public ScriptMain ( [ ScriptParameters, [ DefaultReturnCode ) : Int32
ScriptParameters	[
DefaultReturnCode	[
Résultat	System.Int32

Property Details

ScriptParameterTypes public_oe static_oe property

public static Type[],System ScriptParameterTypes
Résultat	System.Type[]

m_FloatList public_oe static_oe property

public static Dictionary> m_FloatList
Résultat	List>.Dictionary

m_StringList public_oe static_oe property

public static Dictionary> m_StringList
Résultat	List>.Dictionary