Skyline Lua API  Version 1.0
Lua Script Reference for Skyline Game Engine.
LUA_API_Path.h
Go to the documentation of this file.
1 // | _ ____ __ _
2 // | / \ _ _ _ __ __ _/ ___| ___ / _| |_
3 // | / _ \| | | | '__/ _` \___ \ / _ \| |_| __|
4 // | / ___ \ |_| | | | (_| |___) | (_) | _| |_
5 // | /_/ \_\__,_|_| \__,_|____/ \___/|_| \__|
6 // |
7 // | Aurasoft UK 2008 - 2018 http://www.aurasoft.co.uk
8 // |
9 // | Skyline Game Engine Lua API Documentation
10 // |
11 // | This file belongs to Aurasoft UK for the Skyline Game Engine of all versions.
12 // | This file is not for use in any other software that is not owned by Aurasoft UK and cannot be used by any other
13 // | person outside of the Skyline Game Engine development team.
14 // |
15 // | © Copyright - Aurasoft UK & Skyline Game Engine 2008 - 2018
16 // |
17 
18 
19 // SKYLINE LUA CLASS FOR API DOCUMENTATION
20 
59 class path
60 {
61 public:
62 
91  float3 getNodePosition(string pathName, int nodeIndex);
92 
118  float getNodeYaw(string pathName, int nodeIndex);
119 
141  void setNodePosition(string pathName, int nodeIndex, float posX, float posY, float posZ);
142 
160  int getNumNodes(string pathName);
161 
182  int doesPathExist(string pathName);
183 
184 
200  path.createPath(“pathName”);
201 
202 
218  path.removePath(“pathName”);
219 
220 
240  path.insertNode(“pathName”, id , x ,y, z);
241 
258  path.deleteNode(“pathName”, id );
259 
260 
279  path.insertNode(“pathName”, id, x, y, z );
280 
281 
282 
283 };
int getNumNodes(string pathName)
Gets how many nodes the path specified has. This also adds all the nodes in between the main nodes...
path deleteNode(“pathName”, id)
Remove a node into the path.
float getNodeYaw(string pathName, int nodeIndex)
Get the yaw rotation of the node index you have passed through. This is a precalculated yaw angle cre...
path insertNode(“pathName”, id, x, y, z)
Insert a node into the path.
path createPath(“pathName”)
Create a Path.
float3 getNodePosition(string pathName, int nodeIndex)
Get the position of the node index you have passed through. You can get the position of every node be...
Definition: LUA_API_Path.h:59
int doesPathExist(string pathName)
Check whether the path specified exists or not. This is a boolean function as it returns true or fals...
void setNodePosition(string pathName, int nodeIndex, float posX, float posY, float posZ)
Set the position of the node index you have passed through. This only works for the main nodes that y...
path removePath(“pathName”)
remove a Path