ScriptFunctions.h

Go to the documentation of this file.

bool Bool(float f); 
bool Bool(int i); 
bool Bool(string s); 
float Float(string s);
float Float(int i); 
int Int(string s);
int Int(float f); 
string String(float f);
string String(bool b);
string String(int i);
string String(vec3 v3);
string String(vec4 v4); 
        var vec3 v;
        var string s;
        s="0.0,1.0,0.0";
        v=string2vec3(s); 
    \endcode
*/
vec3 String2Vec3(string s); 
        var vec4 v;
        var string s;
        s="0.0,1.0,10.0,5.0";
        v=string2vec4(s); 
    \endcode
*/
vec4 String2Vec4(string s); 
vec3 Vec3(float x, float y, float z); 
vec4 Vec4(float x, float y, float z, float w); 


bool GetSubWidgetFlag(string sw, string flag);
void CreateWidget(string class,string script,string params,string pos);
void CreateHUD(string script);
void CreateHUDWidget(string class,string script,string params,string pos);
void DestroySubWidget(string widget);
string GetSubWidgetParam(string widget, string param);
        ResetSubWidgetFlags("button01","w_grayed"); 
    \endcode
    
    \see GetFlag, GetSubWidgetFlag, SetSubWidgetFlags 
*/
void ResetSubWidgetFlag(string sw, string flags);
        SetSubWidgetFlags("button01","w_grayed"); 
    \endcode
    
    \see GetFlag, GetSubWidgetFlag, ResetSubWidgetFlags 
*/
void SetSubWidgetFlag(string sw, string flags);
void SetSubWidgetOpacity(string widget, float opacity);
void SetSubWidgetParam(string widget, string param, string value);
void SetSubWidgetPos(string widget, float x, float y);
void SetWidgetOpacity(float opacity);
void ShowCursor(bool show);
void ShowParentWidget(bool show);
void ShowSubWidget(string widget, bool show);
void ShowWidget(bool show);


void PhysicsCreateCharacter();
void PhysicsCreateCharacter(float slopeLimit);
void PhysicsCreateBody(string coltype, float mass, vec3 props); 
        PhysicsCreateVehicle("carBody","wheel01,wheel02","wheel03,wheel04","200,11000,5000,7,0.05,10,-95");
    \endcode
*/
void PhysicsCreateVehicle(string vehicleBody, string frontWheels, string backWheels, string props);
bool PhysicsCollisionTest(float radius, vec3 start, vec3 end);
void PhysicsVehicleControl(float steerAngle, float acc, bool handbrake);
void PhysicsApplyForce(vec3 point, vec3 dir, float len);
void PhysicsApplyForce(vec3 point, string axis, float len);
void PhysicsApplyDirForceToRagdoll(vec3 dir, float len);
void PhysicsApplyDirForceToRagdoll(string axis, float len);
void PhysicsApplyForceToNode(string node, vec3 point, vec3 dir, float len);
void PhysicsApplyForceToNode(string node, vec3 point, string axis, float len); 
void PhysicsApplyForceToObject(string obj, vec3 point, vec3 dir, float len);
void PhysicsApplyForceToObject(string obj, vec3 point, string axis, float len); 
void PhysicsApplyForceToRagdoll(vec3 point, vec3 dir, float len);
void PhysicsApplyForceToRagdoll(vec3 point, string axis, float len);
void PhysicsApplyGravity(bool apply);
bool PhysicsCharacterCollisionTest(string obj, vec3 start, vec3 end);
void PhysicsCharacterMove(vec3 dir, float disp);
void PhysicsCharacterToRagdoll();
void PhysicsCreateRagdoll();
vec3 PhysicsGetCharacterDims();
string PhysicsGetCollidedObject();
bool PhysicsGetCollideFlag();
vec3 PhysicsGetCollisionNormal();
vec3 PhysicsGetObjectPos();
float PhysicsGetVehicleRPM();
bool PhysicsNodeCollisionTest(string obj, string node, float radius, vec3 disp);
bool PhysicsObjectIsSleeping();
void PhysicsObjectSleep();
void PhysicsObjectWakeUp();
void PhysicsRagdollSleep();
void PhysicsRagdollWakeUp();
void PhysicsResetCollideFlag();
void PhysicsResetRagdollCollideFlag();
void PhysicsSetCharacterDims(vec3 dims);
void PhysicsSetCharacterGravity(float gravity);
void PhysicsSetCollideFlag();
void PhysicsSetObjectPos(vec3 pos);
void PhysicsSetRagdollCollideFlag();


