Foundation - Modding Documentation

User Tools

Site Tools

Trace:
preview:api:level

Differences

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

Link to this comparison view

Next revision		Previous revision
preview:api:level [2020/01/15 17:51] – external edit 127.0.0.1preview:api:level [2023/12/12 12:16] (current) – external edit 127.0.0.1
Line 3: Line 3:
 //Abstract class//\\ //Abstract class//\\
 **Category**: Data **Category**: Data
 +
  
  
Line 10: Line 11:
  
 ==== getGame ==== ==== getGame ====
 +
 ''[[preview:api:game|GAME]] **getGame**()'' ''[[preview:api:game|GAME]] **getGame**()''
  
Line 16: Line 18:
  
 ==== createObject ==== ==== createObject ====
 +
 ''[[preview:api:game_object|GAME_OBJECT]] **createObject**([//objectSetuperCallback//])'' ''[[preview:api:game_object|GAME_OBJECT]] **createObject**([//objectSetuperCallback//])''
  
Line 25: Line 28:
 ^ Name ^ Type ^ Description ^ ^ Name ^ Type ^ Description ^
 | //''prefab''// | ''[[preview:api:prefab|PREFAB]]'' |  | | //''prefab''// | ''[[preview:api:prefab|PREFAB]]'' |  |
-| //''position''// | ''vec3f'' |  | +| //''position''// | ''[[preview:api:vec3f|vec3f]]'' |  | 
-| //''orientation''// | ''quaternion'' |  |+| //''orientation''// | ''[[preview:api:quaternion|quaternion]]'' |  |
 | //''objectSetuperCallback''// | ''function<void([[preview:api:game_object|GAME_OBJECT]])>'' |  | | //''objectSetuperCallback''// | ''function<void([[preview:api:game_object|GAME_OBJECT]])>'' |  |
  
Line 38: Line 41:
  
 ==== getDeltaTime ==== ==== getDeltaTime ====
-''float **getDeltaTime**()''+ 
 +''[[preview:data-types#float|float]] **getDeltaTime**()''
  
  
Line 44: Line 48:
  
 ==== getUnscaledDeltaTime ==== ==== getUnscaledDeltaTime ====
-''float **getUnscaledDeltaTime**()''+ 
 +''[[preview:data-types#float|float]] **getUnscaledDeltaTime**()''
  
  
Line 50: Line 55:
  
 ==== getTimeScale ==== ==== getTimeScale ====
-''float **getTimeScale**()'' 
  
 +''[[preview:data-types#float|float]] **getTimeScale**()''
  
----- 
- 
-==== registerRuntimeAsset ==== 
-''boolean **registerRuntimeAsset**(//asset//)'' 
- 
-^ Name ^ Type ^ Description ^ 
-| //''asset''// | ''Asset'' |  | 
  
 ---- ----
  
-==== unregisterRuntimeAsset ==== +==== getComponentManager ====
-''boolean **unregisterRuntimeAsset**(//asset//)''+
  
-^ Name ^ Type ^ Description ^ 
-| //''asset''// | ''Asset'' |  | 
- 
----- 
- 
-==== getComponentManager ==== 
 ''[[preview:api:component_manager|COMPONENT_MANAGER]] **getComponentManager**(//componentType//)'' ''[[preview:api:component_manager|COMPONENT_MANAGER]] **getComponentManager**(//componentType//)''
  
 ^ Name ^ Type ^ Description ^ ^ Name ^ Type ^ Description ^
-| //''componentType''// | ''ComponentType'' |  |+| //''componentType''// | ''[[preview:data-types#component_type|component_type]]'' |  |
  
 ---- ----
  
 ==== find ==== ==== find ====
 +
 ''[[preview:api:component|COMPONENT]] **find**(//componentType// [, //enabledOnly//])'' ''[[preview:api:component|COMPONENT]] **find**(//componentType// [, //enabledOnly//])''
  
 ^ Name ^ Type ^ Description ^ ^ Name ^ Type ^ Description ^
-| //''componentType''// | ''ComponentType'' |  | +| //''componentType''// | ''[[preview:data-types#component_type|component_type]]'' |  | 
-| //''enabledOnly''// | ''boolean'' |  |+| //''enabledOnly''// | ''[[preview:data-types#boolean|boolean]]'' |  |
  
 ''[[preview:api:component|COMPONENT]] **find**(//id//, //componentType//)'' ''[[preview:api:component|COMPONENT]] **find**(//id//, //componentType//)''
  
 ^ Name ^ Type ^ Description ^ ^ Name ^ Type ^ Description ^
-| //''id''// | ''Guid'' |  | +| //''id''// | ''[[preview:data-types#guid|guid]]'' |  | 
-| //''componentType''// | ''ComponentType'' |  |+| //''componentType''// | ''[[preview:data-types#component_type|component_type]]'' |  |
  
 ''[[preview:api:game_object|GAME_OBJECT]] **find**(//id//)'' ''[[preview:api:game_object|GAME_OBJECT]] **find**(//id//)''
  
 ^ Name ^ Type ^ Description ^ ^ Name ^ Type ^ Description ^
-| //''id''// | ''Guid'' |  |+| //''id''// | ''[[preview:data-types#guid|guid]]'' |  |
  
 ''[[preview:api:game_object|GAME_OBJECT]] **find**(//name//)'' ''[[preview:api:game_object|GAME_OBJECT]] **find**(//name//)''
  
 ^ Name ^ Type ^ Description ^ ^ Name ^ Type ^ Description ^
-| //''name''// | ''string'' |  |+| //''name''// | ''[[preview:data-types#string|string]]'' |  | 
 + 
 +''void **find**(//name//, //outObjectList//)'' 
 + 
 +^ Name ^ Type ^ Description ^ 
 +| //''name''// | ''[[preview:data-types#string|string]]'' |  | 
 +| //''outObjectList''// | ''[[preview:data-types#list|list]]<[[preview:api:game_object|GAME_OBJECT]]>'' | //[[:annotations#out_argument|Out argument]]// |
  
 ---- ----
  
 ==== createPickingLine ==== ==== createPickingLine ====
-''Line **createPickingLine**(//screenPos//)''+ 
 +''[[preview:api:line|LINE]] **createPickingLine**(//screenPos//)''
  
 ^ Name ^ Type ^ Description ^ ^ Name ^ Type ^ Description ^
-| //''screenPos''// | ''vec2f'' |  |+| //''screenPos''// | ''[[preview:api:vec2f|vec2f]]'' |  |
  
-''Line **createPickingLine**(//screenPos//)''+''[[preview:api:line|LINE]] **createPickingLine**(//screenPos//)''
  
 ^ Name ^ Type ^ Description ^ ^ Name ^ Type ^ Description ^
-| //''screenPos''// | ''vec2i'' |  |+| //''screenPos''// | ''[[preview:api:vec2i|vec2i]]'' |  |
  
 ---- ----
  
 ==== pick ==== ==== pick ====
-''boolean **pick**(//line//, //outPosition//, //outObject// [, //flag// [, //recursiveFlag//]])''+ 
 +''[[preview:data-types#boolean|boolean]] **pick**(//line//, //outPosition//, //outObject// [, //flag// [, //recursiveFlag// [, //objectToSearchInto//]]])''
  
 ^ Name ^ Type ^ Description ^ ^ Name ^ Type ^ Description ^
-| //''line''// | ''Line'' |  | +| //''line''// | ''[[preview:api:line|LINE]]'' |  | 
-| //''outPosition''// | ''vec3f'' | Out argument | +| //''outPosition''// | ''[[preview:api:vec3f|vec3f]]'' | //[[:annotations#out_argument|Out argument]]// | 
-| //''outObject''// | ''[[preview:api:game_object|GAME_OBJECT]]'' | Out argument | +| //''outObject''// | ''[[preview:api:game_object|GAME_OBJECT]]'' | //[[:annotations#out_argument|Out argument]]// | 
-| //''flag''// | ''integer'' |  | +| //''flag''// | ''[[preview:data-types#integer_and_unsigned_integer|integer_and_unsigned_integer]]'' |  | 
-| //''recursiveFlag''// | ''boolean'' |  |+| //''recursiveFlag''// | ''[[preview:data-types#boolean|boolean]]'' |  | 
 +| //''objectToSearchInto''// | ''[[preview:api:game_object|GAME_OBJECT]]'' |  |
  
-''boolean **pick**(//screenPosition//, //outPosition//, //outObject// [, //flag// [, //recursiveFlag//]])''+''[[preview:data-types#boolean|boolean]] **pick**(//screenPosition//, //outPosition//, //outObject// [, //flag// [, //recursiveFlag// [, //objectToSearchInto//]]])''
  
 ^ Name ^ Type ^ Description ^ ^ Name ^ Type ^ Description ^
-| //''screenPosition''// | ''vec2i'' |  | +| //''screenPosition''// | ''[[preview:api:vec2i|vec2i]]'' |  | 
-| //''outPosition''// | ''vec3f'' | Out argument | +| //''outPosition''// | ''[[preview:api:vec3f|vec3f]]'' | //[[:annotations#out_argument|Out argument]]// | 
-| //''outObject''// | ''[[preview:api:game_object|GAME_OBJECT]]'' | Out argument | +| //''outObject''// | ''[[preview:api:game_object|GAME_OBJECT]]'' | //[[:annotations#out_argument|Out argument]]// | 
-| //''flag''// | ''integer'' |  | +| //''flag''// | ''[[preview:data-types#integer_and_unsigned_integer|integer_and_unsigned_integer]]'' |  | 
-| //''recursiveFlag''// | ''boolean'' |  |+| //''recursiveFlag''// | ''[[preview:data-types#boolean|boolean]]'' |  | 
 +| //''objectToSearchInto''// | ''[[preview:api:game_object|GAME_OBJECT]]'' |  |
  
 ---- ----
  
 ==== pickObject ==== ==== pickObject ====
-''[[preview:api:game_object|GAME_OBJECT]] **pickObject**(//line// [, //flag// [, //recursiveFlag//]])''+ 
 +''[[preview:api:game_object|GAME_OBJECT]] **pickObject**(//line// [, //flag// [, //recursiveFlag// [, //objectToSearchInto//]]])''
  
 ^ Name ^ Type ^ Description ^ ^ Name ^ Type ^ Description ^
-| //''line''// | ''Line'' |  | +| //''line''// | ''[[preview:api:line|LINE]]'' |  | 
-| //''flag''// | ''integer'' |  | +| //''flag''// | ''[[preview:data-types#integer_and_unsigned_integer|integer_and_unsigned_integer]]'' |  | 
-| //''recursiveFlag''// | ''boolean'' |  |+| //''recursiveFlag''// | ''[[preview:data-types#boolean|boolean]]'' |  | 
 +| //''objectToSearchInto''// | ''[[preview:api:game_object|GAME_OBJECT]]'' |  |
  
-''[[preview:api:game_object|GAME_OBJECT]] **pickObject**(//screenPosition// [, //flag// [, //recursiveFlag//]])''+''[[preview:api:game_object|GAME_OBJECT]] **pickObject**(//screenPosition// [, //flag// [, //recursiveFlag// [, //objectToSearchInto//]]])''
  
 ^ Name ^ Type ^ Description ^ ^ Name ^ Type ^ Description ^
-| //''screenPosition''// | ''vec2i'' |  | +| //''screenPosition''// | ''[[preview:api:vec2i|vec2i]]'' |  | 
-| //''flag''// | ''integer'' |  | +| //''flag''// | ''[[preview:data-types#integer_and_unsigned_integer|integer_and_unsigned_integer]]'' |  | 
-| //''recursiveFlag''// | ''boolean'' |  |+| //''recursiveFlag''// | ''[[preview:data-types#boolean|boolean]]'' |  | 
 +| //''objectToSearchInto''// | ''[[preview:api:game_object|GAME_OBJECT]]'' |  |
  
 ---- ----
  
 ==== pickPosition ==== ==== pickPosition ====
-''boolean **pickPosition**(//line//, //outPosition// [, //flag// [, //recursiveFlag//]])''+ 
 +''[[preview:data-types#boolean|boolean]] **pickPosition**(//line//, //outPosition// [, //flag// [, //recursiveFlag// [, //objectToSearchInto//]]])''
  
 ^ Name ^ Type ^ Description ^ ^ Name ^ Type ^ Description ^
-| //''line''// | ''Line'' |  | +| //''line''// | ''[[preview:api:line|LINE]]'' |  | 
-| //''outPosition''// | ''vec3f'' | Out argument | +| //''outPosition''// | ''[[preview:api:vec3f|vec3f]]'' | //[[:annotations#out_argument|Out argument]]// | 
-| //''flag''// | ''integer'' |  | +| //''flag''// | ''[[preview:data-types#integer_and_unsigned_integer|integer_and_unsigned_integer]]'' |  | 
-| //''recursiveFlag''// | ''boolean'' |  |+| //''recursiveFlag''// | ''[[preview:data-types#boolean|boolean]]'' |  | 
 +| //''objectToSearchInto''// | ''[[preview:api:game_object|GAME_OBJECT]]'' |  |
  
-''boolean **pickPosition**(//screenPosition//, //outPosition// [, //flag// [, //recursiveFlag//]])''+''[[preview:data-types#boolean|boolean]] **pickPosition**(//screenPosition//, //outPosition// [, //flag// [, //recursiveFlag// [, //objectToSearchInto//]]])''
  
 ^ Name ^ Type ^ Description ^ ^ Name ^ Type ^ Description ^
-| //''screenPosition''// | ''vec2i'' |  | +| //''screenPosition''// | ''[[preview:api:vec2i|vec2i]]'' |  | 
-| //''outPosition''// | ''vec3f'' | Out argument | +| //''outPosition''// | ''[[preview:api:vec3f|vec3f]]'' | //[[:annotations#out_argument|Out argument]]// | 
-| //''flag''// | ''integer'' |  | +| //''flag''// | ''[[preview:data-types#integer_and_unsigned_integer|integer_and_unsigned_integer]]'' |  | 
-| //''recursiveFlag''// | ''boolean'' |  |+| //''recursiveFlag''// | ''[[preview:data-types#boolean|boolean]]'' |  | 
 +| //''objectToSearchInto''// | ''[[preview:api:game_object|GAME_OBJECT]]'' |  |
  
 ---- ----
  
 ==== worldToScreenCoordinates ==== ==== worldToScreenCoordinates ====
-''boolean **worldToScreenCoordinates**(//worldPosition//, //outScreenPosition//)''+ 
 +''[[preview:data-types#boolean|boolean]] **worldToScreenCoordinates**(//worldPosition//, //outScreenPosition//)''
  
 ^ Name ^ Type ^ Description ^ ^ Name ^ Type ^ Description ^
-| //''worldPosition''// | ''vec3f'' |  | +| //''worldPosition''// | ''[[preview:api:vec3f|vec3f]]'' |  | 
-| //''outScreenPosition''// | ''vec2f'' | Out argument |+| //''outScreenPosition''// | ''[[preview:api:vec2f|vec2f]]'' | //[[:annotations#out_argument|Out argument]]// |
  
-''vec2f **worldToScreenCoordinates**(//worldPosition//)''+''[[preview:api:vec2f|vec2f]] **worldToScreenCoordinates**(//worldPosition//)''
  
 ^ Name ^ Type ^ Description ^ ^ Name ^ Type ^ Description ^
-| //''worldPosition''// | ''vec3f'' |  |+| //''worldPosition''// | ''[[preview:api:vec3f|vec3f]]'' |  |
  
 ---- ----
  
 ==== isVisibleOnScreen ==== ==== isVisibleOnScreen ====
-''boolean **isVisibleOnScreen**(//worldPosition//)''+ 
 +''[[preview:data-types#boolean|boolean]] **isVisibleOnScreen**(//worldPosition//)''
  
 ^ Name ^ Type ^ Description ^ ^ Name ^ Type ^ Description ^
-| //''worldPosition''// | ''vec3f'' |  |+| //''worldPosition''// | ''[[preview:api:vec3f|vec3f]]'' |  |
  
 ---- ----
  
 ==== rayCast ==== ==== rayCast ====
-''boolean **rayCast**(//screenPosition//, //distance//, //outResult// [, //flag//])''+ 
 +''[[preview:data-types#boolean|boolean]] **rayCast**(//screenPosition//, //distance//, //outResult// [, //flag//])''
  
 ^ Name ^ Type ^ Description ^ ^ Name ^ Type ^ Description ^
-| //''screenPosition''// | ''vec2i'' |  | +| //''screenPosition''// | ''[[preview:api:vec2i|vec2i]]'' |  | 
-| //''distance''// | ''float'' |  | +| //''distance''// | ''[[preview:data-types#float|float]]'' |  | 
-| //''outResult''// | ''PhysicsRayResult'' | Out argument | +| //''outResult''// | ''[[preview:api:physics_ray_result|PHYSICS_RAY_RESULT]]'' | //[[:annotations#out_argument|Out argument]]// | 
-| //''flag''// | ''integer'' |  |+| //''flag''// | ''[[preview:data-types#integer_and_unsigned_integer|integer_and_unsigned_integer]]'' |  |
  
-''boolean **rayCast**(//from//, //to//, //outResult// [, //flag//])''+''[[preview:data-types#boolean|boolean]] **rayCast**(//from//, //to//, //outResult// [, //flag//])''
  
 ^ Name ^ Type ^ Description ^ ^ Name ^ Type ^ Description ^
-| //''from''// | ''vec3f'' |  | +| //''from''// | ''[[preview:api:vec3f|vec3f]]'' |  | 
-| //''to''// | ''vec3f'' |  | +| //''to''// | ''[[preview:api:vec3f|vec3f]]'' |  | 
-| //''outResult''// | ''PhysicsRayResult'' | Out argument | +| //''outResult''// | ''[[preview:api:physics_ray_result|PHYSICS_RAY_RESULT]]'' | //[[:annotations#out_argument|Out argument]]// | 
-| //''flag''// | ''integer'' |  |+| //''flag''// | ''[[preview:data-types#integer_and_unsigned_integer|integer_and_unsigned_integer]]'' |  |
  
  
preview/api/level.1579128712.txt.gz · Last modified: 2020/01/15 17:51 by 127.0.0.1
Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki