Flowgraph Plugin - Mouse
Author: James-Ryan

Version: 1.0.1.2
Date: April, 16 2009

------------------------------------------------------------------------------
- 1. About
------------------------------------------------------------------------------
This Plugin adds a custom Flowgraph Node that will allow you to receive certain
mouse informations like X / Y cursor position and the EntityID of the entity
which is currently under your mouse cursor.

------------------------------------------------------------------------------
- 2. Usage
------------------------------------------------------------------------------
To use this Plugin you will need to have installed the Flowgraph Plugin System
into your Crysis mod folder. Extract the Plugin Dll into your FGPlugins' bin32 and bin64
folders, according to the Dll version. Note that the Plugin's installer will
correctly copy the Plugin Dll files to the right folders. Once copied, just launch
your mod in the Sandbox Editor and the included nodes will appear in the Flowgraph
Editor.

------------------------------------------------------------------------------
- 3. Node Definition
------------------------------------------------------------------------------

Name:		Input:Mouse

Purpose: 	Get certain mouse informations (Position / EntityID...).

In:			Enable - (Bool) Enables the node.
			Disable - (Bool) Disables the node.
			IgnoreLinked - (Bool) Ignore the local actor linked vehicle while casting rays
			EveryHit - (Bool) If true it will ignore the ray selection setting
			DisableMovement - (Bool) Disable Player movement while in modal mode
			EnableModalMode - (Bool) Enable Player movement while in modal mode
			DisableModalMode - (Bool) Activate/Deactivate the mouse cursor
			RaySelection - (String) What kind of entities should the raycast return
			Key - (String) Modal mode key to activate the mouse cursor
		
Out:		EntityID - (EntityID) ID of the entity currently under your mouse cursor
			LastEntityID - (EntityID) ID of the previous entity which was under your mouse cursor
			OnEnter - (Bool) True if we enter an entity shape
			OnLeave - (Bool) True if we leave an entity shape
			OnPressed - (Int) True if a mouse button is pressed
			OnReleased - (Int) True if a mouse button was released
			X - (Int) X position of the mouse cursor
			Y - (Int) Y position of the mouse cursor
			HitPos - (Vec3) hit position of the raycast in world coordinates
			HitDir - (Vec3) hit direction of the raycast
			SelectedEntityIDs - (EntityID) returns a list of EntityIDs one by one on each update
		
Remarks:	The SelectedEntityIDs output port returns a single EntityID of a internally stored list
			of selected EntityIDs. The selection supports the STRG-Left and STRG-Right keys to add
			certain entities to the internal selection list. If you release the left mouse button
			the list will be send to the output port (one by one) on each node update until the
			list is empty.

------------------------------------------------------------------------------
- 4. Contact
------------------------------------------------------------------------------
Name: James-Ryan
Email: neo-ryan@web.de
