User Tools

Site Tools


hpl3:community:scripting:classes:cworld

Differences

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

Link to this comparison view

hpl3:community:scripting:classes:cworld [2015/11/05 11:31] (current)
abion47 created
Line 1: Line 1:
 +=====cWorld=====
 +
 +====Fields====
 +
 +cWorld has no public fields.
 +
 +====Functions====
 +
 +^ Return Type ^ Function Name ^ Parameters ^ Description ^
 +| void | Update | float afTimeStep |   |
 +| void | SetActive | bool abX |   |
 +| bool | IsActive | const |   |
 +| const [[cVector3f]]&​ | GetWorldSize |     ​| ​  |
 +| [[tString]] | GetName |     ​| ​  |
 +| void | Compile | bool abCalcPhysicsWorldSize |   |
 +| void | SetMainRenderableContainerVisible | bool abX |   |
 +| void | GetSubMeshEntityInArea |  avObjects, \\ const [[cVector3f]] &in avMin, \\ const [[cVector3f]] &in avMax |   |
 +| [[eIDSpace]] | GetCurrentIDSpace |     ​| ​  |
 +| void | SetCurrentIDSpace | [[eIDSpace]] aSpace |   |
 +| [[tID]] | SetEntityID | [[iEntity3D]]@ apEntity, \\ [[tID]] alID |   |
 +| [[tID]] | SetEntityID | [[iEntity3D]]@ apEntity, \\ [[eIDSpace]] aSpace, \\ uint alLocation, \\ uint alInner |   |
 +| [[iEntity3D]]@ | GetEntityFromID | [[tID]] aID |   |
 +| void | SetDistanceCullActive | bool abX |   |
 +| void | SetDistanceCullMinRange | float afX |   |
 +| void | SetDistanceCullScreenSize | float afX |   |
 +| void | SetDistanceCullRandomSize | float afX |   |
 +| void | SetDistanceCullMaxRange | float afX |   |
 +| void | SetDistanceCullFadeSpeed | float afX |   |
 +| bool | GetDistanceCullActive |     ​| ​  |
 +| float | GetDistanceCullMinRange |     ​| ​  |
 +| float | GetDistanceCullScreenSize |     ​| ​  |
 +| float | GetDistanceCullRandomSize |     ​| ​  |
 +| float | GetDistanceCullMaxRange |     ​| ​  |
 +| float | GetDistanceCullFadeSpeed |     ​| ​  |
 +| void | SetPhysicsWorld | [[iPhysicsWorld]]@ apWorld, \\ bool abAutoDelete |   |
 +| [[iPhysicsWorld]]@ | GetPhysicsWorld |     ​| ​  |
 +| [[cTerrain]]@ | GetTerrain |     ​| ​  |
 +| void | SetTerrainActive | bool abX |   |
 +| bool | GetTerrainActive |     ​| ​  |
 +| void | SetSkyBox | [[iTexture]]@ apTexture, \\ bool abAutoDestroy |   |
 +| void | SetSkyBoxActive | bool abX |   |
 +| void | SetSkyBoxColor | const [[cColor]] &in aColor |   |
 +| void | SetSkyBoxBrightness | float afX |   |
 +| [[iTexture]]@ | GetSkyBoxTexture |     ​| ​  |
 +| [[iVertexBuffer]]@ | GetSkyBoxVertexBuffer |     ​| ​  |
 +| bool | GetSkyBoxActive |     ​| ​  |
 +| const [[cColor]]&​ | GetSkyBoxColor |     ​| ​  |
 +| float | GetSkyBoxBrightness |     ​| ​  |
 +| [[cLightDirectional]]@ | GetDirectionalLight |     ​| ​  |
 +| void | SetDirectionalLightActive | bool abX |   |
 +| bool | GetDirectionalLightActive |     ​| ​  |
 +| void | SetFogActive | bool abX |   |
 +| void | SetFogStart | float afX |   |
 +| void | SetFogEnd | float afX |   |
 +| void | SetFogFalloffExp | float afX |   |
 +| void | SetFogColor | const [[cColor]] &in aCol |   |
 +| void | SetFogBrightness | float afX |   |
 +| void | SetSecondaryFogActive | bool abX |   |
 +| void | SetSecondaryFogStart | float afX |   |
 +| void | SetSecondaryFogEnd | float afX |   |
 +| void | SetSecondaryFogFalloffExp | float afX |   |
 +| void | SetSecondaryFogColor | const [[cColor]] &in aCol |   |
 +| void | SetSecondaryFogBrightness | float afX |   |
 +| void | SetFogCulling | bool abX |   |
 +| void | SetFogUnderwater | bool abX |   |
 +| void | SetFogUseSkybox | bool abX |   |
 +| void | SetFogSkyboxTexture | [[iTexture]]@ apTexture |   |
 +| void | SetFogApplyAfterFogAreas | bool abX |   |
 +| bool | GetFogActive |     ​| ​  |
 +| float | GetFogStart |     ​| ​  |
 +| float | GetFogEnd |     ​| ​  |
 +| float | GetFogFalloffExp |     ​| ​  |
 +| float | GetFogBrightness |     ​| ​  |
 +| const [[cColor]]&​ | GetFogColor |     ​| ​  |
 +| bool | GetSecondaryFogActive |     ​| ​  |
 +| float | GetSecondaryFogStart |     ​| ​  |
 +| float | GetSecondaryFogEnd |     ​| ​  |
 +| float | GetSecondaryFogFalloffExp |     ​| ​  |
 +| float | GetSecondaryFogBrightness |     ​| ​  |
 +| const [[cColor]]&​ | GetSecondaryFogColor |     ​| ​  |
 +| bool | GetFogCulling |     ​| ​  |
 +| bool | GetFogUnderwater |     ​| ​  |
 +| bool | GetFogUseSkybox |     ​| ​  |
 +| bool | GetFogApplyAfterFogAreas |     ​| ​  |
 +| [[iTexture]]@ | GetFogSkyboxTexture |     ​| ​  |
 +| [[cMeshEntity]]@ | CreateMeshEntity | const [[tString]]&​ asName, \\ [[cMesh]]@ apMesh, \\ bool abStatic |   |
 +| [[tID]] | CreateMeshEntityID | const [[tString]]&​ asName, \\ [[cMesh]]@ apMesh, \\ bool abStatic |   |
 +| void | DestroyMeshEntity | [[cMeshEntity]]@ apMesh |   |
 +| [[cMeshEntity]]@ | GetDynamicMeshEntity | const [[tString]] &in asName |   |
 +| [[cMeshEntityIterator]]@ | GetDynamicMeshEntityIterator |     ​| ​  |
 +| [[cMeshEntityIterator]]@ | GetStaticMeshEntityIterator |     ​| ​  |
 +| [[cMeshEntity]]@ | GetMeshEntityFromID | [[tID]] aID |   |
 +| [[cSubMeshEntity]]@ | GetSubMeshEntityFromID | [[tID]] aID |   |
 +| [[cLightPoint]]@ | CreateLightPoint | const [[tString]]&​ asName, \\ const [[tString]]&​ asGobo, \\ bool abStatic |   |
 +| [[cLightSpot]]@ | CreateLightSpot | const [[tString]]&​ asName, \\ const [[tString]]&​ asGobo, \\ bool abStatic |   |
 +| [[cLightBox]]@ | CreateLightBox | const [[tString]]&​ asName, \\ bool abStatic |   |
 +| [[tID]] | CreateLightPointID | const [[tString]]&​ asName, \\ const [[tString]]&​ asGobo, \\ bool abStatic |   |
 +| [[tID]] | CreateLightSpotID | const [[tString]]&​ asName, \\ const [[tString]]&​ asGobo, \\ bool abStatic |   |
 +| [[tID]] | CreateLightBoxID | const [[tString]]&​ asName, \\ bool abStatic |   |
 +| void | DestroyLight | [[iLight]]@ apLight |   |
 +| [[iLight]]@ | GetLight | const [[tString]] &in asName |   |
 +| [[iLight]]@ | GetLightFromID | [[tID]] aID |   |
 +| void | FadeInIrradianceSet | const [[tString]] &in asSetName, \\ float afTime |   |
 +| [[cLightListIterator]]@ | GetLightIterator |     ​| ​  |
 +| [[cLightMaskBoxListIterator]]@ | GetLightMaskBoxIterator |     ​| ​  |
 +| [[cBillboard]]@ | CreateBillboard | const [[tString]] &in asName, \\ const [[cVector2f]] &in avSize, \\ [[eBillboardType]] aType, \\ const [[tString]] &in asMaterial, \\ bool abStatic |   |
 +| [[tID]] | CreateBillboardID | const [[tString]] &in asName, \\ const [[cVector2f]] &in avSize, \\ [[eBillboardType]] aType, \\ const [[tString]] &in asMaterial, \\ bool abStatic |   |
 +| void | DestroyBillboard | [[cBillboard]]@ apObject |   |
 +| [[cBillboard]]@ | GetBillboard | const [[tString]] &in asName |   |
 +| [[cBillboard]]@ | GetBillboardFromID | [[tID]] alID |   |
 +| [[cBillboardIterator]]@ | GetBillboardIterator |     ​| ​  |
 +| [[cBillboardGroup]]@ | CreateBillboardGroup | const [[tString]] &in asName, \\ const [[tString]] &in asMaterial, \\ bool abStatic |   |
 +| [[tID]] | CreateBillboardGroupID | const [[tString]] &in asName, \\ const [[tString]] &in asMaterial, \\ bool abStatic |   |
 +| void | DestroyBillboardGroup | [[cBillboardGroup]]@ apObject |   |
 +| [[cBillboardGroup]]@ | GetBillboardGroup | const [[tString]] &in asName |   |
 +| [[cBillboardGroup]]@ | GetBillboardGroupFromID | [[tID]] alID |   |
 +| void | RemoveBillboardFromGroup | [[cBillboard]]@ apObject, \\ [[cBillboardGroup]]@ apGroup |   |
 +| void | AddBillboardToGroup | [[cBillboard]]@ apObject, \\ [[cBillboardGroup]]@ apGroup |   |
 +| [[cBillboardGroupIterator]]@ | GetBillboardGroupIterator |     ​| ​  |
 +| [[cFogArea]]@ | CreateFogArea | const [[tString]] &in asName, \\ bool abStatic |   |
 +| [[tID]] | CreateFogAreaID | const [[tString]] &in asName, \\ bool abStatic |   |
 +| void | DestroyFogArea | [[cFogArea]]@ apFogArea |   |
 +| [[cFogArea]]@ | GetFogArea | const [[tString]] &in asName |   |
 +| [[cFogArea]]@ | GetFogAreaFromID | [[tID]] alID |   |
 +| [[cFogAreaIterator]]@ | GetFogAreaIterator |     ​| ​  |
 +| [[cForceField]]@ | CreateForceField | const [[tString]] &in asName, \\ bool abAutoRemove,​ \\ bool abStatic |   |
 +| [[tID]] | CreateForceFieldID | const [[tString]] &in asName, \\ bool abAutoRemove,​ \\ bool abStatic |   |
 +| void | DestroyForceField | [[cForceField]]@ apForce |   |
 +| [[cForceField]]@ | GetForceField | const [[tString]] &in asName |   |
 +| [[cForceField]]@ | GetForceFieldFromID | [[tID]] alID |   |
 +| [[cForceFieldIterator]]@ | GetForceFieldIterator |     ​| ​  |
 +| [[cParticleSystem]]@ | CreateParticleSystem | const [[tString]] &in asName, \\ const [[tString]] &in asType, \\ const [[cVector3f]] &in avSize, \\ bool abRemoveWhenDead,​ \\ bool abStatic |   |
 +| [[tID]] | CreateParticleSystemID | const [[tString]] &in asName, \\ const [[tString]] &in asType, \\ const [[cVector3f]] &in avSize, \\ bool abRemoveWhenDead,​ \\ bool abStatic |   |
 +| void | DestroyParticleSystem | [[cParticleSystem]]@ apPS |   |
 +| [[cParticleSystem]]@ | GetParticleSystem | const [[tString]] &in asName |   |
 +| [[cParticleSystem]]@ | GetParticleSystemFromID | [[tID]] alID |   |
 +| bool | ParticleSystemExists | [[cParticleSystem]]@ apPS |   |
 +| [[cParticleSystemIterator]]@ | GetParticleSystemIterator |     ​| ​  |
 +| void | DestroyAllParticleSystems |     ​| ​  |
 +| [[cEnvironmentParticles]]@ | GetEnvironmentParticles | int i |   |
 +| void | SetEnvironmentParticlesActive | bool abX |   |
 +| bool | GetEnvironmentParticlesActive |     ​| ​  |
 +| int | GetEnvironmentParticleNum |     ​| ​  |
 +| [[cBeam]]@ | CreateBeam | const [[tString]] &in asName, \\ bool abStatic |   |
 +| [[tID]] | CreateBeamID | const [[tString]] &in asName, \\ bool abStatic |   |
 +| void | DestroyBeam | [[cBeam]]@ apObject |   |
 +| [[cBeam]]@ | GetBeam | const [[tString]] &in asName |   |
 +| [[cBeam]]@ | GetBeamFromID | [[tID]] alID |   |
 +| [[cBeamIterator]]@ | GetBeamIterator |     ​| ​  |
 +| [[cGuiSetEntity]]@ | CreateGuiSetEntity | const [[tString]] &in asName, \\ [[cGuiSet]]@ apSet, \\ bool abStatic |   |
 +| [[tID]] | CreateGuiSetEntityID | const [[tString]] &in asName, \\ [[cGuiSet]]@ apSet, \\ bool abStatic |   |
 +| void | DestroyGuiSetEntity | [[cGuiSetEntity]]@ apObject |   |
 +| [[cGuiSetEntity]]@ | GetGuiSetEntity | const [[tString]] &in asName |   |
 +| [[cGuiSetEntity]]@ | GetGuiSetEntityFromID | [[tID]] alID |   |
 +| [[cGuiSetEntityIterator]]@ | GetGuiSetEntityIterator |     ​| ​  |
 +| [[iRopeEntity]]@ | CreateRopeEntity | const [[tString]] &in asName, \\ [[eRopeType]] aRopeType, \\ [[iPhysicsRope]]@ apRope, \\ int alMaxSegments,​ \\ int 3 |   |
 +| [[tID]] | CreateRopeEntityID | const [[tString]] &in asName, \\ [[eRopeType]] aRopeType, \\ [[iPhysicsRope]]@ apRope, \\ int alMaxSegments,​ \\ int 3 |   |
 +| void | DestroyRopeEntity | [[iRopeEntity]]@ apRope |   |
 +| [[iRopeEntity]]@ | GetRopeEntity | const [[tString]] &in asName |   |
 +| [[iRopeEntity]]@ | GetRopeEntityFromID | [[tID]] alID |   |
 +| [[cRopeEntityIterator]]@ | GetRopeEntityIterator |     ​| ​  |
 +| [[cClothEntity]]@ | CreateClothEntity | const [[tString]] &in asName, \\ [[iPhysicsCloth]]@ apCloth, \\ const [[tString]] &in ""​ |   |
 +| [[tID]] | CreateClothEntityID | const [[tString]] &in asName, \\ [[iPhysicsCloth]]@ apCloth, \\ const [[tString]] &in ""​ |   |
 +| void | DestroyClothEntity | [[cClothEntity]]@ apCloth |   |
 +| [[cClothEntity]]@ | GetClothEntity | const [[tString]] &in asName |   |
 +| [[cClothEntity]]@ | GetClothEntityFromID | [[tID]] alID |   |
 +| [[cClothEntityIterator]]@ | GetClothEntityIterator |     ​| ​  |
 +| [[cSoundEntity]]@ | CreateSoundEntity | const [[tString]]&​ asName, \\ const [[tString]]&​ asSoundDataFile,​ \\ bool abRemoveWhenOver |   |
 +| [[cSoundEntity]]@ | CreateSoundEntityEx | const [[tString]]&​ asName, \\ const [[tString]]&​ asSoundDataFile,​ \\ bool abRemoveWhenOver,​ \\ bool abNonBlockLoad |   |
 +| [[tID]] | CreateSoundEntityID | const [[tString]]&​ asName, \\ const [[tString]]&​ asSoundDataFile,​ \\ bool abRemoveWhenOver |   |
 +| [[tID]] | CreateSoundEntityExID | const [[tString]]&​ asName, \\ const [[tString]]&​ asSoundDataFile,​ \\ bool abRemoveWhenOver,​ \\ bool abNonBlockLoad |   |
 +| void | DestroySoundEntity | [[cSoundEntity]]@ apEntity |   |
 +| [[cSoundEntity]]@ | GetSoundEntity | const [[tString]] &in asName |   |
 +| [[cSoundEntity]]@ | GetSoundEntityFromID | [[tID]] alID |   |
 +| [[cSoundEntity]]@ | GetSoundEntityFromCreationID | int alID |   |
 +| void | DestroyAllSoundEntities |     ​| ​  |
 +| bool | SoundEntityExists | [[cSoundEntity]]@ apEntity, \\ int alCreationID |   |
 +| [[cSoundEntityIterator]]@ | GetSoundEntityIterator |     ​| ​  |
 +| bool | IsValid | [[cSoundEntity]]@ apEntity |   |
 +| void | SetDepthOfFieldActive | bool abX |   |
 +| void | SetDepthOfFieldFocusStart | float afX |   |
 +| void | SetDepthOfFieldFocusEnd | float afX |   |
 +| float | GetDepthOfFieldFocusStart |     ​| ​  |
 +| float | GetDepthOfFieldFocusEnd |     ​| ​  |
 +| bool | IsDepthOfFieldActive |     ​| ​  |
 +| void | SetDepthOfFieldBokehTexture | [[iTexture]]@ apTexture |   |
 +| [[iTexture]]@ | GetDepthOfFieldBokehTexture |     ​| ​  |
 +| void | SetDepthOfFieldFalloff | float afX |   |
 +| float | GetDepthOfFieldFalloff |     ​| ​  |
 +| void | FadeToneMappingExposure | float afX, \\ float afTime |   |
 +| void | SetToneMappingKey | float afX |   |
 +| void | FadeToneMappingWhiteCut | float afX, \\ float afTime |   |
 +| float | GetToneMappingExposure |     ​| ​  |
 +| float | GetToneMappingKey |     ​| ​  |
 +| float | GetToneMappingWhiteCut |     ​| ​  |
 +| float | GetToneMappingFadeTime |     ​| ​  |
 +| void | FadeGradingTexture | const [[tString]] &in asTexture, \\ float afTime |   |
 +| void | SetDefaultGradingTexture | [[iTexture]]@ apGrading |   |
 +| [[iTexture]]@ | GetDefaultGradingTexture |     ​| ​  |
 +| [[cExposureArea]]@ | CreateExposureArea | const [[tString]] &in asName |   |
 +| [[tID]] | CreateExposureAreaID | const [[tString]] &in asName |   |
 +| void | DestroyExposureArea | [[cExposureArea]]@ apExposureArea |   |
 +| [[cExposureArea]]@ | GetExposureArea | const [[tString]] &in asName |   |
 +| [[cExposureArea]]@ | GetExposureAreaFromID | [[tID]] alID |   |
 +| [[cExposureAreaIterator]]@ | GetExposureAreaIterator |     ​| ​  |
 +| [[cLensFlare]]@ | CreateLensFlare | const [[tString]]&​ asName, \\ const [[cVector2f]]&​ avSize, \\ const [[tString]]&​ asMaterial, \\ bool abStatic |   |
 +| [[tID]] | CreateLensFlareID | const [[tString]]&​ asName, \\ const [[cVector2f]]&​ avSize, \\ const [[tString]]&​ asMaterial, \\ bool abStatic |   |
 +| void | DestroyLensFlare | [[cLensFlare]]@ apObject |   |
 +| [[cLensFlare]]@ | GetLensFlare | const [[tString]]&​ asName |   |
 +| [[cLensFlare]]@ | GetLensFlareFromID | [[tID]] alID |   |
 +| [[cLensFlareIterator]]@ | GetLensFlareIterator |     ​| ​  |
 +
 +====Remarks====
 +
 +Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki!
  
hpl3/community/scripting/classes/cworld.txt ยท Last modified: 2015/11/05 11:31 by abion47