C# Class ACR_Movement.ACR_Movement

Inheritance: CLRScriptFramework.CLRScriptBase, IGeneratedScriptProgram
Datei anzeigen Open project: ALandFarAway/ALFA-Base-Resources

Public Properties

Property Type Description
ScriptParameterTypes System.Type[]

Public Methods

Method Description
ACR_Movement ( [ 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

Method Description
ACR_Movement ( [ Other ) : System

Method Details

ACR_Movement() public method

public ACR_Movement ( [ Intrinsics, [ Host ) : System
Intrinsics [
Host [
return System

CloneScriptProgram() public method

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
return IGeneratedScriptProgram

ExecuteScript() public method

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.
return System.Int32

ExecuteScriptSituation() public method

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.
return void

LoadScriptGlobals() public method

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.
return void

SaveScriptGlobals() public method

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[]
return object[]

ScriptMain() public method

public ScriptMain ( [ ScriptParameters, [ DefaultReturnCode ) : Int32
ScriptParameters [
DefaultReturnCode [
return System.Int32

Property Details

ScriptParameterTypes public_oe static_oe property

public static Type[],System ScriptParameterTypes
return System.Type[]