Foundation - Modding Documentation

User Tools

Site Tools

Trace:
api:level

Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
api:level [2023/09/14 15:03] – [find] polymorphgamesapi:level [2024/02/06 13:53] (current) – external edit 127.0.0.1
Line 12: Line 12:
 ==== getGame ==== ==== getGame ====
  
-''[[api:game|GAME]] **getGame**()''+''[[:api:game|GAME]] **getGame**()''
  
  
Line 19: Line 19:
 ==== createObject ==== ==== createObject ====
  
-''[[api:game_object|GAME_OBJECT]] **createObject**([//objectSetuperCallback//])''+''[[:api:game_object|GAME_OBJECT]] **createObject**([//objectSetuperCallback//])''
  
 ^ Name ^ Type ^ Description ^ ^ Name ^ Type ^ Description ^
-| //''objectSetuperCallback''// | ''function<void([[api:game_object|GAME_OBJECT]])>'' |  |+| //''objectSetuperCallback''// | ''function<void([[:api:game_object|GAME_OBJECT]])>'' |  |
  
-''[[api:game_object|GAME_OBJECT]] **createObject**(//prefab// [, //position// [, //orientation// [, //objectSetuperCallback//]]])''+''[[:api:game_object|GAME_OBJECT]] **createObject**(//prefab// [, //position// [, //orientation// [, //objectSetuperCallback//]]])''
  
 ^ Name ^ Type ^ Description ^ ^ Name ^ Type ^ Description ^
-| //''prefab''// | ''[[api:prefab|PREFAB]]'' |  | +| //''prefab''// | ''[[:api:prefab|PREFAB]]'' |  | 
-| //''position''// | ''[[api:vec3f|vec3f]]'' |  | +| //''position''// | ''[[:api:vec3f|vec3f]]'' |  | 
-| //''orientation''// | ''[[api:quaternion|quaternion]]'' |  | +| //''orientation''// | ''[[:api:quaternion|quaternion]]'' |  | 
-| //''objectSetuperCallback''// | ''function<void([[api:game_object|GAME_OBJECT]])>'' |  |+| //''objectSetuperCallback''// | ''function<void([[:api:game_object|GAME_OBJECT]])>'' |  |
  
-''[[api:game_object|GAME_OBJECT]] **createObject**(//prefab//, //objectSetuperCallback//)''+''[[:api:game_object|GAME_OBJECT]] **createObject**(//prefab//, //objectSetuperCallback//)''
  
 ^ Name ^ Type ^ Description ^ ^ Name ^ Type ^ Description ^
-| //''prefab''// | ''[[api:prefab|PREFAB]]'' |  | +| //''prefab''// | ''[[:api:prefab|PREFAB]]'' |  | 
-| //''objectSetuperCallback''// | ''function<void([[api:game_object|GAME_OBJECT]])>'' |  |+| //''objectSetuperCallback''// | ''function<void([[:api:game_object|GAME_OBJECT]])>'' |  |
  
 ---- ----
Line 42: Line 42:
 ==== getDeltaTime ==== ==== getDeltaTime ====
  
-''float **getDeltaTime**()''+''[[:data-types#float|float]] **getDeltaTime**()''
  
  
Line 49: Line 49:
 ==== getUnscaledDeltaTime ==== ==== getUnscaledDeltaTime ====
  
-''float **getUnscaledDeltaTime**()''+''[[:data-types#float|float]] **getUnscaledDeltaTime**()''
  
  
Line 56: Line 56:
 ==== getTimeScale ==== ==== getTimeScale ====
  
-''float **getTimeScale**()''+''[[:data-types#float|float]] **getTimeScale**()''
  
  
Line 63: Line 63:
 ==== getComponentManager ==== ==== getComponentManager ====
  
-''[[api:component_manager|COMPONENT_MANAGER]] **getComponentManager**(//componentType//)''+''[[:api:component_manager|COMPONENT_MANAGER]] **getComponentManager**(//componentType//)''
  
 ^ Name ^ Type ^ Description ^ ^ Name ^ Type ^ Description ^
-| //''componentType''// | ''component type'' |  | +| //''componentType''// | ''[[:data-types#component_type|component_type]]'' |  |
- +
----- +
- +
-==== getMasterComponentManager ==== +
- +
-''MasterComponentManager **getMasterComponentManager**(//componentType//)'' +
- +
-^ Name ^ Type ^ Description ^ +
-| //''componentType''// | ''component type'' |  |+
  
 ---- ----
Line 81: Line 72:
 ==== find ==== ==== find ====
  
-''[[api:component|COMPONENT]] **find**(//componentType// [, //enabledOnly//])''+''[[:api:component|COMPONENT]] **find**(//componentType// [, //enabledOnly//])''
  
 ^ Name ^ Type ^ Description ^ ^ Name ^ Type ^ Description ^
-| //''componentType''// | ''component type'' |  | +| //''componentType''// | ''[[:data-types#component_type|component_type]]'' |  | 
-| //''enabledOnly''// | ''boolean'' |  |+| //''enabledOnly''// | ''[[:data-types#boolean|boolean]]'' |  |
  
-''[[api:component|COMPONENT]] **find**(//id//, //componentType//)''+''[[:api:component|COMPONENT]] **find**(//id//, //componentType//)''
  
 ^ Name ^ Type ^ Description ^ ^ Name ^ Type ^ Description ^
-| //''id''// | ''Guid'' |  | +| //''id''// | ''[[:data-types#guid|guid]]'' |  | 
-| //''componentType''// | ''component type'' |  |+| //''componentType''// | ''[[:data-types#component_type|component_type]]'' |  |
  
-''[[api:game_object|GAME_OBJECT]] **find**(//id//)''+''[[:api:game_object|GAME_OBJECT]] **find**(//id//)''
  
 ^ Name ^ Type ^ Description ^ ^ Name ^ Type ^ Description ^
-| //''id''// | ''Guid'' |  |+| //''id''// | ''[[:data-types#guid|guid]]'' |  |
  
-''[[api:game_object|GAME_OBJECT]] **find**(//name//)''+''[[:api:game_object|GAME_OBJECT]] **find**(//name//)''
  
 ^ Name ^ Type ^ Description ^ ^ Name ^ Type ^ Description ^
-| //''name''// | ''string'' |  |+| //''name''// | ''[[:data-types#string|string]]'' |  |
  
 ''void **find**(//name//, //outObjectList//)'' ''void **find**(//name//, //outObjectList//)''
  
 ^ Name ^ Type ^ Description ^ ^ Name ^ Type ^ Description ^
-| //''name''// | ''string'' |  |+| //''name''// | ''[[:data-types#string|string]]'' |  |
 | //''outObjectList''// | ''[[:data-types#list|list]]<[[:api:game_object|GAME_OBJECT]]>'' | //[[:annotations#out_argument|Out argument]]// | | //''outObjectList''// | ''[[:data-types#list|list]]<[[:api:game_object|GAME_OBJECT]]>'' | //[[:annotations#out_argument|Out argument]]// |
  
Line 113: Line 104:
 ==== createPickingLine ==== ==== createPickingLine ====
  
-''[[api:line|LINE]] **createPickingLine**(//screenPos//)''+''[[:api:line|LINE]] **createPickingLine**(//screenPos//)''
  
 ^ Name ^ Type ^ Description ^ ^ Name ^ Type ^ Description ^
-| //''screenPos''// | ''[[api:vec2f|vec2f]]'' |  |+| //''screenPos''// | ''[[:api:vec2f|vec2f]]'' |  |
  
-''[[api:line|LINE]] **createPickingLine**(//screenPos//)''+''[[:api:line|LINE]] **createPickingLine**(//screenPos//)''
  
 ^ Name ^ Type ^ Description ^ ^ Name ^ Type ^ Description ^
-| //''screenPos''// | ''[[api:vec2i|vec2i]]'' |  |+| //''screenPos''// | ''[[:api:vec2i|vec2i]]'' |  |
  
 ---- ----
Line 127: Line 118:
 ==== pick ==== ==== pick ====
  
-''boolean **pick**(//line//, //outPosition//, //outObject// [, //flag// [, //recursiveFlag// [, //objectToSearchInto//]]])''+''[[:data-types#boolean|boolean]] **pick**(//line//, //outPosition//, //outObject// [, //flag// [, //recursiveFlag// [, //objectToSearchInto//]]])''
  
 ^ Name ^ Type ^ Description ^ ^ Name ^ Type ^ Description ^
-| //''line''// | ''[[api:line|LINE]]'' |  | +| //''line''// | ''[[:api:line|LINE]]'' |  | 
-| //''outPosition''// | ''[[api:vec3f|vec3f]]'' | //[[:annotations#out_argument|Out argument]]// | +| //''outPosition''// | ''[[:api:vec3f|vec3f]]'' | //[[:annotations#out_argument|Out argument]]// | 
-| //''outObject''// | ''[[api:game_object|GAME_OBJECT]]'' | //[[:annotations#out_argument|Out argument]]// | +| //''outObject''// | ''[[:api:game_object|GAME_OBJECT]]'' | //[[:annotations#out_argument|Out argument]]// | 
-| //''flag''// | ''integer'' |  | +| //''flag''// | ''[[:data-types#integer_and_unsigned_integer|integer_and_unsigned_integer]]'' |  | 
-| //''recursiveFlag''// | ''boolean'' |  | +| //''recursiveFlag''// | ''[[:data-types#boolean|boolean]]'' |  | 
-| //''objectToSearchInto''// | ''[[api:game_object|GAME_OBJECT]]'' |  |+| //''objectToSearchInto''// | ''[[:api:game_object|GAME_OBJECT]]'' |  |
  
-''boolean **pick**(//screenPosition//, //outPosition//, //outObject// [, //flag// [, //recursiveFlag// [, //objectToSearchInto//]]])''+''[[:data-types#boolean|boolean]] **pick**(//screenPosition//, //outPosition//, //outObject// [, //flag// [, //recursiveFlag// [, //objectToSearchInto//]]])''
  
 ^ Name ^ Type ^ Description ^ ^ Name ^ Type ^ Description ^
-| //''screenPosition''// | ''[[api:vec2i|vec2i]]'' |  | +| //''screenPosition''// | ''[[:api:vec2i|vec2i]]'' |  | 
-| //''outPosition''// | ''[[api:vec3f|vec3f]]'' | //[[:annotations#out_argument|Out argument]]// | +| //''outPosition''// | ''[[:api:vec3f|vec3f]]'' | //[[:annotations#out_argument|Out argument]]// | 
-| //''outObject''// | ''[[api:game_object|GAME_OBJECT]]'' | //[[:annotations#out_argument|Out argument]]// | +| //''outObject''// | ''[[:api:game_object|GAME_OBJECT]]'' | //[[:annotations#out_argument|Out argument]]// | 
-| //''flag''// | ''integer'' |  | +| //''flag''// | ''[[:data-types#integer_and_unsigned_integer|integer_and_unsigned_integer]]'' |  | 
-| //''recursiveFlag''// | ''boolean'' |  | +| //''recursiveFlag''// | ''[[:data-types#boolean|boolean]]'' |  | 
-| //''objectToSearchInto''// | ''[[api:game_object|GAME_OBJECT]]'' |  |+| //''objectToSearchInto''// | ''[[:api:game_object|GAME_OBJECT]]'' |  |
  
 ---- ----
Line 151: Line 142:
 ==== pickObject ==== ==== pickObject ====
  
-''[[api:game_object|GAME_OBJECT]] **pickObject**(//line// [, //flag// [, //recursiveFlag// [, //objectToSearchInto//]]])''+''[[:api:game_object|GAME_OBJECT]] **pickObject**(//line// [, //flag// [, //recursiveFlag// [, //objectToSearchInto//]]])''
  
 ^ Name ^ Type ^ Description ^ ^ Name ^ Type ^ Description ^
-| //''line''// | ''[[api:line|LINE]]'' |  | +| //''line''// | ''[[:api:line|LINE]]'' |  | 
-| //''flag''// | ''integer'' |  | +| //''flag''// | ''[[:data-types#integer_and_unsigned_integer|integer_and_unsigned_integer]]'' |  | 
-| //''recursiveFlag''// | ''boolean'' |  | +| //''recursiveFlag''// | ''[[:data-types#boolean|boolean]]'' |  | 
-| //''objectToSearchInto''// | ''[[api:game_object|GAME_OBJECT]]'' |  |+| //''objectToSearchInto''// | ''[[:api:game_object|GAME_OBJECT]]'' |  |
  
-''[[api:game_object|GAME_OBJECT]] **pickObject**(//screenPosition// [, //flag// [, //recursiveFlag// [, //objectToSearchInto//]]])''+''[[:api:game_object|GAME_OBJECT]] **pickObject**(//screenPosition// [, //flag// [, //recursiveFlag// [, //objectToSearchInto//]]])''
  
 ^ Name ^ Type ^ Description ^ ^ Name ^ Type ^ Description ^
-| //''screenPosition''// | ''[[api:vec2i|vec2i]]'' |  | +| //''screenPosition''// | ''[[:api:vec2i|vec2i]]'' |  | 
-| //''flag''// | ''integer'' |  | +| //''flag''// | ''[[:data-types#integer_and_unsigned_integer|integer_and_unsigned_integer]]'' |  | 
-| //''recursiveFlag''// | ''boolean'' |  | +| //''recursiveFlag''// | ''[[:data-types#boolean|boolean]]'' |  | 
-| //''objectToSearchInto''// | ''[[api:game_object|GAME_OBJECT]]'' |  |+| //''objectToSearchInto''// | ''[[:api:game_object|GAME_OBJECT]]'' |  |
  
 ---- ----
Line 171: Line 162:
 ==== pickPosition ==== ==== pickPosition ====
  
-''boolean **pickPosition**(//line//, //outPosition// [, //flag// [, //recursiveFlag// [, //objectToSearchInto//]]])''+''[[:data-types#boolean|boolean]] **pickPosition**(//line//, //outPosition// [, //flag// [, //recursiveFlag// [, //objectToSearchInto//]]])''
  
 ^ Name ^ Type ^ Description ^ ^ Name ^ Type ^ Description ^
-| //''line''// | ''[[api:line|LINE]]'' |  | +| //''line''// | ''[[:api:line|LINE]]'' |  | 
-| //''outPosition''// | ''[[api:vec3f|vec3f]]'' | //[[:annotations#out_argument|Out argument]]// | +| //''outPosition''// | ''[[:api:vec3f|vec3f]]'' | //[[:annotations#out_argument|Out argument]]// | 
-| //''flag''// | ''integer'' |  | +| //''flag''// | ''[[:data-types#integer_and_unsigned_integer|integer_and_unsigned_integer]]'' |  | 
-| //''recursiveFlag''// | ''boolean'' |  | +| //''recursiveFlag''// | ''[[:data-types#boolean|boolean]]'' |  | 
-| //''objectToSearchInto''// | ''[[api:game_object|GAME_OBJECT]]'' |  |+| //''objectToSearchInto''// | ''[[:api:game_object|GAME_OBJECT]]'' |  |
  
-''boolean **pickPosition**(//screenPosition//, //outPosition// [, //flag// [, //recursiveFlag// [, //objectToSearchInto//]]])''+''[[:data-types#boolean|boolean]] **pickPosition**(//screenPosition//, //outPosition// [, //flag// [, //recursiveFlag// [, //objectToSearchInto//]]])''
  
 ^ Name ^ Type ^ Description ^ ^ Name ^ Type ^ Description ^
-| //''screenPosition''// | ''[[api:vec2i|vec2i]]'' |  | +| //''screenPosition''// | ''[[:api:vec2i|vec2i]]'' |  | 
-| //''outPosition''// | ''[[api:vec3f|vec3f]]'' | //[[:annotations#out_argument|Out argument]]// | +| //''outPosition''// | ''[[:api:vec3f|vec3f]]'' | //[[:annotations#out_argument|Out argument]]// | 
-| //''flag''// | ''integer'' |  | +| //''flag''// | ''[[:data-types#integer_and_unsigned_integer|integer_and_unsigned_integer]]'' |  | 
-| //''recursiveFlag''// | ''boolean'' |  | +| //''recursiveFlag''// | ''[[:data-types#boolean|boolean]]'' |  | 
-| //''objectToSearchInto''// | ''[[api:game_object|GAME_OBJECT]]'' |  |+| //''objectToSearchInto''// | ''[[:api:game_object|GAME_OBJECT]]'' |  |
  
 ---- ----
Line 193: Line 184:
 ==== worldToScreenCoordinates ==== ==== worldToScreenCoordinates ====
  
-''boolean **worldToScreenCoordinates**(//worldPosition//, //outScreenPosition//)''+''[[:data-types#boolean|boolean]] **worldToScreenCoordinates**(//worldPosition//, //outScreenPosition//)''
  
 ^ Name ^ Type ^ Description ^ ^ Name ^ Type ^ Description ^
-| //''worldPosition''// | ''[[api:vec3f|vec3f]]'' |  | +| //''worldPosition''// | ''[[:api:vec3f|vec3f]]'' |  | 
-| //''outScreenPosition''// | ''[[api:vec2f|vec2f]]'' | //[[:annotations#out_argument|Out argument]]// |+| //''outScreenPosition''// | ''[[:api:vec2f|vec2f]]'' | //[[:annotations#out_argument|Out argument]]// |
  
-''[[api:vec2f|vec2f]] **worldToScreenCoordinates**(//worldPosition//)''+''[[:api:vec2f|vec2f]] **worldToScreenCoordinates**(//worldPosition//)''
  
 ^ Name ^ Type ^ Description ^ ^ Name ^ Type ^ Description ^
-| //''worldPosition''// | ''[[api:vec3f|vec3f]]'' |  |+| //''worldPosition''// | ''[[:api:vec3f|vec3f]]'' |  |
  
 ---- ----
Line 208: Line 199:
 ==== isVisibleOnScreen ==== ==== isVisibleOnScreen ====
  
-''boolean **isVisibleOnScreen**(//worldPosition//)''+''[[:data-types#boolean|boolean]] **isVisibleOnScreen**(//worldPosition//)''
  
 ^ Name ^ Type ^ Description ^ ^ Name ^ Type ^ Description ^
-| //''worldPosition''// | ''[[api:vec3f|vec3f]]'' |  |+| //''worldPosition''// | ''[[:api:vec3f|vec3f]]'' |  |
  
 ---- ----
Line 217: Line 208:
 ==== rayCast ==== ==== rayCast ====
  
-''boolean **rayCast**(//screenPosition//, //distance//, //outResult// [, //flag//])''+''[[:data-types#boolean|boolean]] **rayCast**(//screenPosition//, //distance//, //outResult// [, //flag//])''
  
 ^ Name ^ Type ^ Description ^ ^ Name ^ Type ^ Description ^
-| //''screenPosition''// | ''[[api:vec2i|vec2i]]'' |  | +| //''screenPosition''// | ''[[:api:vec2i|vec2i]]'' |  | 
-| //''distance''// | ''float'' |  | +| //''distance''// | ''[[:data-types#float|float]]'' |  | 
-| //''outResult''// | ''[[api:physics_ray_result|PHYSICS_RAY_RESULT]]'' | //[[:annotations#out_argument|Out argument]]// | +| //''outResult''// | ''[[:api:physics_ray_result|PHYSICS_RAY_RESULT]]'' | //[[:annotations#out_argument|Out argument]]// | 
-| //''flag''// | ''integer'' |  |+| //''flag''// | ''[[:data-types#integer_and_unsigned_integer|integer_and_unsigned_integer]]'' |  |
  
-''boolean **rayCast**(//from//, //to//, //outResult// [, //flag//])''+''[[:data-types#boolean|boolean]] **rayCast**(//from//, //to//, //outResult// [, //flag//])''
  
 ^ Name ^ Type ^ Description ^ ^ Name ^ Type ^ Description ^
-| //''from''// | ''[[api:vec3f|vec3f]]'' |  | +| //''from''// | ''[[:api:vec3f|vec3f]]'' |  | 
-| //''to''// | ''[[api:vec3f|vec3f]]'' |  | +| //''to''// | ''[[:api:vec3f|vec3f]]'' |  | 
-| //''outResult''// | ''[[api:physics_ray_result|PHYSICS_RAY_RESULT]]'' | //[[:annotations#out_argument|Out argument]]// | +| //''outResult''// | ''[[:api:physics_ray_result|PHYSICS_RAY_RESULT]]'' | //[[:annotations#out_argument|Out argument]]// | 
-| //''flag''// | ''integer'' |  |+| //''flag''// | ''[[:data-types#integer_and_unsigned_integer|integer_and_unsigned_integer]]'' |  |
  
  
api/level.txt · Last modified: 2024/02/06 13:53 by 127.0.0.1
Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki