MLStockInfo Plugin

From Cinemar Wiki
Jump to: navigation, search

About

MLStock allows you to track stocks in MainLobby by populating variables in MainLobby Server that get sent to all clients.
Note that there have been two major versions of MLStock. The below is for the most recent versions.

Latest MLStockInfo is designed to work with the later versions of MLDatabase plugin that supports graphing. MLDatabase, when properly configured keeps a history of stock prices. MLDatabase can then perform a query on this database and create a graph that can be viewed in MainLobby3 client. More installation details will be posted soon on this new capability.

Document last updated on:
Nov. 7, 2007

Software Requirements

MainLobby Server 3
MainLobby 3 Client

Installation

1. Shutdown MLServer3
2. Download the latest MLStock from MLServer3\Help\Additional Software Downloads page
The latest plugin is now in the Beta. So, install the full install from the Production category, and then install the latest plugin from the Beta category. 3. Save and run that file on the Primary MLServer3 PC.
4. Restart MLServer3

Adding a Stock

1. Right click the MLStockInfo plugin in the MLServer3 plugins list.
2. Select settings from the popup menu.
3. Click the Add button in the MLStockInfo plugin.
4. Enter the stocks symbol, description, and number of shares.
5. Click OK.

Removing a Stock

1. Right click the MLStockInfo plugin in the MLServer plugins list.
2. Select settings from the popup menu.
3. Select the stock you wish to remove form the stock list.
4. Click the remove button.

Editing a Stock

1. Right click the MLStockInfo plugin in the MLServer plugins list.
2. Select settings from the popup menu.
3. Select the stock you wish to edit from the stock list.
4. Click the Edit button.
5. Enter the stocks new symbol, description, and number of shares.
6. Click OK.

MLServeCmd

PrivacyMode

{MLServeCmd} Script Usage

MLServeCmd.MLStockInfo|PrivacyMode~State


(Literal)

MLServeCmd.MLStockInfo|PrivacyMode~On

MLServeCmd.MLStockInfo|PrivacyMode~Off

MLServeCmd.MLStockInfo|PrivacyMode~Toggle


Parameters

State = The new privacy mode state. (On,Off,Toggle)


Returns

Nothing


Description

Deletes MLStockInfo variables values when PrivacyMode is turned On.


Notes


MLServer Variables

MLStockInfo_Symbol_{{id}}

Description: The symbol of the specified stock.

Values: Any valid stock symbol.


MLStockInfo_Description_{{id}}

Description: The specified stocks description.

Values: A text value.


MLStockInfo_Price_{{id}}

Description: The current price of the specified stock.

Values: A decimal number value.


MLStockInfo_Shares_{{id}}

Description: The number of shares of the specified stock.

Values: A whole number value.


MLStockInfo_Value_{{id}}

Description: The total value of the specified stock.'

Values: A currency value.


MLStockInfo_RawValue_{{id}}

Description: The total value of the specified stock with out currency formatting.

Values: A decimal number value.


MLStockInfo_Change_{{id}}

Description: The last known change in the price of the stock.

Values: A decimal number value or N/A.


MLStockInfo_Neg_{{id}}

Description: The negative state of the stock price.

Values:

0 = the stock value either not moving or moving upward.
1 = the stock moving downward or in a negative direction.

MLStockInfo_Portfolio_Total

Description: The total value of the defined portfolio.

Values: A currency value.


MLStockInfo_PrivacyMode

Description: The current state of the privacy mode in MLStock.

Values: On,Off


MLStockInfo_LastUpdated

Description: The last date and time the stock information was updated.

Values: Date/Time ex. 11/7/2007 10:34:32 AM