Common python module

From WiCWiki

Jump to: navigation, search

Contents

common module

Methods

StringToInt

Syntax
import wic
wic.common.StringTiInt( aString )
Description
Returns the hash for aString.
Exceptions
-
See also
-



GetCurrentTime

Syntax
import wic
wic.common.GetCurrentTime()
Description
Retrieves the time in milliseconds since the start of the game.
Exceptions
-
See also
#GetElapsedTime
#GetRealCurrentTime
#GetRealElapsedTime



GetElapsedTime

Syntax
import wic
wic.common.GetElapsedTime()
Description
Retrieves the time in milliseconds since the last frame.
Exceptions
-
See also
#GetCurrentTime
#GetRealCurrentTime
#GetRealElapsedTime



GetRealCurrentTime

Syntax
import wic
wic.common.GetRealCurrentTime()
Description
Retrieves the unscaled time in milliseconds since the game started.
Exceptions
-
See also
#GetCurrentTime
#GetElapsedTime
#GetRealElapsedTime



GetRealElapsedTime

Syntax
import wic
wic.common.GetRealElapsedTime()
Description
Retrieves the unscaled time in milliseconds since the last frame.
Exceptions
-
See also
#GetCurrentTime
#GetRealCurrentTime
#GetRealElapsedTime



GetY

Syntax
import wic
wic.common.GetY( anXCoordinate, anYCoordinate[, anIntersectWaterFlag[, anIntersectObjectsFlag]] )
Description
Retrieves the height of the map at the coordinate given by anXCoordinate and anYCoordinate.
If anIntersectWaterFlag is set water surface will be considered.
If anIndersectObjectsFlag is set objects will be considered.
Exceptions
-
See also
-



DebugMessage

Syntax
import wic
wic.common.DebugMessage( aDebugMessage )
Description
Writes aDebugMessage to the debug log.
Exceptions
-
See also
-



GetHeadingXZ

Syntax
import wic
wic.common.GetHeadingXZ( aBasePosition, aTargetPosition )
Description
Calculates the heading between aBasePosition and aTargetPositin.
Exceptions
-
See also
-



write

Syntax
import wic
wic.common.write( aText )
Description
Used as stdout and stderr for python. Not very usable as general output.
Exceptions
-
See also
-



Random

Syntax
import wic
wic.common.Random()
Description
Generates a random fraction between 0.0 and 1.0.
Exceptions
-
See also
-



Modules


Types

Personal tools
User Created Content