C#Code
C#Code
Static Public Member Functions | Static Public Attributes | Private Member Functions | Static Private Attributes
Libraries.Script Class Reference

List of all members.

Static Public Member Functions

static void Setup (Microsoft.Xna.Framework.GameServiceContainer services)
static bool AddModelManager (string ID)
static bool RemoveModelManager (string ID)
static Libraries._3D.Obj3DPoints CreateSingleTextureQuad (string assetManagerID, string imagePath, Vector2 topLeftUV, Vector2 dimsUV, Vector2 dims)
static bool AddModel (Libraries._3D.BaseModel model, string modelManagerID)
static bool AddCamera (string camID, Vector3 cameraPos, Vector2 aspect, float nearPlaneDist, float farPlaneDist, float yaw, float pitch, float roll, float FOV)
static void Update (int timePassed)
static void Render (Microsoft.Xna.Framework.Graphics.GraphicsDevice device)
static string GetDefaultAssetManagerID ()
static string GetDefaultModelManagerID ()
static string GetDefaultCameraManagerID ()
static Libraries._3D.Camera3D GetCamera (string ID)
static AssetManager GetAssetManager (string ID)
static void Setup (Microsoft.Xna.Framework.GameServiceContainer services)
static bool AddModelManager (string ID)
static bool RemoveModelManager (string ID)
static Libraries._3D.Obj3DPoints CreateSingleTextureQuad (string assetManagerID, string imagePath, Vector2 topLeftUV, Vector2 dimsUV, Vector2 dims)
static bool AddModel (Libraries._3D.BaseModel model, string modelManagerID)
static bool AddCamera (string camID, Vector3 cameraPos, Vector2 aspect, float nearPlaneDist, float farPlaneDist, float yaw, float pitch, float roll, float FOV)
static void Update (int timePassed)
static void Render (Microsoft.Xna.Framework.Graphics.GraphicsDevice device)
static string GetDefaultAssetManagerID ()
static string GetDefaultModelManagerID ()
static string GetDefaultCameraManagerID ()
static Libraries._3D.Camera3D GetCamera (string ID)
static AssetManager GetAssetManager (string ID)
static void Setup (Microsoft.Xna.Framework.GameServiceContainer services)
static bool AddModelManager (string ID)
static bool RemoveModelManager (string ID)
static Libraries._3D.Obj3DPoints CreateSingleTextureQuad (string assetManagerID, string imagePath, Vector2 topLeftUV, Vector2 dimsUV, Vector2 dims)
static bool AddModel (Libraries._3D.BaseModel model, string modelManagerID)
static bool AddCamera (string camID, Vector3 cameraPos, Vector2 aspect, float nearPlaneDist, float farPlaneDist, float yaw, float pitch, float roll, float FOV)
static void Update (int timePassed)
static void Render (Microsoft.Xna.Framework.Graphics.GraphicsDevice device)
static string GetDefaultAssetManagerID ()
static string GetDefaultModelManagerID ()
static string GetDefaultCameraManagerID ()
static Libraries._3D.Camera3D GetCamera (string ID)
static AssetManager GetAssetManager (string ID)
static void Setup (Microsoft.Xna.Framework.GameServiceContainer services)
static bool AddModelManager (string ID)
static bool RemoveModelManager (string ID)
static Libraries._3D.Obj3DPoints CreateSingleTextureQuad (string assetManagerID, string imagePath, Vector2 topLeftUV, Vector2 dimsUV, Vector2 dims)
static bool AddModel (Libraries._3D.BaseModel model, string modelManagerID)
static bool AddCamera (string camID, Vector3 cameraPos, Vector2 aspect, float nearPlaneDist, float farPlaneDist, float yaw, float pitch, float roll, float FOV)
static void Update (int timePassed)
static void Render (Microsoft.Xna.Framework.Graphics.GraphicsDevice device)
static string GetDefaultAssetManagerID ()
static string GetDefaultModelManagerID ()
static string GetDefaultCameraManagerID ()
static Libraries._3D.Camera3D GetCamera (string ID)
static AssetManager GetAssetManager (string ID)

Static Public Attributes

static readonly string s_defaultAssetM = "default"
 Name to use for the default asset manager.

Private Member Functions

 Script ()
 Script ()
 Script ()
 Script ()

Static Private Attributes

static
ScriptingCSharp.CSharpScriptManager 
s_scriptM
 Script manager to run in scripting.
static Libraries._3D.Manager3D s_manager3D
 Stores 3D objects created in the script.
static List< AssetManagers_assetManagers
 Store the asset managers used in the script.

Detailed Description

This class is only used for having static functions to access from scripts. Put functions that scripting might need, like creating/storing 3D objects and put functions here to do so.


Constructor & Destructor Documentation

Libraries.Script.Script ( ) [private]

