Add Script Variable

Table of Contents

• Usage
• Classes
• Plugin Entry Points

The Add Script Variable example demonstrates the following:

• How to build a plugin module for the VR-Forces 3D Gui
• How to add a new scripted variable type to the script system
• How to reference this variable in a scripted task

The Add Script Variable example shows how to add a new scripted task or set variable to the script system, in this case an integer list of values. It will show how to add the gui componenet as well as the component to transfer the data to/from reader/writer variables (which the foundation of getting this information into lua scripts).

Usage

Since this example is loaded as a plugin, it will need to be enabled in the Launcher. In the Launcher, click the Plug-ins button to bring up the Plug-ins Selection dialog. Enable the plugin. Then launch VR-Forces.

Classes

DtScriptedTaskRwIntegerListVariableConverter

The variable converter that converts to/from scripted task variable.

---

Plugin Entry Points

/*******************************************************************************
** Copyright (c) 2010 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/

#include "vrfcgf/vrfPluginExtension.h"
#include <vrfutil/scriptedTaskVariable.h>
#include "integerListConverter.h"

extern "C" {
   DT_VRF_DLL_PLUGIN void DtPluginInformation(DtVrfPluginInformation& info)
   {
      info.pluginName = "Add Script Variable Sim";
      info.pluginDescription = "Back-end plugin addition to add new integer list script variable";
      info.pluginVersion = "1.00";
      info.pluginCreator = "MAK Technologies";
      info.pluginCreatorEmail = "sales@mak.com";
      info.pluginContactWebPage = "www.mak.com";
      info.pluginContactMailingAddress = "150 Cambridge Park Drive 3rd Floor - Cambridge, MA 02140 USA";
      info.pluginContactPhone = "(617) 876 8085";
   }

   DT_VRF_DLL_PLUGIN bool DtInitializeVrfPlugin(DtCgf* cgf)
   {
      DtScriptedTaskVariable::addConverter(DtScriptedTaskIntegerListVariable, new DtScriptedTaskRwIntegerListVariableConverter);

      return true;
   }
}