Meteor 2 Scripting Functions
Legacy
void SC_PlaySound(string effectName)
Deprecated function, use playSound instead.

See also
playSound

int SC_GetSoundNumberForName(string effectName)
Deprecated function, use getSoundNumber instead.

See also
getSoundNumber

void SC_PlayDirectionalNumber(int soundNumber, int x, int y, string effectName)
Deprecated function, use playSoundNumber2D instead.

See also
playSoundNumber2D playSound2D

void SC_PlayMusic()
Deprecated function, use playMusic instead.

See also
playMusic

void SC_MusicSeekToStart()
Deprecated function, use restartMusic instead.

See also
restartMusic

void SC_StopMusic()
Deprecated function, use stopMusic instead.

See also
stopMusic

void SC_TogglePauseMusic()
Deprecated function, use pauseMusic/resumeMusic instead.

See also
pauseMusic resumeMusic isMusicPaused

void SC_AddExplosion(int x1, int y1, int w, int h, int damage, int ownerObjectId)
Deprecated function, use createExplosion instead.

Comments
For legacy support, x1 and y1 are top-left (not centre) based coodinates.

See also
createExplosion

void SC_GiveItem(string itemName, int amount)
Deprecated function, use giveItem instead.

See also
giveItem

int SC_GetItemCount(string itemName)
Deprecated function, use getItemCount instead.

See also
getItemCount

void SC_ResetAllItems(bool mapStartItemsOnly)
Deprecated function, use resetItems instead.

See also
resetItems

int SC_Random(int lower, int upper)
Deprecated function, use randomInt instead.

See also
randomInt

void SC_EndCurrentLevel()
Deprecated function, use endLevel instead.

See also
endLevel

void SC_GameOver(string message)
Deprecated function, use gameOver instead.

See also
gameOver

void SC_RunMap(string filename)
Deprecated function, use runMap instead.

See also
runMap

void SC_PlayMovieClip(string filename, string soundName)
Deprecated function, use playMovieClip instead.

See also
playMovieClip

void SC_SetSideId(uint8 sideNumber, int sideId)
Deprecated function, use setSideID instead.

See also
setSideID

int SC_AddObject(string objectName, int x, int y, float angle, uint8 aiType, uint8 side, string overrideName, bool moving, bool locked, bool multiplayerRespawn)
Deprecated function, use createObject instead.

See also
createObject

bool SC_BindObjectToWaypoint(int objectId, int waypointId)
Deprecated function, use bindToWaypoint instead.

See also
bindToWaypoint

bool SC_BindObjectToWaypointSoft(int objectId, int waypointId)
Deprecated function, use bindToWaypointSoft instead.

See also
bindToWaypointSoft

void SC_SetObjectHidden(int objectId, bool value)
Deprecated function, use setHidden instead.

See also
setHidden

bool SC_GetObjectHidden(int objectId)
Deprecated function, use getHidden instead.

See also
getHidden

void SC_ShowObjectTeleport(int objectId)
Deprecated function, use showTeleport instead.

See also
showTeleport

uint8 SC_GetObjectSide(int objectId)
Deprecated function, use getSide instead.

See also
getSide

void SC_SetObjectSide(int objectId, uint8 value)
Deprecated function, use setSide instead.

See also
setSide

void SC_GetObjectCoords(int objectId, int * x, int * y)
Deprecated function, use getPos instead.

See also
getPos

void SC_SetObjectCoords(int objectId, int x, int y)
Deprecated function, use setPos instead.

See also
setPos

float SC_GetObjectAngle(int objectId)
Deprecated function, use getDir instead.

See also
getDir

void SC_SetObjectAngle(int objectId, float angle)
Deprecated function, use setDir instead.

See also
setDir

int SC_GetObjectHits(int objectId)
Deprecated function, use getHits instead.

See also
getHits

void SC_SetObjectHits(int objectId, int hits)
Deprecated function, use setHits instead.

See also
setHits

bool SC_GetObjectIndestructible(int objectId)
Deprecated function, use getIndestructible instead.

See also
getIndestructible

