the Forge

User Tools

Site Tools

Trace:
scripting:baseworld

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
scripting:baseworld [2022/08/09 22:44] – [RemoveDecal(Decal decal);] jerryhopperscripting:baseworld [2022/08/09 22:53] (current) – [TraceMove()] jerryhopper
Line 21: Line 21:
  
  
 +---
  
  
Line 133: Line 134:
  
  
-==== QueryEntitiesByOBB(vector mins, vector maxs, vector matrix[4], QueryEntitiesCallback addEntity, QueryEntitiesCallback filterEntity = null, EQueryEntitiesFlags queryFlags = EQueryEntitiesFlags.ALL); ==== +==== QueryEntitiesByOBB() ==== 
-/*!+ 
 +  QueryEntitiesByOBB(vector mins, vector maxs, vector matrix[4], QueryEntitiesCallback addEntity, QueryEntitiesCallback filterEntity = null, EQueryEntitiesFlags queryFlags = EQueryEntitiesFlags.ALL); 
 +  
 Query for entities touched by oriented box Query for entities touched by oriented box
 \param mins \param mins
Line 151: Line 154:
 \return \return
 False when query was canceled. False when query was canceled.
-*/+
  
 Return type: [[scripting:datatypes#bool]] Return type: [[scripting:datatypes#bool]]
  
  
-==== SchedulePreload(vector pos, float radius); ====+==== SchedulePreload() ====
  
 +  SchedulePreload(vector pos, float radius);
 +  
 Return type: [[scripting:datatypes#void]] Return type: [[scripting:datatypes#void]]
  
-==== GetBoundBox(out vector mins, out vector maxs); ====+==== GetBoundBox() ====
  
 +  GetBoundBox(out vector mins, out vector maxs);
 +  
 Return type: [[scripting:datatypes#void]] Return type: [[scripting:datatypes#void]]
  
  
-==== GetOceanHeight(float worldX, float worldZ); ==== +==== GetOceanHeight() ==== 
-/*!+ 
 +  GetOceanHeight(float worldX, float worldZ); 
 Is ocean availabled Is ocean availabled
-*/+
 Return type: [[scripting:datatypes#float]]  Return type: [[scripting:datatypes#float]] 
  
-==== IsOcean(); ==== +==== IsOcean() ==== 
-/*!+ 
 +  IsOcean(); 
 +   
 Get water ocean height at given point Get water ocean height at given point
 \param worldXworld x position \param worldXworld x position
 \param worldZworld z position \param worldZworld z position
-*/+
  
 Return type: [[scripting:datatypes#float]] Return type: [[scripting:datatypes#float]]
  
-==== GetOceanHeightAndDisplace(float worldX, float worldZ); ==== +==== GetOceanHeightAndDisplace() ==== 
-/*!+ 
 +  GetOceanHeightAndDisplace(float worldX, float worldZ); 
 +  
 Get water ocean height and displacement at given point, returns vector(displaceX, height, displaceZ) Get water ocean height and displacement at given point, returns vector(displaceX, height, displaceZ)
 \param worldXworld x position \param worldXworld x position
 \param worldZworld z position \param worldZworld z position
-*/+
  
 Return type: [[scripting:datatypes#vector]] Return type: [[scripting:datatypes#vector]]
  
  
-==== GetOceanBaseHeight(); ==== +==== GetOceanBaseHeight() ==== 
-/*!+ 
 +  GetOceanBaseHeight(); 
 return base ocean level return base ocean level
-*/+
  
 Return type: [[scripting:datatypes#float]]  Return type: [[scripting:datatypes#float]] 
  
-==== IsOceanEnabledInCamera(int camera); ==== +==== IsOceanEnabledInCamera() ==== 
-/*!+ 
 +  IsOceanEnabledInCamera(int camera); 
 is in camera ocean enabled? is in camera ocean enabled?
 \param cameracamera \param cameracamera
-*/+
  
 Return type: [[scripting:datatypes#bool]] Return type: [[scripting:datatypes#bool]]
  
  
-==== EnabledOceanInCamera(int camera, bool enable); ==== +==== EnabledOceanInCamera() ==== 
-/*!+ 
 +  EnabledOceanInCamera(int camera, bool enable); 
 enable ocean render in some camera enable ocean render in some camera
 \param cameracamera \param cameracamera
 \param enableenabled = true \param enableenabled = true
-*/+
  
 Return type: [[scripting:datatypes#void]] Return type: [[scripting:datatypes#void]]
  
-==== RegisterWaterBody(notnull IEntity ent, ResourceName matName); ==== +==== RegisterWaterBody() ==== 
-/*+ 
 +  RegisterWaterBody(notnull IEntity ent, ResourceName matName); 
 water body water body
-*/+
  
 Return type: [[scripting:datatypes#float]]  Return type: [[scripting:datatypes#float]] 
  
-==== RemoveWaterBody(notnull IEntity ent); ==== +==== RemoveWaterBody() ==== 
-/*+ 
 +  RemoveWaterBody(notnull IEntity ent); 
 remove water body remove water body
-*/+
  
 Return type: [[scripting:datatypes#void]] Return type: [[scripting:datatypes#void]]
Line 259: Line 283:
 Return type: [[scripting:datatypes#TrackDecal]]  Return type: [[scripting:datatypes#TrackDecal]] 
  
-==== GetCurrentCameraId(); ====+==== GetCurrentCameraId() ==== 
 + 
 +  GetCurrentCameraId(); 
  
 Return type: [[scripting:datatypes#int]] Return type: [[scripting:datatypes#int]]
Line 413: Line 439:
      
 traces shape collision at start position, return <0 if we hit something traces shape collision at start position, return <0 if we hit something
-//OUTPUT: + 
-\returnsvalue 0 or negative number as penetration depth+OUTPUT: 
 +returnsvalue 0 or negative number as penetration depth
  
  
Line 424: Line 451:
   TraceMove(inout TraceParam param, TraceEntitiesCallback filtercallback);   TraceMove(inout TraceParam param, TraceEntitiesCallback filtercallback);
  
-/*!+
 traces shape movement along start->end, return 0..1 if trace was sucessfull. traces shape movement along start->end, return 0..1 if trace was sucessfull.
-//OUTPUT:+ 
 +OUTPUT:
 \returnsvalue 0...1, percentage of a path traveled \returnsvalue 0...1, percentage of a path traveled
-*/+
  
 Return type: [[scripting:datatypes#float]] Return type: [[scripting:datatypes#float]]
Line 437: Line 465:
   GetWorldTime();   GetWorldTime();
    
-//! Returns current lifetime of the World in milliseconds+Returns current lifetime of the World in milliseconds
  
 Return type: [[scripting:datatypes#float]] Return type: [[scripting:datatypes#float]]
Line 445: Line 473:
   GetFrameNumber();   GetFrameNumber();
      
-//! Returns current frame of the World+Returns current frame of the World
  
 Return type: [[scripting:datatypes#int]] Return type: [[scripting:datatypes#int]]
Line 453: Line 481:
   GetTimeScale();   GetTimeScale();
      
-//! Returns actual time scale of world, can be different from engine time scale+Returns actual time scale of world, can be different from engine time scale
  
 Return type: [[scripting:datatypes#float]] Return type: [[scripting:datatypes#float]]
Line 473: Line 501:
   IsEditMode();   IsEditMode();
      
-//! Returns true during edit mode in Workbench and in Ingame editor+Returns true during edit mode in Workbench and in Ingame editor
  
 Return type: [[scripting:datatypes#float]] Return type: [[scripting:datatypes#float]]
Line 481: Line 509:
   UpdateEntities();   UpdateEntities();
      
-//! Update active entities in the world, do not call from inside another world update (e.g. from IEntity::EOnXXX)+Update active entities in the world, do not call from inside another world update (e.g. from IEntity::EOnXXX)
  
 Return type: [[scripting:datatypes#void]] Return type: [[scripting:datatypes#void]]
Line 489: Line 517:
   CreateWorld(string type, string name);   CreateWorld(string type, string name);
      
-//! Create new empty BaseWorld+Create new empty BaseWorld
  
 Return type: [[scripting:datatypes#SharedItemRef ]] Return type: [[scripting:datatypes#SharedItemRef ]]
scripting/baseworld.1660081454.txt.gz · Last modified: 2022/08/09 22:44 by jerryhopper
Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki