Cog Files


Surface Reference

Surface verbs react with the geometry surfaces. Some perform control and some are information based.

ClearAdjoinFlags
ClearFaceType
ClearSurfaceFlags
GetAdjoinFlags
GetFaceGeoMode
GetFaceLightMode
GetFaceTexMode
GetFaceType
GetNumSurfaceVertices
GetSurfaceAdjoin
GetSurfaceAnim
GetSurfaceCel
GetSurfaceCenter
GetSurfaceFlags
GetSurfaceLight
GetSurfaceMat
GetSurfaceNormal
GetSurfaceSector
GetSurfaceVertexPos
GetWallCel
SetAdjoinFlags
SetFaceGeoMode
SetFaceLightMode
SetFaceTexMode
SetFaceType
SetSurfaceCel
SetSurfaceFlags
SetSurfaceLight
SetSurfaceMat
SetWallCel
SlideSurface
SlideWall
StopSurfaceAnim
SurfaceAnim
SurfaceLightAnim


ClearAdjoinFlags() Control

Clears the specified Adjoin flags. Surface Adjoin Flags

Use: ClearAdjoinFlags(surface,flags);


ClearFaceType() Control

Clears specified Face Type flags. Face Type Flags

Use: ClearFaceType(face,flag); not used in cog, not sure.


ClearSurfaceFlags() Control

Clears the specified surface flags. Surface Flags

Use: ClearSurfaceFlags(surface,flag);


GetAdjoinFlags() Info

Gets the surface Adjoin flags. Surface Adjoin Flags

Use: Flags = GetAdjoinFlags(surface); returns set flags.


GetFaceGeoMode() Info

Gets the geometry mode of surface. Geomerty Mode Flags

Use: Modeflag = GetFaceGeoMode(surface); returns geomode flags


GetFaceLightMode() Info

Gets the lighting mode of the surface. Surface Light Mode Flags

Use: Mode = GetFaceLightMode(surface); returns light mode flag , not sure ,not used in cog


GetFaceTexMode() Info

?

? Not used


GetFaceType()

Gets Face Type flags. Face Type Flags

Use: Type = GetFaceType(face); not used in cog, not sure.


GetNumSurfaceVertices() Info

Gets the number of vertices a face has.

Use : NumVertices = GetNumSurfaceVertices(face);


GetSurfaceAdjoin()

?

? Not used


GetSurfaceAnim() Info

Gets the surface animation id. Surface Animation Flags

Use: Id = GetSurfaceAnim(surface); returns the id number of animation


GetSurfaceCel()

?

? not used


GetSurfaceCenter() Info

Gets the center of a surface.

Use: center = GetSurfaceCenter(surface); returns a vector representaion of the center of surface.


GetSurfaceFlags() Info

Gets the surface flags. Surface Flags

Use: flag = GetSurfaceFlags(surface); returns the set flags , not used in cog.


GetSurfaceLight()

?

? not used


GetSurfaceMat() Info

Gets the surface material

Use: mat = GetSurfaceMat(surface); returns surface mat ,not used in cog , not sure


GetSurfaceNormal() Info

Gets the normal of the surface.

Use: normal = GetSurfaceNormal(surface); returns a vector.


GetSurfaceSector() Info

Gets the sector surface is in.

Use: sector = GetSurfaceSector(surface); returns sector reference.


GetSurfaceVertexPos() Info

Get the position of a vertex in a face

Use : vertex = GetSurfaceVertexPos(face, vertexindex); where vertexindex is from 0 to NumVertices - 1 (as returned by GetNumSurfaceVertices())


GetWallCel() Info

Gets the Mat cel number of the surface.

Use: cellnum = GetWallCel(surface); returns the cell num (starts at 0 for multicell mats)


SetAdjoinFlags() Control

Sets the specified Adjoin flags. Surface Adjoin Flags

Use: SetAdjoinFlags(surface,flags);


SetFaceGeoMode() Control

Sets the specified geometry mode of surface. Geomerty Mode Flags

Use: GetFaceGeoMode(surface,flags);


SetFaceLightMode() Control

Sets the specified lighting mode of the surface. Surface Light Mode Flags

Use: SetFaceLightMode(surface.flags);


SetFaceTexMode()

?

? not used


SetFaceType() Control

Sets specified Face Type flags. Face Type Flags

Use: SetFaceType(face,flag);


SetSurfaceCel() Control

?

? not used


SetSurfaceFlags() Control

Sets the specified surface flags. Surface Flags

Use: SetSurfaceFlags(surface,flag);


SetSurfaceLight()

Changes the light value of a surface over time

Use: SetSurfaceLight(surface, light, fade)
fade = fade time from 0 to light value


SetSurfaceMat() Control

Sets a mat for surface.

Use: SetSurfaceMat(surface,mat);


SetWallCel() Control

Sets the surface mat to specified cel.

Use: SetWallCel(surface,cel);


SlideSurface()

?

? not used


SlideWall() Control

Moves a surface texture (scroll).

Use: SlideWall(surface,direction vector,speed );


StopSurfaceAnim() Control

Stops a surface animation . Surface Animation Flags

Use: StopSurfaceAnim(surface);


SurfaceAnim() Control

Starts a surface animation. Surface Animation Flags

Use: SurfaceAnim(surface,fps,flags);


SurfaceLightAnim() Control

Starts a light animation on the surface.

Use; SurfaceLightAnim(surf, minLight flex, maxLight, period);