void SC_SetObjectIndestructible(int objectId, bool indestructible)
Deprecated function, use setIndestructible instead.

See also
setIndestructible

int SC_GetObjectSpeed(int objectId)
Deprecated function, use getSpeed instead.

Comments
The speed will be converted to pixels per tick.

See also
getSpeed

void SC_SetObjectSpeed(int objectId, int speed)
Deprecated function, use setSpeed instead.

Comments
The speed will be converted to pixels per tick.

See also
setSpeed

int SC_GetObjectMaxSpeed(int objectId)
Deprecated function, use getMaxSpeed instead.

Comments
The speed will be converted to pixels per tick.

See also
getMaxSpeed

void SC_SetObjectMaxSpeed(int objectId, int maxSpeed)
Deprecated function, use setMaxSpeed instead.

Comments
The speed will be converted to pixels per tick (legacy system).

See also
setMaxSpeed

int SC_GetObjectDefaultMaxSpeed(int objectId)
Deprecated function, use getDefaultMaxSpeed instead.

Comments
The speed will be converted to pixels per tick.

See also
getDefaultMaxSpeed

uint8 SC_GetObjectAiType(int objectId)
Deprecated function, use getAiType instead.

See also
getAiType

void SC_SetObjectAiType(int objectId, uint8 aiType)
Deprecated function, use setAiType instead.

See also
setAiType

bool SC_GetObjectLocked(int objectId)
Deprecated function, use getLocked instead.

See also
getLocked

void SC_SetObjectLocked(int objectId, bool locked)
Deprecated function, use setLocked instead.

See also
setLocked

bool SC_GetObjectActive(int objectId)
Deprecated function, use getActive instead.

See also
getActive

void SC_SetObjectActive(int objectId, bool active)
Deprecated function, use setForceActive instead.

See also
setForceActive

bool SC_GetObjectNoTarget(int objectId)
Deprecated function, use getNoTarget instead.

See also
getNoTarget

void SC_SetObjectNoTarget(int objectId, bool noTarget)
Deprecated function, use setNoTarget instead.

See also
setNoTarget

bool SC_DoesObjectExist(int objectId)
Deprecated function, use objectExists instead.

See also
objectExists

void SC_PutObjectOnHorse(int riderObjectId, int horseObjectId)
Deprecated function, use putOnHorse instead.

See also
putOnHorse

void SC_KickObjectOffHorse(int riderObjectId)
Deprecated function, use kickOffHorse instead.

See also
kickOffHorse

void SC_ObjectHoot(int objectId)
Deprecated function, use hoot instead.

See also
hoot

string SC_GetObjectTypeNameForNumber(int objectId)
Deprecated function, use getTypeName instead.

See also
getTypeName

int SC_GetObjectTypeNumberForName(string typeName)
Deprecated function, use getTypeNameNumber instead.

See also
getTypeNameNumber

void SC_SetObjectFollow(int objectId, int objectToFollowId)
Deprecated function, use setFollow instead.

See also
setFollow

void SC_ResetObjectRespawnCoords(int objectId)
Deprecated function, use resetRespawnCoords instead.

See also
resetRespawnCoords

void SC_ShowPda()
Deprecated function, use setPdaOpen instead.

Comments
Same as using setPdaOpen(true);

See also
setPdaOpen

void SC_AddPdaMessage(string subject, string message)
Deprecated function, use addPdaMessage instead.

See also
addPdaMessage

bool SC_LoadPdaMessage(string sectionName, bool showPda)
Deprecated function, use loadPdaMessage instead.

See also
loadPdaMessage

void SC_RemovePdaMessage(string subject)
Deprecated function, use removePdaMessage instead.

See also
removePdaMessage

void SC_ClearAllPdaMessages()
Deprecated function, use clearAllPdaMessages instead.

See also
clearAllPdaMessages

void SC_PlayerGetInVehicle(int objectId)
Deprecated function, use playerGetInVehicle instead.

See also
playerGetInVehicle

void SC_PlayerGetOutOfVehicle(bool placeInCentre)
Deprecated function, use playerGetOutOfVehicle instead.

