|
Sprite Studio API Calls
Sprite Methods
IsFramed()
ShowFrame()
HideFrame()
IsImageUsedForHitTesting()
IsFrameUsedForHitTesting()
UseFrameForHitTesting()
UseImageForHitTesting()
MakeEligibleToCollideIntoOtherSprites(state)
MakeIneligibleToCollideIntoOtherSprites()
IsEligibleToCollideIntoOtherSprites()
MakeEligibleToBeCollidedByOtherSprites(state)
MakeIneligibleToBeCollidedByOtherSprites()
IsEligibleToBeCollidedByOtherSprites()
UseFrameForCollisionDetection()
UseImageForCollisionDetection()
IsImageUsedForCollisionDetection()
IsFrameUsedForCollisionDetection()
DoesNotifyWhenCollidesIntoSprite()
DoNotifyWhenCollidesIntoSprite(state)
DoNotNotifyWhenCollidesIntoSprite()
DoesNotifyWhenCollidedIntoBySprite()
DoNotifyWhenCollidedIntoBySprite(state)
DoNotNotifyWhenCollidedIntoBySprite()
IsInView()
GetPossessingEntity(times)
DoesCollideWith(sprite, respectEligibility, respectClipping)
Duplicate()
Delete()
IsArtStripSprite()
IsShapeSprite()
IsTextSprite()
IsQuickTimeSprite()
IsImageSprite()
IsEffectSprite()
IsSizeable()
IsAdvanceable()
IsSoundSprite()
IsCaptureSprite()
IsUnderCursor(ignoreSprites, ignoreState, respectClipping)
SetFrameColor(color)
GetFrameColor()
DoesRespectParentClipping()
DoRespectParentClipping(state)
DoNotRespectParentClipping()
SetRenderStyle(style)
GetRenderStyle()
SetFootPrint(footprint)
GetFootPrint()
AdvanceableSprite Methods
MakeAbleToBeSuspended(state)
MakeUnableToBeSuspended()
IsAbleToBeSuspended()
DoesAdvanceEvenUnderCustomCircumstance()
DoAdvanceEvenUnderCustomCircumstance(state)
DoNotAdvanceEvenUnderCustomCircumstance()
IsSetToLoop()
IsSetToPlayThenPause()
SetToLoop(state)
SetToPlayThenPause()
DoesNotifyWhenAutoPauses()
DoNotifyWhenAutoPauses(state)
DoNotNotifyWhenAutoPauses()
DoesNotifyWhenLoops()
DoNotifyWhenLoops(state)
DoNotNotifyWhenLoops()
DoesNotifyOnEachFrame()
DoNotifyOnEachFrame(state)
DoNotNotifyOnEachFrame()
DoesNotifyWhenSuspends()
DoNotifyWhenSuspends(state)
DoNotNotifyWhenSuspends()
DoesNotifyWhenResumes()
DoNotifyWhenResumes(state)
DoNotNotifyWhenResumes()
EnsureThatYouWillAdvanceAtNextOpportunity()
ArtStripSprite Methods
GetCurrentFrame()
SetCurrentFrame(number)
GetStartFrame()
SetStartFrame(parameterOne, parameterTwo)
GetEndFrame()
SetEndFrame(parameterOne, parameterTwo)
GetFrameRange()
SetFrameRange(startOne, startTwo, endOne, endTwo)
DoesCastShadow()
DoCastShadow(state)
DoNotCastShadow()
MakeTimeAccurate()
MakeFrameAccurate()
IsFrameAccurate()
IsTimeAccurate()
GetAsset()
SizeableSprite Methods
GetSize()
SetSize(height, width)
GetWidth()
SetWidth(width)
GetHeight()
SetHeight(height)
ShapeSprite Methods
SetShapeColor(color)
GetShapeColor()
GetShapeStyle()
SetShapeStyle(mode)
GetShape()
SetShape(shape)
SoundSprite Methods
Play()
IsPlaying()
Stop()
CaptureSprite Methods
GenerateOutput()
GetMode()
SetMode(mode)
GetFormat()
SetFormat(format)
DiscardCapturedImages()
GetBitDepth()
SetBitDepth(depth)
GetCodec()
SetCodec(codec)
GetQuality()
SetQuality(quality)
GetFramesPerSecond()
SetFramesPerSecond(fps)
DoShowEncodeProgress(state)
DoNotShowEncodeProgress()
IsEncodeProgressShown()
DoReportEncodeErrors(state)
DoNotReportEncodeErrors()
AreEncodeErrorsReported()
DoEnforceFrameCountMaximum(state)
DoNotEnforceFrameCountMaximum()
IsFrameCountMaximumEnforced()
GetFrameCountMaximum()
SetFrameCountMaximum(max)
GetMaximumColors()
SetMaximumColors(max)
DoShowWhitePixels(state)
DoNotShowWhitePixels()
AreWhitePixelsShown()
TextSprite Methods
SetText(text)
GetText()
SetTextColor(color)
GetTextColor()
AddTextShadow()
RemoveTextShadow()
IsTextShadowed()
ProcessKeyDownEvent(event)
GetAsset()
QuickTimeSprite Methods
EnableTrack (track)
DisableTrack(track)
IsTrackEnabled(track)
EnableAllTracks()
DisableAllTracks()
IsDiscrete ()
MakeDiscrete()
MakeNonDiscrete()
GetApplicationMode()
SetApplicationMode(mode)
DoesAffectChannel(channel)
DoAffectChannel(channel)
DoNotAffectChannel(channel)
DoesUseBackdropColor()
UseBackdropColor()
UseCustomColor()
GetCustomColor()
SetCustomColor(color)
SetFootPrintRelationship(relationship)
GetFootPrintRelationship()
GetRelativeFootPrint()
SetRelativeFootPrint(footprint)
GetMovieDuration()
GetMovieTimeValue()
SetMovieTimeValue(time)
SetMovieInTimeValue(time)
GetMovieInTimeValue()
SetMovieOutTimeValue(time)
GetMovieOutTimeValue()
ImageSprite Methods
GetAsset()
DoesCastShadow()
DoCastShadow(state)
DoNotCastShadow()
GetCurrentFrame()
SetCurrentFrame(number)
EffectSprite Methods
GetEffect()
Animation Methods
IsLocationRelativeToParentAttributes()
MakeLocationRelativeToParentAttributes(state)
MakeLocationNotRelativeToParentAttributes()
AttachToCamera()
DetachFromCamera()
IsAttachedToCamera()
AttachToCursor(x, y, asCursor)
DetachFromCursor()
IsAttachedToCursor()
SetInherentLocation(x, y)
SetEffectiveLocation(x, y)
OffsetInherentLocation(x, y)
GetInherentLocation()
GetEffectiveLocation()
ConvertLocationFromInherentToEffectiveCoordinates(x, y)
ConvertLocationFromEffectiveToInherentCoordinates(x, y)
ConvertRectangleFromInherentToEffectiveCoordinates(rectangle)
ConvertRectangleFromEffectiveToInherentCoordinates(rectangle)
IsLayerRelativeToParentAttributes()
MakeLayerRelativeToParentAttributes()
MakeLayerNotRelativeToParentAttributes()
SetInherentLayer(layer)
SetEffectiveLayer(layer)
GetInherentLayer()
GetEffectiveLayer()
ConvertInherentLayerToEffectiveLayer(layer)
ConvertEffectiveLayerToInherentLayer(layer)
OffsetInherentLayer(offset)
IsOpacityRelativeToParentAttributes ()
MakeOpacityRelativeToParentAttributes(state)
MakeOpacityNotRelativeToParentAttributes()
IsEffectivelyTranslucent()
IsEffectivelyOpaque()
IsInherentlyTranslucent()
IsInherentlyOpaque()
SetInherentOpacityPercent(percent)
GetInherentOpacityPercent()
GetEffectiveOpacityPercent()
OffsetInherentOpacityPercent(offset)
IsPausedStateRelativeToParentAttributes()
MakePausedStateRelativeToParentAttributes(state)
MakePausedStateNotRelativeToParentAttributes()
IsEffectivelyPaused()
IsInherentlyPaused()
InherentlyPause()
InherentlyResume()
SetInherentPausedState(state)
IsAdvanceRateRelativeToParentAttributes()
MakeAdvanceRateRelativeToParentAttributes(state)
MakeAdvanceRateNotRelativeToParentAttributes()
SetInherentAdvanceRatePercent(percent)
GetInherentAdvanceRatePercent()
GetEffectiveAdvanceRatePercent()
OffsetInherentAdvanceRatePercent(offset)
GetInherentMillisecondsBetweenAdvances()
GetEffectiveMillisecondsBetweenAdvances()
GetInherentFramesPerSecond()
GetEffectiveFramesPerSecond()
SetInherentMillisecondsBetweenAdvances(ms)
SetInherentFramesPerSecond(fps)
IsVisibilityRelativeToParentAttributes()
MakeVisibilityRelativeToParentAttributes(state)
MakeVisibilityNotRelativeToParentAttributes()
IsInherentlyVisible()
IsEffectivelyVisible()
MakeInherentlyVisible(state)
MakeInherentlyInvisible()
SetInherentVisibilityState(state)
InherentlyShow()
InherentlyHide()
IsAcceptsMouseEventsRelativeToParentAttributes()
MakeAcceptsMouseEventsRelativeToParentAttributes(state)
MakeAcceptsMouseEventsNotRelativeToParentAttributes()
DoesInherentlyAcceptMouseEvents()
DoesEffectivelyAcceptMouseEvents()
MakeInherentlyAcceptMouseEvents(state)
MakeInherentlyNotAcceptMouseEvents()
DoesPropagateMouseEnterAndExitEvents()
DoPropagateMouseEnterAndExitEvents(state)
DoNotPropagateMouseEnterAndExitEvents()
DoesPropagateMouseDownAndUpEvents()
DoPropagateMouseDownAndUpEvents(state)
DoNotPropagateMouseDownAndUpEvents()
IsAcceptsKeyEventsRelativeToParentAttributes()
MakeAcceptsKeyEventsRelativeToParentAttributes(state)
MakeAcceptsKeyEventsNotRelativeToParentAttributes()
DoesInherentlyAcceptKeyEvents()
DoesEffectivelyAcceptKeyEvents()
MakeInherentlyAcceptKeyEvents()
MakeInherentlyNotAcceptKeyEvents()
DoesPropagateKeyEvents()
DoPropagateKeyEvents(state)
DoNotPropagateKeyEvents()
CanBeTabbedTo()
PermitBeingTabbedTo(state)
PrecludeBeingTabbedTo()
RampInherentOpacityPercentTo(to, steps, duration, timeRef, opacityMode, callback)
RampInherentLocationTo(x, y, steps, duration, timeRef, locationMode, callback)
InherentlyPauseLaterFor(inMilliseconds, forMilliseconds, timeRef, pauseMode, callback)
InherentlyPauseFor(forMilliseconds, timeRef, pauseMode, callback)
InherentlyPauseLater(inMilliseconds, timeRef, callback)
InherentlyResumeLaterFor(forMilliseconds, inMilliseconds, timeRef, resumeMode, callback)
InherentlyResumeFor(forMilliseconds, timeRef, resumeMode, callback)
InherentlyResumeLater(inMilliseconds, timeRef, callback)
IsEnabledStateRelativeToParentAttributes()
MakeEnabledStateRelativeToParentAttributes(state)
MakeEnabledStateNotRelativeToParentAttributes()
IsInherentlyEnabled()
IsEffectivelyEnabled()
InherentlyEnable()
InherentlyDisable()
SetInherentEnabledState(state)
IsInherentlyDisabled()
IsEffectivelyDisabled()
PlaySound(asset, volume, count, priority, positionally, callback)
RampInherentAdvanceRatePercentTo(to, steps, duration, timeRef, rateMode, callback)
SetAsCurrentKeyEventHandler()
GetElapsedMilliseconds()
IsVolumeRelativeToParentAttributes()
MakeVolumeRelativeToParentAttributes(state)
MakeVolumeNotRelativeToParentAttributes()
SetInherentVolumePercent(percent)
GetInherentVolumePercent()
GetEffectiveVolumePercent()
IsColorizationRelativeToParentAttributes()
MakeColorizationRelativeToParentAttributes(state)
MakeColorizationNotRelativeToParentAttributes()
IsInherentlyColorized()
IsEffectivelyColorized()
RampInherentVolumePercentTo(to, steps, duration, timeRef, rateMode, callback)
SetInherentColorizationColor(color)
GetInherentColorizationColor()
GetEffectiveColorizationColor()
SetInherentColorizationPercent(percent)
GetInherentColorizationPercent()
GetEffectiveColorizationPercent()
RampInherentColorizationPercentTo (to, steps, duration, timeRef, mode, callback)
GetBoundsInStageCoordinates()
BringToFrontOfLayer()
SetTreatAsWindowStatus(status, autoEnable)
GetTreatAsWindowStatus()
SetChildrenWindowsBaseLayerAndOffset(layer, offset)
GetChildrenWindowsBaseLayerAndOffset()
SetDepthOfChildWindow(window, depth, autoEnable)
GetDepthOfChildWindow(window)
BringChildWindowToFront(window, autoEnable)
GetChildrenWindows()
SetWindowDepth(depth, autoEnable)
GetWindowDepth()
GetEntity(path)
FindEntity(name)
GetSprite(path)
FindSprite(name)
IsAncestorOf(item)
IsDescendantOf(item)
StampIntoBackdrop()
GetHierarchyIndex()
SpriteEngine Methods
UpdateDisplay()
SetImmediateBackdropMode(mode)
GetImmediateBackdropMode()
GetSpriteCurrentlyUnderMouse()
GetSpriteCurrentlyHandlingMouseDownEvent(button)
SetImmediateDisplayUpdatesToBeMinimum()
SetImmediateDisplayUpdatesToBeMaximum ()
AreImmediateDisplayUpdatesMinimum()
AreImmediateDisplayUpdatesMaximum()
SetImmediateBackdropColor(color)
GetImmediateBackdropColor()
SetAttachedToCursorLimitRectangle(rectangle)
GetAttachedToCursorLimitRectangle()
AdvanceAllSprites(forceAdvancement)
AssumeFullScreen()
RelinquishFullScreen()
IsInFullScreenMode()
EnableAutomaticCollisionDetection()
DisableAutomaticCollisionDetection()
IsAutomaticCollisionDetectionEnabled()
SetFrequencyOfAutomaticCollisionDetection(ms)
GetFrequencyOfAutomaticCollisionDetection()
PerformCollisionDetection()
GetSpritesCollidedBySprite(sprite, max, respectEligibility, respectClipping)
DoSpritesCollide(sprite1, sprite2, respectEligibility, respectClipping)
PrintDisplay(allowUserInteraction)
SetImmediateCameraLocation(x, y)
GetImmediateCameraLocation()
OffsetImmediateCameraLocation(x, y)
GetSpriteAtLocationInStageCoordinates(before, x, y, mustBeVisible, minimumOpacity, mustAcceptMouseEvents, respectClipping)
GetEntityAtLocationInStageCoordinates(before, x, y, mustBeVisible, minimumOpacity, mustAcceptMouseEvents, respectClipping)
GetSceneAtLocationInStageCoordinates(before, x, y, mustBeVisible, minimumOpacity, mustAcceptMouseEvents, respectClipping)
SetCustomCircumstance(state)
GetCustomCircumstance()
Rectangle Methods
Set(t, l, b, r)
Offset(x, y)
Expand(x, y)
Contract(x, y)
Contains(x, y)
GetWidth()
GetHeight()
IsEmpty()
IsCoincidentTo(rectangle)
Duplicate()
SetTo(rectangle)
Intersects(rectangle)
IsEqualTo(rectangle)
SetToUnionOf(r1, r2)
SetToIntersectionOf(r1, r2)
Color Methods
Set(r, g, b)
SetTo(color)
Duplicate()
IsEqualTo(color)
BlendWith(color, percent)
Object Methods
GetObjectType()
GetObjectValue()
IsAScene()
IsAnEntity()
IsASprite()
IsEqualTo(object)
SendMessageTo(message, recipient)
SendMessageLaterTo(message, milliseconds, timeRef, recipient)
SendMessageToListeners(message)
SendMessageLaterToListeners(message, milliseconds, timeRef)
AddListener(listener)
RemoveListener(listener)
GetListeners()
SetInheritanceTable(table)
GetInheritanceTable()
System Methods
Beep()
GetQuickTimeVersion()
IsQuickTimeInstalled()
ShowCursor()
HideCursor()
IsCursorShown(value)
GetSystemInformation(date, speed)
Application Methods
Freeze(n)
BeginTiming()
EndTiming()
IsObjectStillValid(object)
IsAnObject(object)
CheckText(text)
ExecuteText(text)
GetFullPathName()
IsInForeground()
ExecuteLater(milliseconds, timeRef, callback)
PerformMaintenance(milliseconds)
CreateRichRectangle()
EnsureRectangleIsRichRectangle(r)
Quit()
SetObjectMetatable(object, table)
CreateRichColor()
EnsureColorIsRichColor(c)
setmetatable(c, ColorMetatable)
IsQuitting ()
DetermineDistance(x1, y1, x2, y2)
AttachWindowToCursor(x, y)
DetachWindowFromCursor()
IsWindowAttachedToCursor()
SetWindowLocation(x, y)
GetWindowLocation()
Project Methods
SetShadowExtents(angle, pitch, intensity, applyToFonts)
GetShadowExtents()
GetCurrentMouseLocationInCameraCoordinates()
GetCurrentMouseLocationInStageCoordinates()
Wait(milliseconds, timeRef)
SetCurrentKeyEventHandler(handler)
GetCurrentKeyEventHandler()
ProcessKeyDownEvent(event)
Idle()
Save(saveScenes, saveSceneContents)
FlushAllSounds(nonSpriteSoundsOnly)
IsFinalBuild()
ScenePossessor Methods
CountScenes()
GetNthScene(n)
GetScene(name)
CreateScene(name)
CreateDuplicateOfScene(scene)
DeleteScene(scene)
GetAllScenes()
OpenScene(name)
CloseScene(name, unload)
IsSceneOpen(name)
IsSceneClosed(name)
SaveScene(name, contentsIfLoaded)
Identity Methods
GetName()
SetName(name)
IsNamed(name)
Entity Methods
IsOnStage()
Duplicate()
GetPossessingScene()
Delete()
GetPossessingEntity(times)
Script Methods
Execute(p1, p2, p3, p4, p5, p6, p7, p8)
Enable()
Disable()
IsEnabled()
GetIdleInterval()
SetIdleInterval(milliseconds)
SpritePossessor Methods
CountSprites()
GetNthSprite(n)
CreateArtStripSprite(name, layer, visible, x, y, asset)
CreateDuplicateOfSprite(sprite)
DeleteSprite(sprite)
GetAllSprites()
CreateShapeSprite(name, layer, visible, x, y, height, width, shape, style, color)
CreateTextSprite(name, layer, visible, x, y, height, width, fontAsset, color)
CreateQuickTimeSprite(name, layer, visible, x, y, asset)
CreateImageSprite(name, layer, visible, x, y, asset)
CreateEffectSprite(name, layer, visible, x, y, effectType, effectName)
CreateSoundSprite(name, layer, visible, x, y, asset)
CreateCaptureSprite(name, layer, visible, x, y, height, width)
Clipping Methods
IsClippingRelativeToParentClipping()
MakeClippingRelativeToParentClipping(state)
MakeClippingNotRelativeToParentClipping()
IsClipRectangleRelativeToParentClipRectangle()
MakeClipRectangleRelativeToParentClipRectangle(state)
MakeClipRectangleNotRelativeToParentClipRectangle()
IsClippingInherentlyEnabled()
IsClippingEffectivelyEnabled()
InherentlyEnableClipping()
InherentlyDisableClipping()
GetInherentClipRectangle()
SetInherentClipRectangle(rectangle)
GetEffectiveClipRectangle()
OffsetInherentClipRectangle(x, y)
AttributeGroup Methods
GetName()
SetName(name)
IsNamed(name)
AttributeGroupPossessor Methods
CountCustomAttributeGroups()
GetNthCustomAttributeGroup(n)
GetCustomAttributeGroup(name)
CreateCustomAttributeGroup(name)
CreateDuplicateOfCustomAttributeGroup(name)
DeleteCustomAttributeGroup(name)
GetAttributeOfCustomAttributeGroup (groupName, path)
FindAttributeOfCustomAttributeGroup (groupName, name, recurse)
GetAttributeValueOfCustomAttributeGroup(groupName, path)
FindAttributeValueOfCustomAttributeGroup(groupName, name, recurse)
AttributesPossessor Methods
CountContainedAttributes()
CountChildrenAttributes()
GetNthChildAttribute(n)
FindAttribute(name, recurse)
GetAttribute(path)
CreateChildAttribute(name)
CreateDuplicateOfAttribute(name)
DeleteChildAttribute(name)
GetAllChildrenAttributes()
GetValueOfAttribute(path)
FindValueOfAttribute(name, recurse)
Attribute Methods
GetValueType()
SetValueType(type)
GetValue()
CanValueBeChangedByScripts()
Duplicate()
IsOptional()
IsOptedFor()
OptFor()
OptNotFor()
GetName()
SetName(name)
IsNamed(name)
Delete()
AttributeValue Methods
GetPossessingAttribute()
CanBeRetrievedAsString()
GetAsString()
CanBeSetFromString()
SetFromString()
CanBeRetrievedAsNumber()
GetAsNumber()
CanBeSetFromNumber()
SetFromNumber()
CanBeRetrievedAsBoolean()
GetAsBoolean()
CanBeSetFromBoolean()
SetFromBoolean()
Scene Methods
Open()
Close(unload)
IsOpen()
IsClosed()
Duplicate()
Delete()
LoadContents()
UnloadContents()
AreContentsLoaded()
Save(contentsIfLoaded)
HaveContentsChanged()
HaveIntrinsicDataChanged()
EntityPossessor Methods
CountEntities()
GetNthEntity(n)
CreateEntity(name)
CreateDuplicateOfEntity(entity)
DeleteEntity(entity)
GetAllEntities()
ScriptPossessor Methods
SetIdleScriptTimeReference(timeRef)
GetIdleScriptTimeReference()
ExecuteScript(name, p1, p2, p3, p4, p5, p6, p7, p8)
GetIdleScriptFrequency()
SetIdleScriptFrequency(milliseconds)
EnableScript(name)
DisableScript(name)
IsScriptEnabled(name)
GetScript(name)
ResetIdleScriptFrequency()
RequestNotificationOfNextEvent(type)
Effect Methods
GetType()
GetName()
GetParameter(parameter)
SetParameter(parameter, v1, v2, v3, v4)
BeginPointEffect(x, y)
EndPointEffect()
ImageAsset Methods
Darken(amount)
Brighten(amount)
MakeGray()
Reload()
GetNumberOfFrames()
ArtStripAsset Methods
GetNumberOfFrameLabels()
GetNthFrameLabel(n)
Reload()
GetFrameNumberOfLabel(label)
GetLabelAtFrame(frame)
EnableChannel(channel)
DisableChannel(channel)
IsChannelEnabled(channel)
GetChannelAtLocationInCameraCoordinates(x, y, frame)
DarkenAllCastMembers(amount)
BrightenAllCastMembers(amount)
MakeAllCastMemebersGray()
GetNumberOfFrames()
IsFrameEmpty(frame)
IsLastFrame (frame)
GetFrameNumberOfLastDefinedFrameStartingFrom(frame)
GetFrameNumberOfFirstEmptyFrameStartingFrom(frame)
FontAsset Methods
GetMetrics()
GetTextExtent(text, maximumWidth)
Stage Methods
CountDisplaySettings()
GetIndexOfDisplaySettingInUse()
IsNthDisplaySettingEnabled(n)
EnableNthDisplaySetting(n)
DisableNthDisplaySetting(n)
GetNthDisplaySetting(n)
SetNthDisplaySetting(n, setting)
SetInitialBackdropMode(mode)
GetInitialBackdropMode()
SetInitialBackdropColor(color)
GetInitialBackdropColor()
SetAnimationBounds(bounds)
GetAnimationBounds()
SetInitialDisplayUpdatesToBeMinimum ()
SetInitialDisplayUpdatesToBeMaximum ()
AreInitialDisplayUpdatesMinimum()
AreInitialDisplayUpdatesMaximum()
|
|
|
