SurfaceInfo Class Reference

Unmanaged surface info handle. More...

Inheritance diagram for SurfaceInfo:

Protected Member Functions
void	SurfaceInfo ()
void	~SurfaceInfo ()
proto float	GetAudability ()
proto float	GetBulletPenetrability ()
proto float	GetDeflection ()
proto float	GetDustness ()
proto string	GetEntryName ()
proto string	GetImpact ()
proto int	GetLiquidType ()
	See 'LiquidTypes' in 'constants.c'.
proto string	GetName ()
proto float	GetRoughness ()
proto string	GetSoundEnv ()
proto int	GetStepParticleId ()
	See 'ParticleList', if config entry not set, value is 'ParticleList.NONE', if config entry is set but doesn't exist, value is 'ParticleList.INVALID'.
proto string	GetSurfaceType ()
proto float	GetThickness ()
proto float	GetTransparency ()
proto int	GetWheelParticleId ()
proto bool	IsLiquid ()
proto bool	IsPassthrough ()
proto bool	IsSolid ()
proto bool	IsStairs ()

Static Protected Member Functions
static proto SurfaceInfo	GetByFile (string name)
	Warning: O(n) time complexity where n is the total number of loaded surfaces Note: Will load the surface if not loaded Warning: If the surface name is invalid, it will still create a SurfaceInfo 'CfgSurfaces' can be pathed by having the name prefixed with '#', so 'GetByFile("#cp_grass")' will return same as 'GetByName("cp_grass")'.
static proto SurfaceInfo	GetByName (string name)
	Warning: O(n) time complexity where n is the total number of loaded surfaces Note: Will load the surface if not loaded Warning: If the surface name is invalid, it will still create a SurfaceInfo.

Additional Inherited Members
Private Member Functions inherited from SurfaceProperties
void	SurfaceProperties ()
void	~SurfaceProperties ()

Detailed Description

Unmanaged surface info handle.

Provides API to surfaces that are defined as part of 'CfgSurfaces' or exist in an objects .bisurf file. Lifetime is managed in code so don't store handles of this type yourself. Any created 'SurfaceInfo' is destroyed during 'Game' ScriptModule destruction.

Definition at line 8 of file surfaceinfo.c.

Constructor & Destructor Documentation

SurfaceInfo()

void SurfaceInfo ( )

inlineprotected

Definition at line 10 of file surfaceinfo.c.

Referenced by GetByFile(), and GetByName().

~SurfaceInfo()

void ~SurfaceInfo ( )

inlineprotected

Definition at line 11 of file surfaceinfo.c.

Member Function Documentation

GetAudability()

proto float GetAudability ( )

protected

GetBulletPenetrability()

proto float GetBulletPenetrability ( )

protected

GetByFile()

proto SurfaceInfo GetByFile ( string name )

staticprotected

Warning: O(n) time complexity where n is the total number of loaded surfaces Note: Will load the surface if not loaded Warning: If the surface name is invalid, it will still create a SurfaceInfo 'CfgSurfaces' can be pathed by having the name prefixed with '#', so 'GetByFile("#cp_grass")' will return same as 'GetByName("cp_grass")'.

References SurfaceInfo(), and name.

GetByName()

proto SurfaceInfo GetByName ( string name )

staticprotected

Warning: O(n) time complexity where n is the total number of loaded surfaces Note: Will load the surface if not loaded Warning: If the surface name is invalid, it will still create a SurfaceInfo.

References SurfaceInfo(), and name.

Referenced by Surface::CheckLiquidSource(), ActionFillBottleBase::GetLiquidType(), Surface::GetStepsParticleID(), and Surface::GetWheelParticleID().

GetDeflection()

proto float GetDeflection ( )

protected

GetDustness()

proto float GetDustness ( )

protected

GetEntryName()

proto string GetEntryName ( )

protected

GetImpact()

proto string GetImpact ( )

protected

GetLiquidType()

proto int GetLiquidType ( )

protected

See 'LiquidTypes' in 'constants.c'.

Referenced by Surface::CheckLiquidSource(), and ActionFillBottleBase::GetLiquidType().

GetName()

proto string GetName ( )

protected

GetRoughness()

proto float GetRoughness ( )

protected

GetSoundEnv()

proto string GetSoundEnv ( )

protected

GetStepParticleId()

proto int GetStepParticleId ( )

protected

See 'ParticleList', if config entry not set, value is 'ParticleList.NONE', if config entry is set but doesn't exist, value is 'ParticleList.INVALID'.

Referenced by Surface::GetStepsParticleID().

GetSurfaceType()

proto string GetSurfaceType ( )

protected

GetThickness()

proto float GetThickness ( )

protected

GetTransparency()

proto float GetTransparency ( )

protected

GetWheelParticleId()

proto int GetWheelParticleId ( )

protected

Referenced by Surface::GetWheelParticleID().

IsLiquid()

proto bool IsLiquid ( )

protected

IsPassthrough()

proto bool IsPassthrough ( )

protected

IsSolid()

proto bool IsSolid ( )

protected

IsStairs()

proto bool IsStairs ( )

protected

---

The documentation for this class was generated from the following file:

• F:/Games/Dayz/scripts/3_game/surfaceinfo.c