OfficePlugin¶

IMML example¶

<Plugin Name="OfficePlugin" Enabled="True" Source="http://id.vastpark.com/VastParkWS/get.vpws?publisher=acascone&name=OfficePlugin&domain=vastpark&context=Park" />

Properties¶

string NetworkMode¶

• Summary: This will let you know what Network Mode the plugin is on. The modes are: RequestEverything, GrabOutputFiles, GrabAllFiles and FullyAutomatic. Fully Automatic is the default and InitiateConnection().

int SendingSize¶

• Summary: This is how many Kb it will split files while sending them. It is configurable between and including 1 - 100 Kb.

long BytesSent¶

• Summary: How many bytes this office plugin sent through the network.

long BytesReceived¶

• Summary: How many bytes this office plugin received through the network.

string FileNotificationScript¶

• Summary: It will trigger when server plugin notifies it of a new file. This will return a string in args.data about the Id of the file.

string StartOfFileReceivingScript¶

• Summary: This will trigger every time the office plugin has requested to receive a file. This will give a IFileTransferManager object in args.data.

string ReceiveScript¶

• Summary: The name of the script that is to be triggered when an office item is added to the server plugin. To set it to trigger a script, pass the name of the script, and it'll try to grab the script. Once triggered it will send the plugin in sender and the office item in args.data.

string RemoveScript¶

• Summary: The name of the script that is to be triggered when an office item is removed from the server plugin. To set it to trigger a script, pass the name of the script, and it'll try to grab the script. Once triggered it will send the plugin in sender and the office item in args.data. If the script is not set, it will automaticaly completely remove it.

string EditingScript¶

• Summary: This script will get triggered when the OfficePlugin detects a change in an OfficeItem. This will give the OfficeItem that has changed.

string ChangeScript¶

• Summary: The name of the script that is to be triggered when an office item is changed in the server plugin. To set it to trigger a script, pass the name of the script, and it'll try to grab the script. Once triggered it will send the plugin in sender and the office item in args.data.

string EarlyOutputScript¶

• Summary: This will trigger when an output message has arrived but the file is not yet fully downloaded. This will give an OutputDetailsMessage object in args.data.

string OutputScript¶

• Summary: This will trigger when an output message has arrived and the file is fully downloaded. This will give an OutputDetailsMessage object in args.data.

string RemoveOutputScript¶

• Summary: This will trigger when an output remove is sent through the network. The will give a string in args.data of the name of the element.

string FailureScript¶

• Summary: This will trigger when an OfficeItem document has failed in some way. It will give a string of the OfficeItem Id in args.data.

bool Enabled¶

• Summary: The general property of the plugin to Enable the Update function to be called every frame update. This will determine if the plugin draws on the screens.

Functions¶

void Load()¶

• Summary: This will load any extra parts of the plugin. (Used by the Player to load the plugins properly)
• Parameters

void AddElement(VastPark.Data.ImmlElement element)¶