float Abs(float scalar);
float Min(float a, float b);
float Max(float a, float b);
        var float num;
        num=10.0;
        num=Clamp(0.0,1.0);
        LOG("num="+string(num));

        /* RESULT */
        num=1.0 
    \endcode
    \see Abs,Min,Max
*/
float Clamp(float scalar, float min, float max);
vec3 CrossProduct(vec3 v1, vec3 v2);
float DotProduct(vec3 v1, vec3 v2);
vec3 NormalizeV(vec3 v);
float Cos(float angle);
        var float a;
        a=Rand(5000); 
    \endcode
*/
float Rand(int res);
float ScalarInterpolate(float s1, float s2, float t);
        var vec3 p0;
        var vec3 p1;
        p0=GetMousePos();
        
        p0.z=0.0; /* this point is near the screen */
        p1=p0;
        p1.z=99999.0 /* this point is very far from screen */

        /* project these two points into 3d world space */
        p0=ScreenToWorld(p0);
        p1=ScreenToWorld(p1);

        /* ray cast */
        RayPick(p0,p1-p0,1.0);

        /* Get picked object */
        var string pickObj;
        pickObj=GetPickObject(); 
    \endcode
    
    \see WorldToScreen
*/
vec3 ScreenToWorld(vec3 p);
float Sin(float angle);
vec3 VectorInterpolate(vec3 s1, vec3 s2, float t);
float VectorLen(vec3 v);
vec3 VectorRotate(vec3 v, float angle, vec3 axis);
vec3 VectorToAngles(vec3 v); /* Get Object Pippo World Pos */
        var vec3 pos;
        pos=GetObjectWorldPos("pippo");
    
        /* Compute screen pos of pippo world pos */
        var vec3 screenPos;
        screenPos=WorldToScreen(pos);

        /* Set widget pos */
        SetParam("pos",screenPos); 
    \endcode
    
    \see ScreenToWorld 
*/
vec3 WorldToScreen(vec3 p);


void CrossFadeMusic(string music, int channel);
void PlayMusic(string music, int channel);
void PlaySound(string sound, bool loop);
void PlaySoundGlobal(string sound, bool loop);
void SetSource(float gain, float range);
void SetSourcePitch(float pitch);
void SetSourceRange(float range);
void SetSourceVolume(float volume);
void StopMusic(int channel);
void StopSound();
void StopSoundGlobal();
bool IsSoundPlaying();


void AICreateCharacter(float radius, float height, string maxLinear, string maxAngular);
void AICreateObject(bool isObstacle, bool isOccluder, float radius, float height);
void AIEnableHearing(bool enable, float range);
void AIEnableVision(bool enable, string eyeNode, float range);
void FindPath(vec3 target);
vec3 AIGetFurthestCoverPoint(vec3 opponent, vec3 target, float range);
vec3 AIGetNearestAllowedPoint(vec3 target, float range);
vec3 AIGetNearestCoverPoint(vec3 opponent, vec3 target, float range);
string AIGetNearestHeardObject();
vec3 AIGetNearestTacticalCoverPoint(vec3 opponent, vec3 target, float range, int ID);
vec3 AIGetNearestTacticalPatrolPoint(vec3 target, float range, int ID);
string AIGetNearestViewedObject();
bool AIObjectIsHeard(string obj);
bool AIObjectIsViewed(string obj);
bool AIPointIsInsideWaypointArea(vec3 point);
void AISetCharacterMaxAngular(float acc, float speed);
void AISetCharacterMaxLinear(float acc, float speed);
void AISetSteeringWeight(string steer, float weight);
void AISetTargetToFacePos(vec3 target);
void AISetTargetToReachPos(vec3 target);