Default constructor. Since this is only being used to store static functions, nobody should create this object. That is why the constructor is private.

Libraries.Script.Script ( ) [private]

Default constructor. Since this is only being used to store static functions, nobody should create this object. That is why the constructor is private.

Libraries.Script.Script ( ) [private]

Default constructor. Since this is only being used to store static functions, nobody should create this object. That is why the constructor is private.

Libraries.Script.Script ( ) [private]

Default constructor. Since this is only being used to store static functions, nobody should create this object. That is why the constructor is private.


Member Function Documentation

static bool Libraries.Script.AddCamera ( string  camID,
Vector3  cameraPos,
Vector2  aspect,
float  nearPlaneDist,
float  farPlaneDist,
float  yaw,
float  pitch,
float  roll,
float  FOV 
) [static]

Add a camera with the given properties, if possible.

camID - ID that represents the camera. The ID must be unique.
cameraPos - Camera position.
aspect - Aspect ration. Something like 16/9.
nearPlaneDist, farPlaneDist - Near and far plane distances. How close is the closest the camera sees and how far away is the farthest it sees.
yaw, pitch, roll - Rotation on axis.
FOV - Field of view to use.

Return:
Value is true if the camera was added, false if not.
static bool Libraries.Script.AddCamera ( string  camID,
Vector3  cameraPos,
Vector2  aspect,
float  nearPlaneDist,
float  farPlaneDist,
float  yaw,
float  pitch,
float  roll,
float  FOV 
) [static]

Add a camera with the given properties, if possible.

camID - ID that represents the camera. The ID must be unique.
cameraPos - Camera position.
aspect - Aspect ration. Something like 16/9.
nearPlaneDist, farPlaneDist - Near and far plane distances. How close is the closest the camera sees and how far away is the farthest it sees.
yaw, pitch, roll - Rotation on axis.

Return:
Value is true if the camera was added, false if not.
static bool Libraries.Script.AddCamera ( string  camID,
Vector3  cameraPos,
Vector2  aspect,
float  nearPlaneDist,
float  farPlaneDist,
float  yaw,
float  pitch,
float  roll,
float  FOV 
) [static]

Add a camera with the given properties, if possible.

camID - ID that represents the camera. The ID must be unique.
cameraPos - Camera position.
aspect - Aspect ration. Something like 16/9.
nearPlaneDist, farPlaneDist - Near and far plane distances. How close is the closest the camera sees and how far away is the farthest it sees.
yaw, pitch, roll - Rotation on axis.
FOV - Field of view to use.

Return:
Value is true if the camera was added, false if not.
static bool Libraries.Script.AddCamera ( string  camID,
Vector3  cameraPos,
Vector2  aspect,
float  nearPlaneDist,
float  farPlaneDist,
float  yaw,
float  pitch,
float  roll,
float  FOV 
) [static]

Add a camera with the given properties, if possible.

camID - ID that represents the camera. The ID must be unique.
cameraPos - Camera position.
aspect - Aspect ration. Something like 16/9.
nearPlaneDist, farPlaneDist - Near and far plane distances. How close is the closest the camera sees and how far away is the farthest it sees.
yaw, pitch, roll - Rotation on axis.

Return:
Value is true if the camera was added, false if not.
static bool Libraries.Script.AddModel ( Libraries._3D.BaseModel  model,
string  modelManagerID 
) [static]

Store the given model, if possible.

model - Model to store.
modelManagerID - Id of the model manager to store the model in. Passing null will add it to the default.

Return:
Value is true if the model could be added, false if not.
static bool Libraries.Script.AddModel ( Libraries._3D.BaseModel  model,
string  modelManagerID 
) [static]

Store the given model, if possible.

model - Model to store.
modelManagerID - Id of the model manager to store the model in. Passing null will add it to the default.

Return:
Value is true if the model could be added, false if not.
static bool Libraries.Script.AddModel ( Libraries._3D.BaseModel  model,
string  modelManagerID 
) [static]

Store the given model, if possible.

model - Model to store.
modelManagerID - Id of the model manager to store the model in. Passing null will add it to the default.

Return:
Value is true if the model could be added, false if not.
static bool Libraries.Script.AddModel ( Libraries._3D.BaseModel  model,
string  modelManagerID 
) [static]

Store the given model, if possible.

model - Model to store.
modelManagerID - Id of the model manager to store the model in. Passing null will add it to the default.

Return:
Value is true if the model could be added, false if not.
static bool Libraries.Script.AddModelManager ( string  ID) [static]

Create and add a model manager with the given ID. If a model manager already exists with the given name, nothing happens.

ID - ID of the manager to create.

Return:
Value is true if the manager could be added, false if not.
static bool Libraries.Script.AddModelManager ( string  ID) [static]

