Skyline Lua API  Version 1.0 RC1
Lua Script Reference for Skyline Game Engine.
LUA_API_Events.h
Go to the documentation of this file.
1 // | _ ____ __ _
2 // | / \ _ _ _ __ __ _/ ___| ___ / _| |_
3 // | / _ \| | | | '__/ _` \___ \ / _ \| |_| __|
4 // | / ___ \ |_| | | | (_| |___) | (_) | _| |_
5 // | /_/ \_\__,_|_| \__,_|____/ \___/|_| \__|
6 // |
7 // | Aurasoft UK 2008 - 2016 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 - 2016
16 // |
17 
18 // SKYLINE LUA CLASS FOR API DOCUMENTATION
19 
328 {
329 public:
330 
331 
349  void onResize(int width, int height);
350 
375  void publicFn( int callingID, string value);
376 
377 
402  void globalFn( int callingID, string value);
403 
404 
423  void onInit(object_ID);
424 
425 
461  void onTriggerBoxExit();
462 
463 
499  void onTriggerBoxEnter();
500 
516  void onCollision_Start(int hitID);
517 
532  void onCollision_Stay(int hitID);
533 
549  void onCollision_End(int hitID);
550 
567  void onSceneCollision_Start(int hitID1, int hitID2);
568 
584  void onSceneCollision_Stay(int hitID1, int hitID2);
585 
602  void onSceneCollision_End(int hitID1, int hitID2);
603 
604 
620  void onTrigger_Enter(int hitID);
621 
637  void onTrigger_Stay(int hitID);
638 
654  void onTrigger_Leave(int hitID);
655 
656 
657  void onTimer();
658 
659  void onEnter();
660 
661  void onExit();
662 
663  void onUpdate(float timeDelta);
664 
680  void onStop();
681 
682  void onKeyDown(string key);
683 
684  void onKeyUp(string key);
685 
708  void onClick(int hitID);
709 
710  void onMouseDown(int button, int x, int y);
711 
712  void onMouseUp(int button, int x, int y);
713 
714  void onMouseMove(int x, int y);
715 
717 
718  void onEnter_GamePaused ();
719  void onExit_GamePaused ();
720  void onUpdate_GamePaused (float timeDelta);
721  void onStop_GamePaused ();
722  void onKeyDown_GamePaused (string key);
723  void onKeyUp_GamePaused (string key);
724  void onClick_GamePaused ();
725  void onMouseDown_GamePaused(int button, int x, int y);
726  void onMouseUp_GamePaused(int button, int x, int y);
727  void onMouseMove_GamePaused(int x, int y);
728 
730 
731  void onEnter_GameStart();
732  void onExit_GameStart();
733  void onUpdate_GameStart(float timeDelta);
734  void onStop_GameStart();
735  void onKeyDown_GameStart(string key);
736  void onKeyUp_GameStart(string key);
737  void onClick_GameStart();
738  void onMouseDown_GameStart(int button, int x, int y);
739  void onMouseUp_GameStart(int button, int x, int y);
740  void onMouseMove_GameStart(int x, int y);
741 
743 
744  void onEnter_GameOver();
745  void onExit_GameOver();
746  void onUpdate_GameOver(float timeDelta);
747  void onStop_GameOver();
748  void onKeyDown_GameOver (string key);
749  void onKeyUp_GameOver(string key);
750  void onClick_GameOver();
751  void onMouseDown_GameOver(int button, int x, int y);
752  void onMouseUp_GameOver(int button, int x, int y);
753  void onMouseMove_GameOver(int x, int y);
754 
756 
757  void onTriggerStart_GameWin();
758  void onTriggerEnd_GameWin();
759  void onEnter_GameWin();
760  void update_GameWin();
761  void onExit_GameWin();
762  void onStop_GameWin();
763  void onKeyDown_GameWin( string key);
764  void onKeyUp_GameWin( string key);
765  void onClick_GameWin(int objID);
766  void onMouseDown_GameWin( int button, int x, int y );
767  void onMouseUp_GameWin( int button, int x, int y );
768  void onMouseMove_GameWin( int x, int y );
769 
771 
772  void onJSButtonReleased(int button);
773  void onJSButtonReleased_GamePaused(int button);
774  void onJSButtonReleased_GameStart(int button);
775  void onJSButtonReleased_GameOver(int button);
776  void onJSButtonReleased_GameWin(int button);
777  void onJSButtonReleased_User1(int button);
778  void onJSButtonReleased_User2(int button);
779  void onJSButtonReleased_User3(int button);
780  void onJSButtonReleased_User4(int button);
781  void onJSButtonReleased_User5(int button);
782  void onJSButtonReleased_User6(int button);
783  void onJSButtonReleased_User7(int button);
784  void onJSButtonReleased_User8(int button);
785  void onJSButtonReleased_User9(int button);
786  void onJSButtonReleased_User10(int button);
787 
788  void onJSButtonPressed (int button);
789  void onJSButtonPressed_GamePaused (int button);
790  void onJSButtonPressed_GameStart (int button);
791  void onJSButtonPressed_GameOver (int button);
792  void onJSButtonPressed_GameWin (int button);
793  void onJSButtonPressed_User1 (int button);
794  void onJSButtonPressed_User2 (int button);
795  void onJSButtonPressed_User3 (int button);
796  void onJSButtonPressed_User4 (int button);
797  void onJSButtonPressed_User5 (int button);
798  void onJSButtonPressed_User6 (int button);
799  void onJSButtonPressed_User7 (int button);
800  void onJSButtonPressed_User8 (int button);
801  void onJSButtonPressed_User9 (int button);
802  void onJSButtonPressed_User10 (int button);
803 
804  void onJSPovMoved (String direction);
805  void onJSPovMoved_GamePaused(String direction);
806  void onJSPovMoved_GameStart (String direction);
807  void onJSPovMoved_GameOver (String direction);
808  void onJSPovMoved_GameWin (String direction);
809  void onJSPovMoved_User1 (String direction);
810  void onJSPovMoved_User2 (String direction);
811  void onJSPovMoved_User3 (String direction);
812  void onJSPovMoved_User4 (String direction);
813  void onJSPovMoved_User5 (String direction);
814  void onJSPovMoved_User6 (String direction);
815  void onJSPovMoved_User7 (String direction);
816  void onJSPovMoved_User8 (String direction);
817  void onJSPovMoved_User9 (String direction);
818  void onJSPovMoved_User10 (String direction);
819 
820  void onJSliderMoved (int sliderID);
821  void onJSliderMoved_GamePaused (int sliderID);
822  void onJSliderMoved_GameStart (int sliderID);
823  void onJSliderMoved_GameOver (int sliderID);
824  void onJSliderMoved_GameWin (int sliderID);
825  void onJSliderMoved_User1 (int sliderID);
826  void onJSliderMoved_User2 (int sliderID);
827  void onJSliderMoved_User3 (int sliderID);
828  void onJSliderMoved_User4 (int sliderID);
829  void onJSliderMoved_User5 (int sliderID);
830  void onJSliderMoved_User6 (int sliderID);
831  void onJSliderMoved_User7 (int sliderID);
832  void onJSliderMoved_User8 (int sliderID);
833  void onJSliderMoved_User9 (int sliderID);
834  void onJSliderMoved_User10 (int sliderID);
835 
836  void onJSAxisMoved(int axis, int value);
837  void onJSAxisMoved_GamePaused(int axis, int value);
838  void onJSAxisMoved_GameStart(int axis, int value);
839  void onJSAxisMoved_GameOver(int axis, int value);
840  void onJSAxisMoved_GameWin(int axis, int value);
841  void onJSAxisMoved_User1(int axis, int value);
842  void onJSAxisMoved_User2(int axis, int value);
843  void onJSAxisMoved_User3(int axis, int value);
844  void onJSAxisMoved_User4(int axis, int value);
845  void onJSAxisMoved_User5(int axis, int value);
846  void onJSAxisMoved_User6(int axis, int value);
847  void onJSAxisMoved_User7(int axis, int value);
848  void onJSAxisMoved_User8(int axis, int value);
849  void onJSAxisMoved_User9(int axis, int value);
850  void onJSAxisMoved_User10(int axis, int value);
851 
852 
878  void onEnter_User1() -> User10();
879  void onUpdate_User1() -> User10();
880  void onExit_User1() -> User10();
881  void onStop_User1() -> User10();
882  void onClick_User1(int ID) -> User10(int ID);
883  void onMouseDown_User1(int button, int x, int y) -> User10(int button, int x, int y);
884  void onMouseUp_User1(int button, int x, int y) -> User10(int button, int x, int y);
885  void onMouseMove_User1(int x, int y) -> User10(int x, int y);
886  void onKeyDown_User1(string key) -> User10(string key);
887  void onKeyUp_User1(string key) -> User10(string key);
888 
889 
912  void fps_Pickup(itemType,itemName,itemValue);
913 
914 
933  void fps_PlayerDamage(damageAmount, objectID);
934 
954  void fps_Shoot(contact_X,contact_Y,contact_Z);
955 
980  void fps_DamageEvent(targetID, targetName, targetHealth, scoreValue);
981 
997  void ds_nKo();
998 
1017  void ds_onDamage( health, damage );
1018 
1026  void onSensorContact_Enter(objID);
1027  void onSensorContact_Exit(objID);
1028  void onSensorContact_Stay(objID, distance);
1029  void onEditorClose();
1030  void onEditorOpen();
1031  void game_Pickup(fps_itemType, fps_itemName, val);
1032  void game_PlayerDamage(str);
1033  void game_Shoot( );
1034  void game_DamageEvent( Value,string, Value, Value);
1035  void SetDynamicProperty( eID, "Param", "Value" );
1036  void updateDefaultGUI_Screen(scene.sceneScript.scriptID);
1037 };
1038 
1039 
1040 
1041 
1042 
1043 
1044 
1045 
1046 
1047 
1048 
1049 
1050 
1051 
1052 
1053 
1054 
1055 
void onClick_User1(int ID) -> User10(int ID)
void onMouseUp_GameOver(int button, int x, int y)
void onEnter_User1() -> User10()
A set of User events ranging from User1() to User10()
void onJSButtonPressed_User3(int button)
void onJSButtonPressed_GameWin(int button)
void onTriggerEnd_GameWin()
void onMouseDown_GamePaused(int button, int x, int y)
void onJSButtonPressed(int button)
void globalFn(int callingID, string value)
This event is called is called from the sky.callGlobalFn(objID,value) and will make a call to every ...
void onKeyDown_User1(string key) -> User10(string key)
void onJSAxisMoved_User8(int axis, int value)
void onTrigger_Stay(int hitID)
PhysX Event callback called whilst the object is inside a physx trigger.
void onTriggerBoxExit()
Called after an entity collides with a trigger box and leaves again.
void onMouseDown_GameWin(int button, int x, int y)
void onJSPovMoved_GameOver(String direction)
void onKeyUp_GameOver(string key)
void onKeyDown_GamePaused(string key)
void onTriggerBoxEnter()
Called an entity collides with a trigger box.
void onResize(int width, int height)
Event gets called from either the editor or player when they are resized.
void onInit(object_ID)
Event called when you press the play button or the game initialises from the stand alone version...
void onJSButtonReleased_User1(int button)
void onJSliderMoved_User6(int sliderID)
void onJSButtonReleased_GamePaused(int button)
void onJSButtonReleased_GameStart(int button)
void onKeyDown(string key)
void onJSButtonPressed_User2(int button)
void onJSButtonPressed_GameStart(int button)
void onUpdate_GameStart(float timeDelta)
void game_PlayerDamage(str)
void onEnter_GameOver()
void updateDefaultGUI_Screen(scene.sceneScript.scriptID)
void onTriggerStart_GameWin()
void game_DamageEvent(Value, string, Value, Value)
void onJSliderMoved_GameStart(int sliderID)
void onJSButtonPressed_User6(int button)
void onClick_GameStart()
void onJSAxisMoved_User4(int axis, int value)
void onSceneCollision_Start(int hitID1, int hitID2)
PhysX Scene script event callback when 2 objects make the initial collision.
void onKeyUp_GamePaused(string key)
void onJSAxisMoved(int axis, int value)
void onCollision_Start(int hitID)
PhysX Event callback when 2 objects make the initial collision.
void onTimer()
void onMouseMove_GameWin(int x, int y)
void onJSAxisMoved_User9(int axis, int value)
void onJSButtonPressed_GamePaused(int button)
void onKeyUp(string key)
void onJSButtonPressed_User4(int button)
void onJSButtonReleased(int button)
void onJSAxisMoved_GameStart(int axis, int value)
void onJSliderMoved_User10(int sliderID)
void onJSAxisMoved_User3(int axis, int value)
void onMouseUp_User1(int button, int x, int y) -> User10(int button, int x, int y)
void fps_DamageEvent(targetID, targetName, targetHealth, scoreValue)
This event is called from the FPS System to a micro script attached to the player with the FPS System...
void onKeyDown_GameOver(string key)
void onJSliderMoved_User1(int sliderID)
void onExit_GamePaused()
void onSceneCollision_Stay(int hitID1, int hitID2)
PhysX Scene script event continiously called callback when 2 objects are overlapping.
void onSensorContact_Stay(objID, distance)
void game_Pickup(fps_itemType, fps_itemName, val)
void onJSButtonReleased_User7(int button)
void onJSPovMoved(String direction)
void onUpdate_GamePaused(float timeDelta)
void onJSButtonReleased_User4(int button)
void onJSAxisMoved_User10(int axis, int value)
void onJSButtonPressed_User9(int button)
void publicFn(int callingID, string value)
This scripts function event is called from another script to trigger local functions and pass data be...
void onClick_GamePaused()
void onExit_GameOver()
void onTrigger_Leave(int hitID)
PhysX Event callback called on leaving contact with a physx trigger.
void onSceneCollision_End(int hitID1, int hitID2)
PhysX Scene script event callback when the obejcts move appart and stop colliding.
void onJSliderMoved(int sliderID)
void onMouseMove_GameOver(int x, int y)
void onMouseUp_GameStart(int button, int x, int y)
void onJSAxisMoved_GameWin(int axis, int value)
void onExit_GameStart()
void onJSPovMoved_User10(String direction)
void onJSliderMoved_User5(int sliderID)
void onJSButtonPressed_GameOver(int button)
void fps_Pickup(itemType, itemName, itemValue)
This event is called from the FPS System to a micro script attached to the player with the FPS System...
void onStop_GameWin()
void onMouseMove_GameStart(int x, int y)
void onJSliderMoved_User7(int sliderID)
void onJSPovMoved_GameStart(String direction)
void onStop_GameStart()
void onKeyDown_GameWin(string key)
void onStop_User1() -> User10()
void SetDynamicProperty(eID,"Param","Value")
void onJSliderMoved_User8(int sliderID)
void onStop()
Event called when you press the Stop button and before the system goes back to editing mode...
void onStop_GamePaused()
void onClick_GameWin(int objID)
void onUpdate_GameOver(float timeDelta)
void onUpdate(float timeDelta)
void onJSPovMoved_GameWin(String direction)
void onJSAxisMoved_User7(int axis, int value)
void onJSliderMoved_GamePaused(int sliderID)
void onJSButtonReleased_User8(int button)
void onJSButtonReleased_User9(int button)
void onJSPovMoved_User6(String direction)
void onEnter_GamePaused()
void onJSButtonPressed_User7(int button)
void onStop_GameOver()
void onJSButtonReleased_GameOver(int button)
void onMouseDown_User1(int button, int x, int y) -> User10(int button, int x, int y)
void onJSPovMoved_User5(String direction)
void onJSPovMoved_User8(String direction)
void fps_Shoot(contact_X, contact_Y, contact_Z)
This event is called from the FPS System to a micro script attached to the player with the FPS System...
void ds_onDamage(health, damage)
This event is called from the Damage System to a micro script attached to the object with the Damage ...
void onEnter_GameStart()
void onJSButtonPressed_User1(int button)
void onJSliderMoved_GameOver(int sliderID)
void onKeyDown_GameStart(string key)
void onClick_GameOver()
void onEditorClose()
void fps_PlayerDamage(damageAmount, objectID)
This event is called from the FPS System to a micro script attached to the player with the FPS System...
void onEnter_GameWin()
void onExit_User1() -> User10()
void onJSPovMoved_User7(String direction)
void onMouseDown_GameOver(int button, int x, int y)
void onJSButtonReleased_GameWin(int button)
void game_Shoot()
void onClick(int hitID)
This Event is triggered if the game.clickObject() has been called. The object that has been clicked o...
void onJSPovMoved_User3(String direction)
void onMouseDown(int button, int x, int y)
void onJSAxisMoved_GamePaused(int axis, int value)
void onJSButtonReleased_User3(int button)
Definition: LUA_API_Events.h:327
void onEditorOpen()
void onKeyUp_GameWin(string key)
void onJSButtonPressed_User10(int button)
void onJSButtonPressed_User8(int button)
void onJSAxisMoved_User1(int axis, int value)
void onJSliderMoved_User9(int sliderID)
void onJSPovMoved_User1(String direction)
void onJSButtonReleased_User10(int button)
void onJSAxisMoved_User5(int axis, int value)
void onMouseMove_GamePaused(int x, int y)
void onJSAxisMoved_User2(int axis, int value)
void onMouseUp_GameWin(int button, int x, int y)
void onKeyUp_GameStart(string key)
void onUpdate_User1() -> User10()
void onJSAxisMoved_User6(int axis, int value)
void onJSliderMoved_GameWin(int sliderID)
void onJSButtonReleased_User2(int button)
void _________________________________()
void onJSPovMoved_User9(String direction)
void update_GameWin()
void onTrigger_Enter(int hitID)
PhysX Event callback called when the object enters a physx trigger.
Definition: LUA_API_Scene.h:26
void onMouseUp(int button, int x, int y)
void onMouseMove(int x, int y)
void onSensorContact_Enter(objID)
This event is called from the Damage System to a micro script attached to the object with the Damage ...
void onJSliderMoved_User4(int sliderID)
void onJSButtonReleased_User6(int button)
void onMouseMove_User1(int x, int y) -> User10(int x, int y)
void onJSButtonReleased_User5(int button)
void onJSPovMoved_User2(String direction)
void onSensorContact_Exit(objID)
void onJSPovMoved_GamePaused(String direction)
void onCollision_End(int hitID)
PhysX Event callback when the obejcts move appart and stop colliding.
void onJSliderMoved_User3(int sliderID)
void onCollision_Stay(int hitID)
PhysX Event continiously called callback when 2 objects are overlapping.
void onEnter()
void onJSliderMoved_User2(int sliderID)
void onJSAxisMoved_GameOver(int axis, int value)
void onJSButtonPressed_User5(int button)
void onExit_GameWin()
void onMouseDown_GameStart(int button, int x, int y)
void onMouseUp_GamePaused(int button, int x, int y)
void ds_nKo()
This event is called from the Damage System to a micro script attached to the object with the Damage ...
void onJSPovMoved_User4(String direction)
void onKeyUp_User1(string key) -> User10(string key)