Difference between revisions of "HPL3/SOMA/Scripting/cWorld"
Jump to navigation
Jump to search
(Created page with "{{ScriptingStub}} Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki! ==Fields== cWorld has no public fields. ==Functions...") |
|||
Line 416: | Line 416: | ||
| <syntaxhighlight lang="c++" inline>void</syntaxhighlight> || Update || <syntaxhighlight lang="c++" inline>float afTimeStep</syntaxhighlight> || | | <syntaxhighlight lang="c++" inline>void</syntaxhighlight> || Update || <syntaxhighlight lang="c++" inline>float afTimeStep</syntaxhighlight> || | ||
|} | |} | ||
+ | |||
+ | {{ReferencesSection}} | ||
{{HPL3SOMAScriptingCategories}} | {{HPL3SOMAScriptingCategories}} | ||
__FORCETOC__ | __FORCETOC__ |
Latest revision as of 16:31, 6 August 2020
![]() |
This page has been automatically generated, but it needs descriptions added to the various fields/functions in order to be complete. |
Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki!
Contents
Fields
cWorld has no public fields.
Functions
Return Type | Function Name | Parameters | Description |
---|---|---|---|
void |
AddBillboardToGroup | cBillboard@ apObject ,cBillboardGroup@ apGroup |
|
void |
Compile | bool abCalcPhysicsWorldSize |
|
cBeam@ |
CreateBeam | const tString &in asName ,bool abStatic |
|
tID |
CreateBeamID | const tString &in asName ,bool abStatic |
|
cBillboard@ |
CreateBillboard | const tString &in asName ,const cVector2f &in avSize ,eBillboardType aType ,const tString &in asMaterial ,bool abStatic |
|
cBillboardGroup@ |
CreateBillboardGroup | const tString &in asName ,const tString &in asMaterial ,bool abStatic |
|
tID |
CreateBillboardGroupID | const tString &in asName ,const tString &in asMaterial ,bool abStatic |
|
tID |
CreateBillboardID | const tString &in asName ,const cVector2f &in avSize ,eBillboardType aType ,const tString &in asMaterial ,bool abStatic |
|
cClothEntity@ |
CreateClothEntity | const tString &in asName ,iPhysicsCloth@ apCloth ,const tString &in asMaterial = "" |
|
tID |
CreateClothEntityID | const tString &in asName ,iPhysicsCloth@ apCloth ,const tString &in asMaterial = "" |
|
cExposureArea@ |
CreateExposureArea | const tString &in asName |
|
tID |
CreateExposureAreaID | const tString &in asName |
|
cFogArea@ |
CreateFogArea | const tString &in asName ,bool abStatic |
|
tID |
CreateFogAreaID | const tString &in asName ,bool abStatic |
|
cForceField@ |
CreateForceField | const tString &in asName ,bool abAutoRemove ,bool abStatic |
|
tID |
CreateForceFieldID | const tString &in asName ,bool abAutoRemove ,bool abStatic |
|
cGuiSetEntity@ |
CreateGuiSetEntity | const tString &in asName ,cGuiSet@ apSet ,bool abStatic |
|
tID |
CreateGuiSetEntityID | const tString &in asName ,cGuiSet@ apSet ,bool abStatic |
|
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 |
|
cLightBox@ |
CreateLightBox | const tString& asName ,bool abStatic |
|
tID |
CreateLightBoxID | const tString& asName ,bool abStatic |
|
cLightPoint@ |
CreateLightPoint | const tString& asName ,const tString& asGobo ,bool abStatic |
|
tID |
CreateLightPointID | const tString& asName ,const tString& asGobo ,bool abStatic |
|
cLightSpot@ |
CreateLightSpot | const tString& asName ,const tString& asGobo ,bool abStatic |
|
tID |
CreateLightSpotID | const tString& asName ,const tString& asGobo ,bool abStatic |
|
cMeshEntity@ |
CreateMeshEntity | const tString& asName ,cMesh@ apMesh ,bool abStatic |
|
tID |
CreateMeshEntityID | const tString& asName ,cMesh@ apMesh ,bool abStatic |
|
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 |
|
iRopeEntity@ |
CreateRopeEntity | const tString &in asName ,eRopeType aRopeType ,iPhysicsRope@ apRope ,int alMaxSegments ,int alRingSegments = 3 |
|
tID |
CreateRopeEntityID | const tString &in asName ,eRopeType aRopeType ,iPhysicsRope@ apRope ,int alMaxSegments ,int alRingSegments = 3 |
|
cSoundEntity@ |
CreateSoundEntity | const tString& asName ,const tString& asSoundDataFile ,bool abRemoveWhenOver |
|
cSoundEntity@ |
CreateSoundEntityEx | const tString& asName ,const tString& asSoundDataFile ,bool abRemoveWhenOver ,bool abNonBlockLoad |
|
tID |
CreateSoundEntityExID | const tString& asName ,const tString& asSoundDataFile ,bool abRemoveWhenOver ,bool abNonBlockLoad |
|
tID |
CreateSoundEntityID | const tString& asName ,const tString& asSoundDataFile ,bool abRemoveWhenOver |
|
void |
DestroyAllParticleSystems | ||
void |
DestroyAllSoundEntities | ||
void |
DestroyBeam | cBeam@ apObject |
|
void |
DestroyBillboard | cBillboard@ apObject |
|
void |
DestroyBillboardGroup | cBillboardGroup@ apObject |
|
void |
DestroyClothEntity | cClothEntity@ apCloth |
|
void |
DestroyExposureArea | cExposureArea@ apExposureArea |
|
void |
DestroyFogArea | cFogArea@ apFogArea |
|
void |
DestroyForceField | cForceField@ apForce |
|
void |
DestroyGuiSetEntity | cGuiSetEntity@ apObject |
|
void |
DestroyLensFlare | cLensFlare@ apObject |
|
void |
DestroyLight | iLight@ apLight |
|
void |
DestroyMeshEntity | cMeshEntity@ apMesh |
|
void |
DestroyParticleSystem | cParticleSystem@ apPS |
|
void |
DestroyRopeEntity | iRopeEntity@ apRope |
|
void |
DestroySoundEntity | cSoundEntity@ apEntity |
|
void |
FadeGradingTexture | const tString &in asTexture ,float afTime |
|
void |
FadeInIrradianceSet | const tString &in asSetName ,float afTime |
|
void |
FadeToneMappingExposure | float afX ,float afTime |
|
void |
FadeToneMappingWhiteCut | float afX ,float afTime |
|
cBeam@ |
GetBeam | const tString &in asName |
|
cBeam@ |
GetBeamFromID | tID alID |
|
cBeamIterator@ |
GetBeamIterator | ||
cBillboard@ |
GetBillboard | const tString &in asName |
|
cBillboard@ |
GetBillboardFromID | tID alID |
|
cBillboardGroup@ |
GetBillboardGroup | const tString &in asName |
|
cBillboardGroup@ |
GetBillboardGroupFromID | tID alID |
|
cBillboardGroupIterator@ |
GetBillboardGroupIterator | ||
cBillboardIterator@ |
GetBillboardIterator | ||
cClothEntity@ |
GetClothEntity | const tString &in asName |
|
cClothEntity@ |
GetClothEntityFromID | tID alID |
|
cClothEntityIterator@ |
GetClothEntityIterator | ||
eIDSpace |
GetCurrentIDSpace | ||
iTexture@ |
GetDefaultGradingTexture | ||
iTexture@ |
GetDepthOfFieldBokehTexture | ||
float |
GetDepthOfFieldFalloff | ||
float |
GetDepthOfFieldFocusEnd | ||
float |
GetDepthOfFieldFocusStart | ||
cLightDirectional@ |
GetDirectionalLight | ||
bool |
GetDirectionalLightActive | ||
bool |
GetDistanceCullActive | ||
float |
GetDistanceCullFadeSpeed | ||
float |
GetDistanceCullMaxRange | ||
float |
GetDistanceCullMinRange | ||
float |
GetDistanceCullRandomSize | ||
float |
GetDistanceCullScreenSize | ||
cMeshEntity@ |
GetDynamicMeshEntity | const tString &in asName |
|
cMeshEntityIterator@ |
GetDynamicMeshEntityIterator | ||
iEntity3D@ |
GetEntityFromID | tID aID |
|
int |
GetEnvironmentParticleNum | ||
cEnvironmentParticles@ |
GetEnvironmentParticles | int i |
|
bool |
GetEnvironmentParticlesActive | ||
cExposureArea@ |
GetExposureArea | const tString &in asName |
|
cExposureArea@ |
GetExposureAreaFromID | tID alID |
|
cExposureAreaIterator@ |
GetExposureAreaIterator | ||
bool |
GetFogActive | ||
bool |
GetFogApplyAfterFogAreas | ||
cFogArea@ |
GetFogArea | const tString &in asName |
|
cFogArea@ |
GetFogAreaFromID | tID alID |
|
cFogAreaIterator@ |
GetFogAreaIterator | ||
float |
GetFogBrightness | ||
const cColor& |
GetFogColor | ||
bool |
GetFogCulling | ||
float |
GetFogEnd | ||
float |
GetFogFalloffExp | ||
iTexture@ |
GetFogSkyboxTexture | ||
float |
GetFogStart | ||
bool |
GetFogUnderwater | ||
bool |
GetFogUseSkybox | ||
cForceField@ |
GetForceField | const tString &in asName |
|
cForceField@ |
GetForceFieldFromID | tID alID |
|
cForceFieldIterator@ |
GetForceFieldIterator | ||
cGuiSetEntity@ |
GetGuiSetEntity | const tString &in asName |
|
cGuiSetEntity@ |
GetGuiSetEntityFromID | tID alID |
|
cGuiSetEntityIterator@ |
GetGuiSetEntityIterator | ||
cLensFlare@ |
GetLensFlare | const tString& asName |
|
cLensFlare@ |
GetLensFlareFromID | tID alID |
|
cLensFlareIterator@ |
GetLensFlareIterator | ||
iLight@ |
GetLight | const tString &in asName |
|
iLight@ |
GetLightFromID | tID aID |
|
cLightListIterator@ |
GetLightIterator | ||
cLightMaskBoxListIterator@ |
GetLightMaskBoxIterator | ||
cMeshEntity@ |
GetMeshEntityFromID | tID aID |
|
tString |
GetName | ||
cParticleSystem@ |
GetParticleSystem | const tString &in asName |
|
cParticleSystem@ |
GetParticleSystemFromID | tID alID |
|
cParticleSystemIterator@ |
GetParticleSystemIterator | ||
iPhysicsWorld@ |
GetPhysicsWorld | ||
iRopeEntity@ |
GetRopeEntity | const tString &in asName |
|
iRopeEntity@ |
GetRopeEntityFromID | tID alID |
|
cRopeEntityIterator@ |
GetRopeEntityIterator | ||
bool |
GetSecondaryFogActive | ||
float |
GetSecondaryFogBrightness | ||
const cColor& |
GetSecondaryFogColor | ||
float |
GetSecondaryFogEnd | ||
float |
GetSecondaryFogFalloffExp | ||
float |
GetSecondaryFogStart | ||
bool |
GetSkyBoxActive | ||
float |
GetSkyBoxBrightness | ||
const cColor& |
GetSkyBoxColor | ||
iTexture@ |
GetSkyBoxTexture | ||
iVertexBuffer@ |
GetSkyBoxVertexBuffer | ||
cSoundEntity@ |
GetSoundEntity | const tString &in asName |
|
cSoundEntity@ |
GetSoundEntityFromCreationID | int alID |
|
cSoundEntity@ |
GetSoundEntityFromID | tID alID |
|
cSoundEntityIterator@ |
GetSoundEntityIterator | ||
cMeshEntityIterator@ |
GetStaticMeshEntityIterator | ||
cSubMeshEntity@ |
GetSubMeshEntityFromID | tID aID |
|
void |
GetSubMeshEntityInArea | ,const cVector3f &in avMin ,const cVector3f &in avMax |
|
cTerrain@ |
GetTerrain | ||
bool |
GetTerrainActive | ||
float |
GetToneMappingExposure | ||
float |
GetToneMappingFadeTime | ||
float |
GetToneMappingKey | ||
float |
GetToneMappingWhiteCut | ||
const cVector3f& |
GetWorldSize | ||
bool |
IsActive | ||
bool |
IsDepthOfFieldActive | ||
bool |
IsValid | cSoundEntity@ apEntity |
|
bool |
ParticleSystemExists | cParticleSystem@ apPS |
|
void |
RemoveBillboardFromGroup | cBillboard@ apObject ,cBillboardGroup@ apGroup |
|
void |
SetActive | bool abX |
|
void |
SetCurrentIDSpace | eIDSpace aSpace |
|
void |
SetDefaultGradingTexture | iTexture@ apGrading |
|
void |
SetDepthOfFieldActive | bool abX |
|
void |
SetDepthOfFieldBokehTexture | iTexture@ apTexture |
|
void |
SetDepthOfFieldFalloff | float afX |
|
void |
SetDepthOfFieldFocusEnd | float afX |
|
void |
SetDepthOfFieldFocusStart | float afX |
|
void |
SetDirectionalLightActive | bool abX |
|
void |
SetDistanceCullActive | bool abX |
|
void |
SetDistanceCullFadeSpeed | float afX |
|
void |
SetDistanceCullMaxRange | float afX |
|
void |
SetDistanceCullMinRange | float afX |
|
void |
SetDistanceCullRandomSize | float afX |
|
void |
SetDistanceCullScreenSize | float afX |
|
tID |
SetEntityID | iEntity3D@ apEntity ,tID alID |
|
tID |
SetEntityID | iEntity3D@ apEntity ,eIDSpace aSpace ,uint alLocation ,uint alInner |
|
void |
SetEnvironmentParticlesActive | bool abX |
|
void |
SetFogActive | bool abX |
|
void |
SetFogApplyAfterFogAreas | bool abX |
|
void |
SetFogBrightness | float afX |
|
void |
SetFogColor | const cColor &in aCol |
|
void |
SetFogCulling | bool abX |
|
void |
SetFogEnd | float afX |
|
void |
SetFogFalloffExp | float afX |
|
void |
SetFogSkyboxTexture | iTexture@ apTexture |
|
void |
SetFogStart | float afX |
|
void |
SetFogUnderwater | bool abX |
|
void |
SetFogUseSkybox | bool abX |
|
void |
SetMainRenderableContainerVisible | bool abX |
|
void |
SetPhysicsWorld | iPhysicsWorld@ apWorld ,bool abAutoDelete |
|
void |
SetSecondaryFogActive | bool abX |
|
void |
SetSecondaryFogBrightness | float afX |
|
void |
SetSecondaryFogColor | const cColor &in aCol |
|
void |
SetSecondaryFogEnd | float afX |
|
void |
SetSecondaryFogFalloffExp | float afX |
|
void |
SetSecondaryFogStart | float afX |
|
void |
SetSkyBox | iTexture@ apTexture ,bool abAutoDestroy |
|
void |
SetSkyBoxActive | bool abX |
|
void |
SetSkyBoxBrightness | float afX |
|
void |
SetSkyBoxColor | const cColor &in aColor |
|
void |
SetTerrainActive | bool abX |
|
void |
SetToneMappingKey | float afX |
|
bool |
SoundEntityExists | cSoundEntity@ apEntity ,int alCreationID |
|
void |
Update | float afTimeStep |
References
- HPL3/SOMA/Scripting/cLuxMap (← links)
- HPL3/SOMA/Scripting/cViewport (← links)
- HPL3/SOMA/Scripting/iScrAgent Interface (← links)
- HPL3/SOMA/Scripting/iScrArea Interface (← links)
- HPL3/SOMA/Scripting/iScrCritter Interface (← links)
- HPL3/SOMA/Scripting/iScrLiquidArea Interface (← links)
- HPL3/SOMA/Scripting/iScrProp Interface (← links)
- HPL3/SOMA/Scripting/Scripting Api (← links)
- HPL3/SOMA/Scripting/Scripting Api/cScene (← links)