• Summary: This will add an element into the plugin. (It currently doesn't do anything.)
• Parameters
  • element: The element you wanted to add in.

void Update()¶

• Summary: Gets triggered every frame if Enable property is true. Doesn't do anything.
• Parameters

void Dispose()¶

• Summary: This is to get rid of the plugin. (Used by the Player when closing or going into another world.)
• Parameters

void SetParkEngine(IParkEngine parkEngine)¶

• Summary: (Used by the player to give the plugin the engines to use.)
• Parameters
  • parkEngine: (The access to the engines)

IOfficeItem LoadSpreadsheet(string name, Stream s)¶

• Summary: Gives the office item that was created to be used locally only. Obselete, use LoadOfficeItem instead.
• Parameters
  • name: The filename of the file.
  • s: The opened file to create the office item.
• Returns: The office item.

IOfficeItem LoadPowerPoint(string name, Stream s)¶

• Summary: Locally load PowerPoint. Obselete, use LoadOfficeItem instead.
• Parameters
  • name: The filename of the file.
  • s: The opened file to create the office item.
• Returns: The office item.

IOfficeItem LoadWord(string name, Stream s)¶

• Summary: Locally load word. Obselete, use LoadOfficeItem instead.
• Parameters
  • name: The filename of the file.
  • s: The opened file to create the office item.
• Returns: The office item.

IOfficeItem LoadOfficeItem(string name, Stream s)¶

• Summary: Gives the office item that was created to be used locally only.
• Parameters
  • name: The filename of the file.
  • s: The opened file to create the office item.
• Returns: The office item.

bool RemoveOfficeItem(string id)¶

• Summary: This is to remove an office item locally, and from the output list.
• Parameters
  • id: The id of the office item to remove.
• Returns: Returns true if it was successful.

bool RequestLoadSpreadsheet(string filename, Stream fileStream)¶

• Summary: This will make a request to the server plugin to host this file for everyone to use. Obsolete, use RequestLoadOfficeFile instead.
• Parameters
  • filename: The name of the file.
  • fileStream: The opened file to create the office item.
• Returns: Returns true if it was successful.

bool RequestLoadPowerPoint(string filename, Stream s)¶

• Summary: This will make a request to the server plugin to host this file for everyone to use. Obsolete, use RequestLoadOfficeFile instead.
• Parameters
  • filename: The name of the file.
  • fileStream: The opened file to create the office item.
• Returns: Returns true if it was successful.

bool RequestLoadWord(string filename, Stream s)¶

• Summary: This will make a request to the server plugin to host this file for everyone to use. Obsolete, use RequestLoadOfficeFile instead.
• Parameters
  • filename: The name of the file.
  • fileStream: The opened file to create the office item.
• Returns: Returns true if it was successful.

IFileTransferManager RequestLoadOfficeFile(string filename, Stream s)¶

• Summary: This will make a request to the server plugin to host this file for everyone to use.
• Parameters
  • filename: The name of the file.
  • fileStream: The opened file to create the office item.
• Returns: Returns the IFileTransfer Manager.

bool RemoveOfficeItemRequest(string id)¶

• Summary: This issue out a request to remove a file from the server plugin and no longer host it.
• Parameters
  • id: The id of the office item.
• Returns: Returns true if sending the request was successful.

IOfficeItem GetItem(string id)¶

• Summary: This get the OfficeItem that has the Id.
• Parameters
  • id: The id of the office item.
• Returns: The OfficeItem.

IOfficeItem[] GetOfficeItems()¶

• Summary: Gives the whole local list of OfficeItems that are currently running.
• Parameters
• Returns: The array of office items.

void AddOutput(VastPark.Imml.Proxy.ImmlElement elementProxy, int materialGroup, IOfficeItem officeItem)¶

• Summary: This will add a local output list to target the material group of the element wanted to be textured with this office item. If there was a previous texturing on that element, it will get rid of it and add the new output.
• Parameters
  • elementProxy: The element that is to be textured upon.
  • materialGroup: The material group to draw on inside that element.
  • officeItem: The office item that one wants to texture.

bool RemoveOutput(VastPark.Imml.Proxy.ImmlElement elementProxy)¶

• Summary: This will remove any output on this element, from any further chnages to occur.
• Parameters
  • elementProxy: The element that should no longer output.
• Returns: Returns true is an item was successfully removed from the output list.

bool RequestAddOutput(VastPark.Imml.Proxy.ImmlElement elementProxy, int materialGroup, IOfficeItem officeItem)¶

• Summary: This will tell the server to send to everyone an OutputDetailsMessage to everyone notifying them about the new output everyone should do.
• Parameters
  • elementProxy: The element that is to be textured upon.
  • materialGroup: The material group to draw on inside that element.
  • officeItem: The office item that one wants to texture.
• Returns: Returns true if it was successfully sent to the server.

bool RequestRemoveOutput(VastPark.Imml.Proxy.ImmlElement elementProxy)¶

• Summary: This will tell the server to remove the output, and send the a remove output message to everyone.
• Parameters
  • elementProxy: The element that was textured upon.
• Returns: Returns true if it was successfully sent to the server.

void ShowOfficeItem(IOfficeItem item)¶

• Summary: It will show the office item in a separate window to start editing it in any way.
• Parameters
  • item: The item that is to be opened.

void SaveOfficeItem(IOfficeItem item)¶

• Summary: It will give a save window to pop up, to then know how to save the office item into a file locally.
• Parameters
  • item: The office item that is to be saved.

bool InitiateConnection()¶

• Summary: This will initiate Connection to grab the office plugin channel. This is done automatically in FullyAutomatic network mode.
• Parameters
• Returns: Returns true if it was successful.

IFileTransferManager RequestServedFile(string id)¶

• Summary: This allows to start downloading the officeitem.
• Parameters
  • id: The id of the item.
• Returns: Returns the FileTransfer Manager.

IFileTransferManager GetFileTransferManager(string id)¶

• Summary: This will get the IFileTransgerManager that is downloading/uploading.
• Parameters
  • id: The id of the item.
• Returns: Returns the FileTransfer Manager.

bool PauseTransfer(string id)¶

• Summary: This will pause the FileTransferManager that is downloading/uploading.
• Parameters
  • id: The id of the item.
• Returns: Returns true if it was successful.

bool ResumeTransfer(string id)¶

• Summary: This will resume the FileTransferManager that is downloading/uploading.
• Parameters
  • id: The id of the item.
• Returns: Returns true if it was successful.

IOfficeItem¶

string Id¶

string OriginalFilename¶

int Width¶

int Height¶

bool Editing¶

OutputDetailsMessage¶

string FileID¶

string TargetElementName¶

int TargetMaterialGroup¶

IFileTransferManager¶

string ID¶

string Filename¶

int Timeout¶

int Size¶

int Transferred¶