Flowgraph Plugin - EntityScreen
Author: Kevin "Cry-Vlok" Kirst
RenEvo Sofware & Designs
http://www.renevo.com/

Version: 1.0.1.2
Date: August 27, 2008

------------------------------------------------------------------------------
- 1. About
------------------------------------------------------------------------------
This Plugin adds three (3) custom Flowgraph Nodes that will allow you to work
with the screen position of an entity. An entity's screen position is defined
as the coordinate on the screen where the entity is currently visible, where
screen coordinate (0,0) corresponds to the top-left corner of the screen.

------------------------------------------------------------------------------
- 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 Definitions
------------------------------------------------------------------------------
All of the nodes below have a common property "Area". This property can be one
of the following:

1. Middle
Use the world position that is in the center of the entity.

2. Top
Use the world position that is above the entity. On an actor, this would be
close to their head.

3. Bottom
Use the world position that is below the entity. On an actor, this would be
just below their feat.



Name:		Entity:EntityScreenPos

Purpose: 	Returns screen position of entity as it changes.

In:		entityid - (Number) ID of entity
		Area - (Number) Area to use for calculating the screen position
		Enable - (Any) Call to enable screen position output
		Disable - (Any) Call to disable screen position output

Out:		Pos - (Vec3) Entity's screen position (Z-component not used)
		Visible - (Bool) True if entity is on the screen

Remarks:	Pos and Visible will be called when either changes with respect
		to the last information sent out. A bit more expensive than
		Entity:GetEntityScreenPos, but good for getting constant updates
		without the need of a timer.



Name:		Entity:GetEntityScreenPos

Purpose: 	Gets the screen position of entity.

In:		entityid - (Number) ID of entity
		Area - (Number) Area to use for calculating the screen position
		Get - (Any) Call to get the entity's screen position

Out:		Pos - (Vec3) Entity's screen position (Z-component not used)
		Visible - (Bool) True if entity is on the screen

Remarks:	Inexpensive way to get the entity's screen position, but has a
		small delay between when Get is activated and information is
		past out through Pos and Visible.



Name:		Entity:EntityScreenText

Purpose: 	Displays text centered over entity's screen position.

In:		entityid - (Number) ID of entity
		Text - (String) Text to display
		Alpha - (Float) Alpha component of text
		Color - (Vec3) Color of text (R,G,B)
		Area - (Number) Area to use for calculating the screen position
		Get - (Any) Call to get the entity's screen position
		Enable - (Any) Call to enable drawing the text
		Disable - (Any) Call to disable drawing the text

Out:		None

Remarks:	Very useful node that will let you display colored text over
		an Entity very easily. Can be turned on/off.

------------------------------------------------------------------------------
- 4. Contact
------------------------------------------------------------------------------
Name: Kevin "Cry-Vlok" Kirst
Email: kkirst@gmail.com
