SCUMM Revisited
Last update: Sunday, September 02, 2001

Hosted by:
| Lucas Arts Adventure Super site |
----

Main
News
SR3
Warning
Features
FAQ
History
Download
Forum
Secrets
Articles
Specs
Thanks
Help
Links

Community
| |
----

GRIME Script Functions

Following is a total list of script function names and identifiers defined by GRIME. In addition to these are the internal Lua functions and identifiers. Notice that Lua is case sensitive.

GRIME functions
EnumerateVideoDevices
Enumerate3DDevices
SetHardwareState
SetVideoDevices
GetVideoDevices
Is3DHardwareEnabled
PurgePrimitiveQueue
KillPrimitive
ChangePrimitive
DrawRectangle
DrawPolygon
DrawLine
SetOffscreenTextPos
SetEmergencyFont
LocalizeString
GetTextCharPosition
GetTranslationMode
SetTranslationMode
GetColorComponents
MakeColor
PurgeText
ExpireText
BlastText
KillTextObject
ChangeTextObject
GetFontDimensions
GetTextObjectDimensions
MakeTextObject
PrintLine
SayLine
GetActorTalkColor
SetActorTalkColor
SetSayLineDefaults
IsMessageGoing
GetSmushLength
GetKeyLength
GetMemoryUsage
RestoreIMuse
SaveIMuse
SetWalkSystemFadeTime
GetDiskFreeSpace
SetActorInvClipNode
NukeResources
GetShrinkPos
UnShrinkBoxes
ShrinkBoxes
RestoreCache
BuildCache
ResetTextures
DumpMemoryLog
JustLoaded
ActorVoiceIs3D
GetTickCount
ActorPuckOrient
TEST
GetSoundParameters
SetSoundParameters
AttachToResources
DetachFromResources
FindFileOnAnyCD
GetTextSpeed
SetTextSpeed
GetSaveGameData
SubmitSaveGameData
BlastRect
BlastImage
FreeImage
GetImage
GetSaveGameImage
SaveScreen
ScreenShot
TextFileGetLine
TextFileGetLineCount
IrisClear
IrisComplete
IrisUp
IrisDown
FadeInChore
FadeOutChore
SetActorClipPlane
SetActorClipActive
HardwareAccelerated
ResReport
RestoreCacheRect
CacheRect
MarkDirtyRect
SetActorCollisionScale
SetActorCollisionMode
FlushControls
ActorToClean
SendObjectToFront
SendObjectToBack
SetObjectType
FreeObjectState
NewObjectState
SetActorShadowValid
AddShadowPlane
KillActorShadows
ActorDistToShadowPlane
SetActiveShadow
SetActorShadowPoint
SetActorShadowPlane
ActorShadow
ActivateActorShadow
SetShadowColor
GetSpeechMode
SetSpeechMode
Display
CleanBuffer
DimRegion
DimScreen
ForceRefresh
RenderModeUser
SetActorConstrain
SetActorWalkDominate
SetGamma
UnloadBundle
LoadBundle
ImGetSoundCacheSize
ImGetMemoryFootprint
ImSetVoiceEffect
vfx
ImResume
ImPause
ImSetCuePoint
ImSetAttribute
ImSetSequence
ImSetState
ImStopVoice
ImStartVoice
ImSetMusicVol
ImGetMusicVol
ImSetVoiceVol
ImGetVoiceVol
ImSetSfxVol
ImGetSfxVol
ImSetMasterVol
ImGetMasterVol
ImFadeParam
ImSetParam
ImGetParam
quiet
ImStopAllSounds
ImStopSound
play
ImStartSound
ImStopRecording
ImStartRecording
LightMgrSetChange
LightMgrShutdown
LightMgrStartup
PointLightAt
GetLightIntensity
SetLightIntensity
GetLightAngles
SetLightAngles
GetLightRotation
SetLightRotation
GetLightPosition
SetLightPosition
GetLightType
SetLightType
IsLightOn
TurnLightOn
FindLight
SetAmbientLight
GetAngleBetweenActors
GetAngleBetweenVectors
SnapToPlane
PerSecond
TurnActorTo
PointActorAt
GetCameraLookVector
SetCameraRoll
GetCameraRoll
SetCameraFOV
GetCameraFOV
SetCameraInterest
GetCameraInterest
SetCameraPosition
GetCameraPosition
RotateVector
SetMemoryUsage
GetPhysicalBytes
LoadCostume
PopActorCostume
PushActorCostume
PrintActorCostumes
GetCurrentScript
SpewShutdown
SpewStartup
PreRender
MakeSectorActive
IsSectorActive
GetSectorOppositeEdge
GetSectorVertices
ReadRegistryValue
WriteRegistryValue
QueryDialog
InputDialog
FileFindDispose
FileFindNext
FileFindFirst
SetSoundPosition
IsSoundPlaying
PlaySoundAttached
PlaySoundAt
PlaySound
IsMoviePlaying
PauseMovie
StopMovie
StartMovie
IsFullscreenMoviePlaying
StartFullscreenMovie
PreviousSetup
NextSetup
GetCurrentSetup
MakeCurrentSetup
UnLockSet
LockSet
MakeCurrentSet
PrintDebug
PrintWarning
PrintError
PrintMessage
GetControlState
DisableControl
EnableControl
UnlockCostume
LockCostume
UnlockSound
LockSound
UnLockFont
LockFont
EnableDebugKeys
FunctionName
ScreenToWorld
WorldToScreen
GetActorCostumeDepth
GetActorLoopingChores
GetActorChores
SetActorChoreLooping
IsActorResting
IsActorChoring
IsActorMoving
CompleteActorChore
StopActorChore
PlayActorChoreLooping
PlayActorChore
IsActorTurning
SetActorRoll
SetActorPitch
SetActorRot
GetActorRot
TurnActor
GetPointSector
IsPointInSector
GetActorSector
IsActorInSector
SetActorFrustrumCull
ShutUpActor
SetActorFollowBoxes
SetActorVisibility
SetActorHead
GetCameraActor
GetVisibleThings
CanActorSee
GetActorLookRate
SetActorLookRate
IsActorLooking
ActorLookAt
WalkActorToInterest
WalkActorToAvoiding
WalkActorTo
DriveActorTo
WalkActorForward
WalkActorVector
GetClippedPos
PutActorInSet
PutActorAt
PutActorAtOrigin
PutActorAtInterest
SetActorOffsetYaw
SetActorReflection
GetActorYawToPoint
GetActorPuckVector
GetActorRect
GetActorPos
LoadActor
SetSelectedActor
GetActorTurnRate
SetActorTurnRate
GetActorWalkRate
SetActorWalkRate
SetActorTalkChore
SetActorMumblechore
SetActorRestChore
SetActorTurnChores
SetActorWalkChore
GetActorNodeLocation
SetActorTimeScale
GetActorTimeScale
SetActorScale
GetActorScale
SetActorCostume
GetActorCostume
SetActorColormap
Save
Load
CheckForFile
SearchForFileOrSwapCDs
EngineDisplay
EngineResume
EnginePause

