Manual/Alphabetical List of Built-in Functions

From Hungrysoftware

Entries in square parentheses are old names for built-in functions which have been renamed for SLUDGE v1.3. The old names and new names for the functions are both valid - the old names appear here for the benefit of those working with example code which was written before SLUDGE v1.3 was released. It is recommended that you now use the new names for the functions as these new names are more generalised (for example, deleteFile instead of deleteGame). Also, should any error message be displayed by the engine during the execution of one of these functions, it will make reference to the new function name rather than the old one.

A

addCharacter

addOverlay

addScreenRegion

addStatus

aimCamera

alignStatus

anim

animate

B

blankArea

blankScreen

bodgeFilenames

burnString

C

cacheSound

callEvent

cancelSub

captureAllKeys

clearStatus

completeTimers

copyStack

costume

D

darkBackground

deleteAllFromStack

deleteFromStack

deleteFile [deleteGame]

dequeue

doBackgroundEffect

E

enqueue

F

fetchEvent

fileExists

floatCharacter

forceCharacter

freeSound

freeze

G

getCharacterDirection

getCharacterScale

getFramesPerSecond

getLanguageID

getMouseX

getMouseY

getMouseScreenX

getMouseScreenY

getObjectX

getObjectY

getOverObject

getMatchingFiles [getSavedGames]

getPixelColour (getPixelColor)

getSoundCache

getStatusText

H

hardScroll

hasFlag

hideCharacter

howFrozen

I

isCharacter

isMoving

isScreenRegion

J

jumpCharacter

L

launch

launchWith

lightStatus

loadCustomData

loadGame

loopSound

M

mixOverlay

moveCharacter

movieAbort

moviePlaying

movieStart

N

newStack

normalCharacter

O

onFocusChange

onKeyboard

onLeftMouse

onLeftMouseUp

onMoveMouse

onRightMouse

onRightMouseUp

P

parallaxAdd

parallaxClear

pasteCharacter

pasteImage

pasteString

pause

pickOne

playSound

popFromStack

positionStatus

pushToStack

Q

quitGame

quitWithFatalError

R

random

registryGetString

removeAllCharacters

removeAllScreenRegions

removeCharacter

removeLastStatus

removeScreenRegion

rename

renameFile [renameGame]

S

saveCustomData

saveGame

say

setBackgroundEffect

setBlankColour (setBlankColor)

setBurnColour (setBurnColor)

setCharacterAntiAliasing

setCharacterDrawMode

setCharacterExtra

setCharacterSpinSpeed

setCharacterWalkSpeed

setCostume

setCursor

setCustomEncoding

setDefaultMusicVolume

setDefaultSoundVolume

setFloor

setFont

setFontSpacing

setLightMap

setLitStatusColour (setLitStatusColor)

setMaximumAntiAliasing

setMusicVolume

setPasteColour (setPasteColor)

setScale

setSceneDimensions

setSoundLoopPoints

setSoundVolume

setStatusColour (setStatusColor)

setSpeechMode

setSpeechSpeed

setThumbnailSize

setZBuffer

showBoxes

showCharacter

showFloor

showThumbnail

skipSpeech

snapshotClear

snapshotGrab

somethingSpeaking

spawnSub

spinCharacter

stackSize

startMusic

statusText

stopCharacter

stopMusic

stopSound

stringLength

stringWidth

substring

T

think

transitionLevel

transitionMode

turnCharacter

U

unfreeze

updateDisplay

W

wait

Personal tools