SurfaceInfo Class Reference

Inheritance diagram for SurfaceInfo:

Protected Member Functions
void	SurfaceInfo ()
void	~SurfaceInfo ()
proto string	GetName ()
proto string	GetEntryName ()
proto string	GetSurfaceType ()
proto float	GetRoughness ()
proto float	GetDustness ()
proto float	GetBulletPenetrability ()
proto float	GetThickness ()
proto float	GetDeflection ()
proto float	GetTransparency ()
proto float	GetAudability ()
proto bool	IsLiquid ()
proto bool	IsStairs ()
proto bool	IsPassthrough ()
proto bool	IsSolid ()
proto string	GetSoundEnv ()
proto string	GetImpact ()
proto int	GetLiquidType ()
	See 'LiquidTypes' in 'constants.c'.
proto int	GetStepParticleId ()
proto int	GetWheelParticleId ()

Static Protected Member Functions
static proto SurfaceInfo	GetByName (string name)
static proto SurfaceInfo	GetByFile (string name)

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::SurfaceInfo ( )

protected

Definition at line 10 of file surfaceinfo.c.

~SurfaceInfo()

void SurfaceInfo::~SurfaceInfo ( )

protected

Definition at line 11 of file surfaceinfo.c.

Member Function Documentation

GetAudability()

proto float SurfaceInfo::GetAudability ( )

protected

GetBulletPenetrability()

proto float SurfaceInfo::GetBulletPenetrability ( )

protected

GetByFile()

static proto SurfaceInfo 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")'

GetByName()

static proto SurfaceInfo 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

GetDeflection()

proto float SurfaceInfo::GetDeflection ( )

protected

GetDustness()

proto float SurfaceInfo::GetDustness ( )

protected

GetEntryName()

proto string SurfaceInfo::GetEntryName ( )

protected

GetImpact()

proto string SurfaceInfo::GetImpact ( )

protected

GetLiquidType()

proto int SurfaceInfo::GetLiquidType ( )

protected

See 'LiquidTypes' in 'constants.c'.

GetName()

proto string SurfaceInfo::GetName ( )

protected

GetRoughness()

proto float SurfaceInfo::GetRoughness ( )

protected

GetSoundEnv()

proto string SurfaceInfo::GetSoundEnv ( )

protected

GetStepParticleId()

proto int SurfaceInfo::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'

GetSurfaceType()

proto string SurfaceInfo::GetSurfaceType ( )

protected

GetThickness()

proto float SurfaceInfo::GetThickness ( )

protected

GetTransparency()

proto float SurfaceInfo::GetTransparency ( )

protected

GetWheelParticleId()

proto int SurfaceInfo::GetWheelParticleId ( )

protected

IsLiquid()

proto bool SurfaceInfo::IsLiquid ( )

protected

IsPassthrough()

proto bool SurfaceInfo::IsPassthrough ( )

protected

IsSolid()

proto bool SurfaceInfo::IsSolid ( )

protected

IsStairs()

proto bool SurfaceInfo::IsStairs ( )

protected

---

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

• Daten/3_game/surfaceinfo.c