system.buttonHandler
system.camChangeHandler
system.axisHandler

Tables
system
system.controls

Constants
HOT = 32768
SPECIAL = 16384
CAMERA = 8192
WALK = 4096
NONE = 0

system.controls.KEY_ESCAPE = 0
system.controls.KEY_1 = 1
system.controls.KEY_2 = 2
system.controls.KEY_3 = 3
system.controls.KEY_4 = 4
system.controls.KEY_5 = 5
system.controls.KEY_6 = 6
system.controls.KEY_7 = 7
system.controls.KEY_8 = 8
system.controls.KEY_9 = 9
system.controls.KEY_0 = 10
system.controls.KEY_MINUS = 11
system.controls.KEY_EQUALS = 12
system.controls.KEY_BACK = 13
system.controls.KEY_TAB = 14
system.controls.KEY_Q = 15
system.controls.KEY_W = 16
system.controls.KEY_E = 17
system.controls.KEY_R = 18
system.controls.KEY_T = 19
system.controls.KEY_Y = 20
system.controls.KEY_U = 21
system.controls.KEY_I = 22
system.controls.KEY_O = 23
system.controls.KEY_P = 24
system.controls.KEY_LBRACKET = 25
system.controls.KEY_RBRACKET = 26
system.controls.KEY_RETURN = 27
system.controls.KEY_LCONTROL = 28
system.controls.KEY_A = 29
system.controls.KEY_S = 30
system.controls.KEY_D = 31
system.controls.KEY_F = 32
system.controls.KEY_G = 33
system.controls.KEY_H = 34
system.controls.KEY_J = 35
system.controls.KEY_K = 36
system.controls.KEY_L = 37
system.controls.KEY_SEMICOLON = 38
system.controls.KEY_APOSTROPHE = 39
system.controls.KEY_GRAVE = 40
system.controls.KEY_LSHIFT = 41
system.controls.KEY_BACKSLASH = 42
system.controls.KEY_Z = 43
system.controls.KEY_X = 44
system.controls.KEY_C = 45
system.controls.KEY_V = 46
system.controls.KEY_B = 47
system.controls.KEY_N = 48
system.controls.KEY_M = 49
system.controls.KEY_COMMA = 50
system.controls.KEY_PERIOD = 51
system.controls.KEY_SLASH = 52
system.controls.KEY_RSHIFT = 53
system.controls.KEY_MULTIPLY = 54
system.controls.KEY_LMENU = 55
system.controls.KEY_SPACE = 56
system.controls.KEY_CAPITAL = 57
system.controls.KEY_F1 = 58
system.controls.KEY_F2 = 59
system.controls.KEY_F3 = 60
system.controls.KEY_F4 = 61
system.controls.KEY_F5 = 62
system.controls.KEY_F6 = 63
system.controls.KEY_F7 = 64
system.controls.KEY_F8 = 65
system.controls.KEY_F9 = 66
system.controls.KEY_F10 = 67
system.controls.KEY_NUMLOCK = 68
system.controls.KEY_SCROLL = 69
system.controls.KEY_NUMPAD7 = 70
system.controls.KEY_NUMPAD8 = 71
system.controls.KEY_NUMPAD9 = 72
system.controls.KEY_SUBTRACT = 73
system.controls.KEY_NUMPAD4 = 74
system.controls.KEY_NUMPAD5 = 75
system.controls.KEY_NUMPAD6 = 76
system.controls.KEY_ADD = 77
system.controls.KEY_NUMPAD1 = 78
system.controls.KEY_NUMPAD2 = 79
system.controls.KEY_NUMPAD3 = 80
system.controls.KEY_NUMPAD0 = 81
system.controls.KEY_DECIMAL = 82
system.controls.KEY_F11 = 83
system.controls.KEY_F12 = 84
system.controls.KEY_F13 = 85
system.controls.KEY_F14 = 86
system.controls.KEY_F15 = 87
system.controls.KEY_KANA = 88
system.controls.KEY_CONVERT = 89
system.controls.KEY_NOCONVERT = 90
system.controls.KEY_YEN = 91
system.controls.KEY_NUMPADEQUALS = 92
system.controls.KEY_CIRCUMFLEX = 93
system.controls.KEY_AT = 94
system.controls.KEY_COLON = 95
system.controls.KEY_UNDERLINE = 96
system.controls.KEY_KANJI = 97
system.controls.KEY_STOP = 98
system.controls.KEY_AX = 99
system.controls.KEY_UNLABELED = 100
system.controls.KEY_NUMPADENTER = 101
system.controls.KEY_RCONTROL = 102
system.controls.KEY_NUMPADCOMMA = 103
system.controls.KEY_DIVIDE = 104
system.controls.KEY_SYSRQ = 105
system.controls.KEY_RMENU = 106
system.controls.KEY_HOME = 107
system.controls.KEY_UP = 108
system.controls.KEY_PRIOR = 109
system.controls.KEY_LEFT = 110
system.controls.KEY_RIGHT = 111
system.controls.KEY_END = 112
system.controls.KEY_DOWN = 113
system.controls.KEY_NEXT = 114
system.controls.KEY_INSERT = 115
system.controls.KEY_DELETE = 116
system.controls.KEY_LWIN = 117
system.controls.KEY_RWIN = 118
system.controls.KEY_APPS = 119
system.controls.KEY_JOY1_B1 = 120
system.controls.KEY_JOY1_B2 = 121
system.controls.KEY_JOY1_B3 = 122
system.controls.KEY_JOY1_B4 = 123
system.controls.KEY_JOY1_B5 = 124
system.controls.KEY_JOY1_B6 = 125
system.controls.KEY_JOY1_B7 = 126
system.controls.KEY_JOY1_B8 = 127
system.controls.KEY_JOY1_B9 = 128
system.controls.KEY_JOY1_B10 = 129
system.controls.KEY_JOY1_HLEFT = 130
system.controls.KEY_JOY1_HUP = 131
system.controls.KEY_JOY1_HRIGHT = 132
system.controls.KEY_JOY1_HDOWN = 133
system.controls.KEY_JOY2_B1 = 134
system.controls.KEY_JOY2_B2 = 135
system.controls.KEY_JOY2_B3 = 136
system.controls.KEY_JOY2_B4 = 137
system.controls.KEY_JOY2_B5 = 138
system.controls.KEY_JOY2_B6 = 139
system.controls.KEY_JOY2_B7 = 140
system.controls.KEY_JOY2_B8 = 141
system.controls.KEY_JOY2_B9 = 142
system.controls.KEY_JOY2_B10 = 143
system.controls.KEY_JOY2_HLEFT = 144
system.controls.KEY_JOY2_HUP = 145
system.controls.KEY_JOY2_HRIGHT = 146
system.controls.KEY_JOY2_HDOWN = 147
system.controls.KEY_MOUSE_B1 = 148
system.controls.KEY_MOUSE_B2 = 149
system.controls.KEY_MOUSE_B3 = 150
system.controls.KEY_MOUSE_B4 = 151
system.controls.AXIS_JOY1_X = 152
system.controls.AXIS_JOY1_Y = 153
system.controls.AXIS_JOY1_Z = 154
system.controls.AXIS_JOY1_R = 155
system.controls.AXIS_JOY1_U = 156
system.controls.AXIS_JOY1_V = 157
system.controls.AXIS_JOY2_X = 158
system.controls.AXIS_JOY2_Y = 159
system.controls.AXIS_JOY2_Z = 160
system.controls.AXIS_JOY2_R = 161
system.controls.AXIS_JOY2_U = 162
system.controls.AXIS_JOY2_V = 163
system.controls.AXIS_MOUSE_X = 164
system.controls.AXIS_MOUSE_Y = 165
system.controls.AXIS_MOUSE_Z = 166