bool GetInputAction(string name);
float GetInputAxis(string name);
bool IsKeyPressed(string key, int mode);
vec3 GetMousePos();
vec3 GetMouseRelPos();
string GetPressedKey(int mode); 


void LOG(string str);
int GetNumVideoModes();
string GetVideoMode(int i);
void CloseLevel();
bool LoadLevel(string level);
void Exit();
void EnginePause();
void EngineResume();
string GetAudioDevice(int i);
string GetEngineParam(string param);
string GetLevelParam(string param);
int GetNumAudioDevice();
string Load(string path);
        LoadResource("Pippo/prova.tga","level");
        
        /* this is the WRONG example */
        LoadResource("Texture/Pippo/prova.tga","level");

        /* this is also WRONG */
        LoadResource("S2EngineHD/Texture/Pippo/prova.tga","level"); 
    \endcode
*/
void LoadResource(string resPath, string cache);
void RestartLevel();
void Save(string text, string path);
void SetEngineParam(string param, string value);
void SetLevelParam(string param, string value);
        SetTimeScale(2.0); 
    \endcode
*/
void SetTimeScale(float timeMul);


int AddAnimationChannel();
void AddAnimationToChannel(int channel, string animName);
void SetAnimationBlendX(int channel, string animName, float value);
void SetAnimationBlendY(int channel, string animName, float value);
void AnimationCrossFade(int channel, string animName, float time);
void AnimationChannelFadeIn(int channel, float time);
void AnimationChannelFadeOut(int channel, float time);
void BlendAnimationChannel(int channel, float weight);
void BlendCurrentAnimation(string anim, float weight, int channel);
void PauseAnimation(int channel);
        BlendCurrentAnimation("idle",1.0,0);
    
        /* Play channel 0 animations in loop, in this case only 'idle' */
        PlayAnimation(true,0); 
    \endcode
    
    \see StopAnimation, PauseAnimation, BlendCurrentAnimation
*/
void PlayAnimation(int channel, bool loop);
void SetAnimationChannelMask(int channel, string maskname);
void SetAnimationChannelSpeed(int channel, float speed);
void StopAnimation(int channel);
bool IsAnimationStopped(int channel);


void SetParam(string param, string value);
string GetParam(string param);
void ActiveObject(string objname, vec3 pos, vec3 angles);
void AttachObject(string obj, string node, vec3 pos, vec3 angles);
void SpawnObject(string prefabFilename, vec3 pos, vec3 angles);
void SetObjectFlags(string objname, string flags);
void ResetObjectFlags(string objname, string flags);
bool GetObjectFlag(string objname, string flag);
string GetObjectParam(string objname, string paramname, bool isStock);
string SetObjectParam(string objname, string paramname, string paramvalue);
string GetObjectScriptParam(string objname, string paramname, bool isStock);
vec3 GetObjectWorldPos(string objname);
vec3 GetObjectWorldAxis(string objname, string axis);
vec3 GetObjectWorldAngles(string objname);
vec3 GetWorldAxis(string axis);
vec3 GetAxis(string axis);



void SendMessageSingle(string dest, string name, string content);
void SendMessageSingle(string dest, string name, string content, float delay);
void SendMessageBroad(string dest, string name, string content);
void SendMessageBroad(string dest, string name, string content, float delay);
void SendMessageMulti(string name, string content, float range, string class);
void SendMessageMulti(string name, string content, float range, float delay);
void SendMessageGUI(string name, string content);
void SendMessageGUI(string name, string content, float delay); 
void SendMessageHUD(string name, string content);
void SendMessageHUD(string name, string content, float delay); 
bool ReceivedMessage(string msg);