Create and add a model manager with the given ID. If a model manager already exists with the given name, nothing happens.

ID - ID of the manager to create.

Return:
Value is true if the manager could be added, false if not.
static bool Libraries.Script.AddModelManager ( string  ID) [static]

Create and add a model manager with the given ID. If a model manager already exists with the given name, nothing happens.

ID - ID of the manager to create.

Return:
Value is true if the manager could be added, false if not.
static bool Libraries.Script.AddModelManager ( string  ID) [static]

Create and add a model manager with the given ID. If a model manager already exists with the given name, nothing happens.

ID - ID of the manager to create.

Return:
Value is true if the manager could be added, false if not.
static Libraries._3D.Obj3DPoints Libraries.Script.CreateSingleTextureQuad ( string  assetManagerID,
string  imagePath,
Vector2  topLeftUV,
Vector2  dimsUV,
Vector2  dims 
) [static]

One stop shop to create a quad model. Creates a generic model and all the properties needed for it. The type of 3D object created is a Libraries._3D.Obj3DPoints.

Return:
Value is the model if it was created, null if not.

static Libraries._3D.Obj3DPoints Libraries.Script.CreateSingleTextureQuad ( string  assetManagerID,
string  imagePath,
Vector2  topLeftUV,
Vector2  dimsUV,
Vector2  dims 
) [static]

One stop shop to create a quad model. Creates a generic model and all the properties needed for it. The type of 3D object created is a Libraries._3D.Obj3DPoints.

assetManagerID - ID of the asset manager to use.
imagePath - File path to the texture to load.
topLeftUV - Top left uv coord.
dimsUV
dims

Return:
Value is the model if it was created, null if not.
static Libraries._3D.Obj3DPoints Libraries.Script.CreateSingleTextureQuad ( string  assetManagerID,
string  imagePath,
Vector2  topLeftUV,
Vector2  dimsUV,
Vector2  dims 
) [static]

One stop shop to create a quad model. Creates a generic model and all the properties needed for it. The type of 3D object created is a Libraries._3D.Obj3DPoints.

Return:
Value is the model if it was created, null if not.

static Libraries._3D.Obj3DPoints Libraries.Script.CreateSingleTextureQuad ( string  assetManagerID,
string  imagePath,
Vector2  topLeftUV,
Vector2  dimsUV,
Vector2  dims 
) [static]

One stop shop to create a quad model. Creates a generic model and all the properties needed for it. The type of 3D object created is a Libraries._3D.Obj3DPoints.

Return:
Value is the model if it was created, null if not.

static AssetManager Libraries.Script.GetAssetManager ( string  ID) [static]

Retrives the asset manager with the given ID.

ID - ID of the manager to get. If null it means get the default asset manager.

Return:
Value the asset manager whose ID matches the given ID. Value is null if no matching ID was found.
static AssetManager Libraries.Script.GetAssetManager ( string  ID) [static]

Retrives the asset manager with the given ID.

ID - ID of the manager to get. If null it means get the default asset manager.

Return:
Value the asset manager whose ID matches the given ID. Value is null if no matching ID was found.
static AssetManager Libraries.Script.GetAssetManager ( string  ID) [static]

Retrives the asset manager with the given ID.

ID - ID of the manager to get. If null it means get the default asset manager.

Return:
Value the asset manager whose ID matches the given ID. Value is null if no matching ID was found.
static AssetManager Libraries.Script.GetAssetManager ( string  ID) [static]

Retrives the asset manager with the given ID.

ID - ID of the manager to get. If null it means get the default asset manager.

Return:
Value the asset manager whose ID matches the given ID. Value is null if no matching ID was found.
static Libraries._3D.Camera3D Libraries.Script.GetCamera ( string  ID) [static]

Retrives the camera with the given ID, if possible.

ID - ID of the camera to find. null means the default camera.

Return:
Value is true if the camera if a match was found, null if not.
static Libraries._3D.Camera3D Libraries.Script.GetCamera ( string  ID) [static]

Retrives the camera with the given ID, if possible.

ID - ID of the camera to find. null means the default camera.

Return:
Value is true if the camera if a match was found, null if not.
static Libraries._3D.Camera3D Libraries.Script.GetCamera ( string  ID) [static]

Retrives the camera with the given ID, if possible.

ID - ID of the camera to find. null means the default camera.

Return:
Value is true if the camera if a match was found, null if not.
static Libraries._3D.Camera3D Libraries.Script.GetCamera ( string  ID) [static]

Retrives the camera with the given ID, if possible.

ID - ID of the camera to find. null means the default camera.

Return:
Value is true if the camera if a match was found, null if not.
static string Libraries.Script.GetDefaultAssetManagerID ( ) [static]

Retrives the ID of the default asset manager.

Return:
Value is the ID of the default asset manager.