See also
playerGetOutOfVehicle

bool SC_IsPlayerInVehicle()
Deprecated function, use isPlayerInVehicle instead.

See also
isPlayerInVehicle

void SC_SetPlayerObjectId(int objectId)
Deprecated function, use setPlayerObject instead.

See also
setPlayerObject

int SC_GetPlayerObjectId()
Deprecated function, use getLocalPlayer instead.

See also
getLocalPlayer

void SC_SetPlayerInteractionEnabled(bool value)
Deprecated function, use setPlayerInteractionEnabled instead.

See also
setPlayerInteractionEnabled

bool SC_GetPlayerInteractionEnabled()
Deprecated function, use getPlayerInteractionEnabled instead.

See also
getPlayerInteractionEnabled

void SC_SetSectorTexture(int sectorId, string textureName)
Deprecated function, use setSectorTexture instead.

See also
setSectorTexture

string SC_GetSectorTexture(int sectorId)
Deprecated function, use getSectorTexture instead.

See also
getSectorTexture

void SC_SetSectorHidden(int sectorId, bool hidden)
Deprecated function, use setSectorHidden instead.

See also
setSectorHidden

bool SC_GetSectorHidden(int sectorId)
Deprecated function, use getSectorHidden instead.

See also
getSectorHidden

void SC_SetSectorTriggerEnabled(int sectorId, bool enabled)
Deprecated function, use setSectorTriggerEnabled instead.

See also
setSectorTriggerEnabled

bool SC_GetSectorTriggerEnabled(int sectorId)
Deprecated function, use getSectorTriggerEnabled instead.

See also
getSectorTriggerEnabled

void SC_OpenDoor(int sectorId)
Deprecated function, use openDoor instead.

See also
openDoor

void SC_OpenForcefield(int sectorId)
Deprecated function, use openForcefield instead.

See also
openForcefield

void SC_CloseForcefield(int sectorId, string forcefieldTextureName)
Deprecated function, use closeForcefield instead.

See also
closeForcefield

void SC_SetSectorDamage(int sectorId, int damage)
Deprecated function, use setSectorDamage instead.

See also
setSectorDamage

int SC_GetSectorDamage(int sectorId)
Deprecated function, use getSectorDamage instead.

See also
getSectorDamage

int SC_AddSprite(string spriteName, int x, int y, float angle, uint8 side)
Deprecated function, use createSprite instead.

See also
createSprite

void SC_SetSpriteHidden(int spriteId, bool hidden)
Deprecated function, use setSpriteHidden instead.

See also
setSpriteHidden

bool SC_GetSpriteHidden(int spriteId)
Deprecated function, use getSpriteHidden instead.

See also
getSpriteHidden

void SC_PassToConsole(string command)
Deprecated function, use passToConsole instead.

See also
passToConsole

void SC_MessageBox(string messageText)
Deprecated function, use messageBox instead.

See also
messageBox

void SC_GameMessage(string messageText)
Deprecated function, use gameMessage instead.

See also
gameMessage

void SC_ConsoleMessage(string messageText)
Deprecated function, use print instead.

See also
print

bool SC_StringInputBox(string str, int maxLen, string caption)
Deprecated function, use stringInputBox instead.

See also
stringInputBox

bool SC_ConfirmBox(caption title)
Deprecated function, use confirmBox instead.

See also
confirmBox

bool SC_CreateToolbar(int toolbarNumber, string title, int x, int y, bool docked, bool localOnly)
Deprecated function, use createToolbar instead.
localOnly has no effect (always true).

See also
createToolbar

void SC_DestroyToolbar(int toolbarNumber, bool localOnly)
Deprecated function, use deleteToolbar instead.
localOnly has no effect (always true).

See also
deleteToolbar

void SC_AddToolbarButton(int toolbarNumber, string caption, string imageFilename, string triggerText, bool localOnly)
Deprecated function, use addToolbarButton instead.
localOnly has no effect (always true).

See also
addToolbarButton


Index

Generated on the 23 November 2024 at 08:20:42 (UK Time)