static string Libraries.Script.GetDefaultAssetManagerID ( ) [static]

Retrives the ID of the default asset manager.

static string Libraries.Script.GetDefaultAssetManagerID ( ) [static]

Retrives the ID of the default asset manager.

static string Libraries.Script.GetDefaultAssetManagerID ( ) [static]

Retrives the ID of the default asset manager.

static string Libraries.Script.GetDefaultCameraManagerID ( ) [static]

Retrives the ID of the default camera.

static string Libraries.Script.GetDefaultCameraManagerID ( ) [static]

Retrives the ID of the default camera.

static string Libraries.Script.GetDefaultCameraManagerID ( ) [static]

Retrives the ID of the default camera.

static string Libraries.Script.GetDefaultCameraManagerID ( ) [static]

Retrives the ID of the default camera.

Value is the ID of the default camera to use.

static string Libraries.Script.GetDefaultModelManagerID ( ) [static]

Retrives the ID of the default model manager.

static string Libraries.Script.GetDefaultModelManagerID ( ) [static]

Retrives the ID of the default model manager.

static string Libraries.Script.GetDefaultModelManagerID ( ) [static]

Retrives the ID of the default model manager.

Return:
Value is the ID of the default model manager to use.

static string Libraries.Script.GetDefaultModelManagerID ( ) [static]

Retrives the ID of the default model manager.

static bool Libraries.Script.RemoveModelManager ( string  ID) [static]

Remove a model manager with the given ID. The default model manager can't be removed.

ID - ID of the manager to remove.

Return:
Value is true if the manager could be removed, false if not.
static bool Libraries.Script.RemoveModelManager ( string  ID) [static]

Remove a model manager with the given ID. The default model manager can't be removed.

ID - ID of the manager to remove.

Return:
Value is true if the manager could be removed, false if not.
static bool Libraries.Script.RemoveModelManager ( string  ID) [static]

Remove a model manager with the given ID. The default model manager can't be removed.

ID - ID of the manager to remove.

Return:
Value is true if the manager could be removed, false if not.
static bool Libraries.Script.RemoveModelManager ( string  ID) [static]

Remove a model manager with the given ID. The default model manager can't be removed.

ID - ID of the manager to remove.

Return:
Value is true if the manager could be removed, false if not.
static void Libraries.Script.Render ( Microsoft.Xna.Framework.Graphics.GraphicsDevice  device) [static]

Render everything for scripting.

static void Libraries.Script.Render ( Microsoft.Xna.Framework.Graphics.GraphicsDevice  device) [static]

Render everything for scripting.

static void Libraries.Script.Render ( Microsoft.Xna.Framework.Graphics.GraphicsDevice  device) [static]

Render everything for scripting.

device - Device to render with.
static void Libraries.Script.Render ( Microsoft.Xna.Framework.Graphics.GraphicsDevice  device) [static]

Render everything for scripting.

static void Libraries.Script.Setup ( Microsoft.Xna.Framework.GameServiceContainer  services) [static]

Create/setup everything needed for scripting. Should only be called once.

services - Game services needed for asset manager creation.
static void Libraries.Script.Setup ( Microsoft.Xna.Framework.GameServiceContainer  services) [static]

Create/setup everything needed for scripting. Should only be called once.

services - Game services needed for asset manager creation.
static void Libraries.Script.Setup ( Microsoft.Xna.Framework.GameServiceContainer  services) [static]

Create/setup everything needed for scripting. Should only be called once.

services - Game services needed for asset manager creation.
static void Libraries.Script.Setup ( Microsoft.Xna.Framework.GameServiceContainer  services) [static]

Create/setup everything needed for scripting. Should only be called once.

services - Game services needed for asset manager creation.
static void Libraries.Script.Update ( int  timePassed) [static]

Update everything for scripting. That means scripts, 3D stuff, etc.

timePassed - How long the update is for.
static void Libraries.Script.Update ( int  timePassed) [static]

Update everything for scripting. That means scripts, 3D stuff, etc.

static void Libraries.Script.Update ( int  timePassed) [static]

Update everything for scripting. That means scripts, 3D stuff, etc.

static void Libraries.Script.Update ( int  timePassed) [static]

Update everything for scripting. That means scripts, 3D stuff, etc.


Member Data Documentation

static List< AssetManager > Libraries.Script::s_assetManagers [static, private]

Store the asset managers used in the script.

static readonly string Libraries.Script::s_defaultAssetM = "default" [static]

Name to use for the default asset manager.

static Libraries _3D Manager3D Libraries.Script::s_manager3D [static, private]

Stores 3D objects created in the script.

static ScriptingCSharp CSharpScriptManager Libraries.Script::s_scriptM [static, private]

Script manager to run in scripting.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Enumerations Properties