Initializes the engine. Once initialized, StartLoop can be called to start the game loop and raise events. AnimationSmoothness: A value between 1 (animations may be choppy but the elapsed time given by the events is accurate) and 20 (animations are very smooth but the elapsed time is averaged, and thus not accurate). 10 should be fine for most cases.
InputAssgeInput [read only]
Returns the input instance.
IsInitializedAsBoolean
IsLoopRunningAsBoolean
Returns whether the game loop is running.
LeftAsDouble
MouseCursorAsjavafx.scene.Cursor
ParentAsConcreteNodeWrapper [read only]
PauseLoop
Stops raising the Update and Render events. To restart the loop, call StartLoop.
Initializes the input interface, raises a Start event then starts the game loop. Once started, the loop will raise regularly Update and Render events. If the loop is paused by PauseLoop, this function restarts the loop without raising the Start event.
StopLoop
Stops the game loop and raises a Stop event.
StyleAsString
StyleClassesAsList [read only]
SwitchToScreen (ScreenAssgeScreen)
Stops the game loop, switches to the specified screen and restarts the loop. All events are redirected. To raise again the initial events, set Screen to Null .
Changes the opacity value of the actor to the given value over the specified duration (in milliseconds). Returns the current Alpha in the ActionProgression event.
Changes the opacity value of the actor to the given value over the specified duration (in milliseconds). Returns the current Alpha in the ActionProgression event.
Moves the actor along the path described by Waypoints (a list of sgePoint2D) at the specified speed (in pixels per millisecond). Returns the current list index in the ActionProgression event.
GoToActor (ActorAssgeActor) AssgeAction
Moves the actor instantly to the position of the given actor.
Changes the width and height of the actor to the given values over the specified duration (in milliseconds). This action cannot be assigned to a group.
Changes the width and height of the actor to the given values over the specified duration (in milliseconds). This action cannot be assigned to a group.
Rotate (DegreesAsDouble) AssgeAction
Changes instantly the rotation angle of the actor to the specified value (in degrees).
Changes the rotation angle of the actor to the given value over the specified duration (in milliseconds). Returns the current angle in the ActionProgression event.
Changes the rotation angle of the actor to the given value over the specified duration (in milliseconds). Returns the current angle in the ActionProgression event.
Scale (XAsDouble, YAsDouble) AssgeAction
Changes instantly the ScaleX and ScaleY values of the actor to the given values.
Gets or sets the effect applied to this actor. Note that effects are not cumulative. So any effect applied to a group will be ignored by an actor of this group having its own effect.
FlipXAsBoolean
Gets or sets whether this actor is flipped on the X axis.
FlipYAsBoolean
Gets or sets whether this actor is flipped on the Y axis.
Gets or sets the local X position of this actor. The LocalX,LocalY coordinates are relative to the parent's coordinates.
LocalYAsDouble
Gets or sets the local Y position of this actor. The LocalX,LocalY coordinates are relative to the parent's coordinates.
ParentAssgeGroup
Gets or sets the group containing this actor.
PerformAction (ElapsedInMillisAsLong)
Updates the data of the action assigned to this actor. Should be called in the Update event.
RemoveFromParent
Removes this actor from its parent group and destroys its visual object.
REPEAT_FOREVERAsInt
RotationAsDouble
Gets or sets the rotation angle in degrees.
ScaleXAsDouble
Gets or sets the scale of this actor in the horizontal direction relative to its width.
ScaleYAsDouble
Gets or sets the scale of this actor in the vertical direction relative to its height.
SetAnimation (AnimationAssgeAnimation)
SetImage (ImageAsImageWrapper)
SetLocalPosition (XAsDouble, YAsDouble)
Sets the local position of this actor. The LocalX,LocalY coordinates are relative to the parent's coordinates.
SetPosition (XAsDouble, YAsDouble)
Sets the global position of this actor. The X,Y coordinates are relative to the canvas origin.
SetRegion (RegionAssgeRegion)
SetRepeatedAction (ActionAssgeAction, CountAsInt)
Repeats the specified action the given number of times (or forever if Count is set to REPEAT_FOREVER). This action is repeated only after all actions linked with Then and With are finished.
SetScale (ScaleAsDouble)
Gets or sets the scale of this actor in both directions.
SetSize (WidthAsDouble, HeightAsDouble)
Sets the size of this actor.
SetText (TextAssgeText)
StartAnimation
StopAnimation
TagAsObject
VisibleAsBoolean
Gets or sets whether this actor is shown or hidden.
VisualObjectAsObject [read only]
WidthAsDouble
Gets or sets the width of this actor.
XAsDouble
Gets or sets the global X position. The X,Y coordinates are relative to the canvas origin.
YAsDouble
Gets or sets the global Y position. The X,Y coordinates are relative to the canvas origin.
ZOrderAsInt
Gets or sets the Z-order (position in the drawing list of the actor's parent). 0 = first actor to be drawn.
Error(Reason As String, AssetType As String, Dir As String, FileName As String) Loading(AssetType As String, AssetName As String, Dir As String, FileName As String, Progression As Float) Loaded
Returns the navigation grid with the specified name from the loaded assets.
GetSound (NameAsString) AssgeSound
Returns the sound with the specified name from the loaded assets.
GetText (NameAsString) AsString
Returns the text with the specified name from the loaded assets.
GetText2 (NameAsString) AssgeText
Returns the text asset with the specified name as a sgeText object.
GetTiledMap (NameAsString) AssgeTiledMap
Returns the tiled map with the specified name from the loaded assets.
IMAGEAsString
Initialize (EventPrefixAsString)
Initializes the asset manager.
LoadAllAssets
Loads all assets on a background thread. Raises a Loading event before loading each asset, then a Loaded event when the task is finished. If a loading fails, an Error event is raised and the operation is cancelled.
Creates a new Blend effect with the specified mode and bottom and top inputs.
ModeAsjavafx.scene.effect.BlendMode
Gets or sets the mode used to blend the two inputs together.
MODE_ADDAsjavafx.scene.effect.BlendMode
The color and alpha components from the top input are added to those from the bottom input.
MODE_BLUEAsjavafx.scene.effect.BlendMode
The blue component of the bottom input is replaced with the blue component of the top input; the other color components are unaffected.
MODE_COLOR_BURNAsjavafx.scene.effect.BlendMode
The inverse of the bottom input color components are divided by the top input color components, all of which is then inverted to produce the resulting color.
MODE_COLOR_DODGEAsjavafx.scene.effect.BlendMode
The bottom input color components are divided by the inverse of the top input color components to produce the resulting color.
MODE_DARKENAsjavafx.scene.effect.BlendMode
The darker of the color components from the two inputs are selected to produce the resulting color.
MODE_DIFFERENCEAsjavafx.scene.effect.BlendMode
The darker of the color components from the two inputs are subtracted from the lighter ones to produce the resulting color.
MODE_EXCLUSIONAsjavafx.scene.effect.BlendMode
The color components from the two inputs are multiplied and doubled, and then subtracted from the sum of the bottom input color components, to produce the resulting color.
MODE_GREENAsjavafx.scene.effect.BlendMode
The green component of the bottom input is replaced with the green component of the top input; the other color components are unaffected.
MODE_HARD_LIGHTAsjavafx.scene.effect.BlendMode
The input color components are either multiplied or screened, depending on the top input color.
MODE_LIGHTENAsjavafx.scene.effect.BlendMode
The lighter of the color components from the two inputs are selected to produce the resulting color.
MODE_MULTIPLYAsjavafx.scene.effect.BlendMode
The color components from the first input are multiplied with those from the second input.
MODE_OVERLAYAsjavafx.scene.effect.BlendMode
The input color components are either multiplied or screened, depending on the bottom input color.
MODE_REDAsjavafx.scene.effect.BlendMode
The red component of the bottom input is replaced with the red component of the top input; the other color components are unaffected.
MODE_SCREENAsjavafx.scene.effect.BlendMode
The color components from both of the inputs are inverted, multiplied with each other, and that result is again inverted to produce the resulting color.
MODE_SOFT_LIGHTAsjavafx.scene.effect.BlendMode
The input color components are either darkened or lightened, depending on the top input color.
MODE_SRC_ATOPAsjavafx.scene.effect.BlendMode
The part of the top input lying inside of the bottom input is blended with the bottom input.
MODE_SRC_OVERAsjavafx.scene.effect.BlendMode
The top input is blended over the bottom input.
OpacityAsDouble
Gets or sets the opacity value, which is modulated with the top input prior to blending. From 0 to 1.
Creates a new ColorInput with the specified position, dimensions, and color. X and Y are in the coordinate space of the node. To take the camera position into account, subtract sgeCamera.LeftX from X and sgeCamera.TopY from Y.
WidthAsDouble
Gets or sets the width of the region to be flooded.
XAsDouble
Gets or sets the X location of the region to be flooded. X is in the coordinate space of the node. To take the camera position into account, subtract sgeCamera.LeftX from X.
YAsDouble
Gets or sets the Y location of the region to be flooded. Y is in the coordinate space of the node. To take the camera position into account, subtract sgeCamera.TopY from Y.
Creates a new ImageInput with the specified source, X and Y. X and Y are in the coordinate space of the node. To take the camera position into account, subtract sgeCamera.LeftX from X and sgeCamera.TopY from Y.
SourceAsImageWrapper
Gets or sets the source image.
XAsDouble
Gets or sets the X location of the source image. X is in the coordinate space of the node. To take the camera position into account, subtract sgeCamera.LeftX from X.
YAsDouble
Gets or sets the Y location of the source image. Y is in the coordinate space of the node. To take the camera position into account, subtract sgeCamera.TopY from Y.
Gets or sets the choke of the shadow. From 0 to 1. The choke is the portion of the radius where the contribution of the source material will be 100%. The remaining portion of the radius will have a contribution controlled by the blur kernel.
ColorAsjavafx.scene.paint.Color
Gets or sets the shadow color.
HeightAsDouble
Gets or sets the vertical size of the shadow blur kernel. From 0 to 255.
Initialize
Creates a new InnerShadow effect with default parameters.
Creates a new LightingPoint effect with the specified X, Y, Z, and color. X: The X coordinate of the light position. Y: The Y coordinate of the light position. Z: The Z coordinate of the light position.
SpecularConstantAsDouble
Gets or sets the specular constant. From 0 to 2.
SpecularExponentAsDouble
Gets or sets the specular exponent. From 0 to 40.
SurfaceScaleAsDouble
Gets or sets the surface scale factor. From 0 to 10.
XAsDouble
Gets or sets the X coordinate of the light position.
YAsDouble
Gets or sets the Y coordinate of the light position.
ZAsDouble
Gets or sets the Z coordinate of the light position.
Creates a new LightingSpot effect with the specified X, Y, Z, specular exponent, and color. X: The X coordinate of the direction vector for this light. Y: The Y coordinate of the direction vector for this light. Z: The Z coordinate of the direction vector for this light. SpecularExponent: The specular exponent, which controls the focus of this light source.
SpecularConstantAsDouble
Gets or sets the specular constant. From 0 to 2.
SpecularExponentAsDouble
Gets or sets the specular exponent, which controls the focus of this light source. From 0 to 4.
SurfaceScaleAsDouble
Gets or sets the surface scale factor. From 0 to 10.
XAsDouble
Gets or sets the X coordinate of the direction vector for this light.
YAsDouble
Gets or sets the Y coordinate of the direction vector for this light.
ZAsDouble
Gets or sets the Z coordinate of the direction vector for this light.
Draws an arc using the current fill paint color if Filled is true, or the current stroke paint color and line attributes otherwise. StartAngle: The starting angle of the arc in degrees. ArcExtent: The angular extent of the arc in degrees. Closure: One of the CLOSURE_... constants.
Draws an oval using the current fill paint color if Filled is true, or the current stroke paint color and line attributes otherwise.
DrawPolygon (Point2DsAsList, FilledAsBoolean)
Draws a polygon using the current fill paint color if Filled is true, or the current stroke paint color and line attributes otherwise. Point2Ds: List of sgePoint2D objects containing the coordinates of the polygon's points.
Draws a polygon using the current fill paint color if Filled is true, or the current stroke paint color and line attributes otherwise. Point2Ds: Array of sgePoint2D objects containing the coordinates of the polygon's points.
Draws a polygon using the current fill paint color if Filled is true, or the current stroke paint color and line attributes otherwise. xPoints: Array containing the X coordinates of the polygon's points. yPoints: Array containing the Y coordinates of the polygon's points. nPoints: The number of points that make the polygon.
DrawPolyline (Point2DsAsList)
Draws a polyline using the current stroke paint color and line attributes. Point2Ds: List of sgePoint2D objects containing the coordinates of the polyline's points.
DrawPolyline2 (Point2Ds() AssgePoint2D)
Draws a polyline using the current stroke paint color and line attributes. Point2Ds: Array of sgePoint2D objects containing the coordinates of the polyline's points.
Draws a polyline using the current stroke paint color and line attributes. xPoints: Array containing the X coordinates of the polyline's points. yPoints: Array containing the Y coordinates of the polyline's points. nPoints: The number of points that make the polyline.
Draws a rounded rectangle using the current fill paint color if Filled is true, or the current stroke paint color and line attributes otherwise. ArcWidth,ArcHeight: The arc dimensions of the rectangle corners.
Draws the given string of text at position X,Y with the current fill paint color if Filled is true, or the current stroke paint color and line attributes otherwise.
Draws the given string of text at position X,Y with the current fill paint color if Filled is true, or the current stroke paint color and line attributes otherwise. MaxWidth: If the width of the text extends past this value, then it will be sized to fit.
DrawText (TextAssgeText, XAsDouble, YAsDouble)
Draws the specified Text object at position X,Y. This may change the font and color attributes.
Sets the effect to be applied. Note that effects are not cumulative.
FillAsjavafx.scene.paint.Paint
Gets or sets the current fill paint color. The default value is fx.Colors.Black.
FillWithImage (ImageAsImageWrapper)
Fills the canvas with the given image. The image is repeated horizontally and vertically.
FillWithRegion (RegionAssgeRegion)
Fills the canvas with the given region. The region is repeated horizontally and vertically.
FontAsjavafx.scene.text.Font
Gets or sets the current font.
GlobalAlphaAsDouble
Gets or sets the global alpha of the current state (a value from 0 to 1). The default value is 1.0.
IsTransformedAsBoolean
Returns whether the canvas is rotated, scaled or sheared with a Transform (the camera zoom is not taken into account).
LineCapAsjavafx.scene.shape.StrokeLineCap
Gets or sets the current stroke line cap. The default value is CAP_SQUARE.
LineDashes() AsDouble
Gets or sets the current stroke line dash pattern. The default value is Null.
LineWidthAsDouble
Gets or sets the current line width. The default value is 1.0.
RestoreState
Pops the state off of the stack, setting the following attributes to their value at the time when that state was pushed onto the stack with SaveState. If the stack is empty then nothing is changed. - CurrentTransform - Effect - Fill - Font - GlobalAlpha - LineCap - LineDashes - LineWidth - Stroke - TextAlignment
Returns a Transform object representing a scaling transformation. X: Factor by which coordinates are scaled along the X axis direction. Y: Factor by which coordinates are scaled along the Y axis direction.
Returns a Transform object representing a scaling transformation. X: Factor by which coordinates are scaled along the X axis direction. Y: Factor by which coordinates are scaled along the Y axis direction. PivotX: The X coordinate about which point the scale occurs. PivotY: The Y coordinate about which point the scale occurs.
Returns a Transform object representing a shearing transformation. X: Multiplier by which coordinates are shifted in the direction of the positive X axis as a factor of their Y coordinate. Y: Multiplier by which coordinates are shifted in the direction of the positive Y axis as a factor of their X coordinate.
Returns a Transform object representing a shearing transformation. X: Multiplier by which coordinates are shifted in the direction of the positive X axis as a factor of their Y coordinate. Y: Multiplier by which coordinates are shifted in the direction of the positive Y axis as a factor of their X coordinate. PivotX: The X coordinate of the shear pivot point. PivotY: The Y coordinate of the shear pivot point.
StrokeAsjavafx.scene.paint.Paint
Gets or sets the current stroke paint color. The default value is fx.Colors.Black.
Gets or sets the effect applied to this actor. Note that effects are not cumulative. So any effect applied to a group will be ignored by an actor of this group having its own effect.
FlipXAsBoolean
Gets or sets whether this actor is flipped on the X axis.
FlipYAsBoolean
Gets or sets whether this actor is flipped on the Y axis.
HeightAsDouble [read only]
Gets the height of this group. This height is computed according to the group content.
Gets or sets the local X position of this actor. The LocalX,LocalY coordinates are relative to the parent's coordinates.
LocalYAsDouble
Gets or sets the local Y position of this actor. The LocalX,LocalY coordinates are relative to the parent's coordinates.
ParentAssgeGroup
Gets or sets the group containing this actor.
PerformAction (ElapsedInMillisAsLong)
Updates the data of the action assigned to this actor. Should be called in the Update event.
RemoveFromParent
Removes this group from its parent group and destroys the visual object of all children actors.
REPEAT_FOREVERAsInt
RotationAsDouble
Gets or sets the rotation angle in degrees.
ScaleXAsDouble
Gets or sets the scale of this actor in the horizontal direction relative to its width.
ScaleYAsDouble
Gets or sets the scale of this actor in the vertical direction relative to its height.
SetLocalPosition (XAsDouble, YAsDouble)
Sets the local position of this actor. The LocalX,LocalY coordinates are relative to the parent's coordinates.
SetPosition (XAsDouble, YAsDouble)
Sets the global position of this actor. The X,Y coordinates are relative to the canvas origin.
SetRepeatedAction (ActionAssgeAction, CountAsInt)
Repeats the specified action the given number of times (or forever if Count is set to REPEAT_FOREVER). This action is repeated only after all actions linked with Then and With are finished.
SetScale (ScaleAsDouble)
Gets or sets the scale of this actor in both directions.
TagAsObject
VisibleAsBoolean
Gets or sets whether this actor is shown or hidden.
WidthAsDouble [read only]
Gets the width of this group. This width is computed according to the group content.
XAsDouble
Gets or sets the global X position. The X,Y coordinates are relative to the canvas origin.
YAsDouble
Gets or sets the global Y position. The X,Y coordinates are relative to the canvas origin.
ZOrderAsInt
Gets or sets the Z-order (position in the drawing list of the actor's parent). 0 = first actor to be drawn.
KeyPressed(KeyData As sgeKeyEvent) KeyReleased(KeyData As sgeKeyEvent) MouseClicked(EventData As MouseEvent) MouseDragged(EventData As MouseEvent) MouseEntered(EventData As MouseEvent) MouseExited(EventData As MouseEvent) MouseMoved(EventData As MouseEvent) MousePressed(EventData As MouseEvent) MouseReleased(EventData As MouseEvent) Scroll(DeltaY As Double)
Gets or sets the relative left and right volume levels of the music. Valid range is -1 to 1 where -1 gives full volume to the left channel while muting the right channel, 0 gives full volume to both channels and 1 gives full volume to right channel and mutes the left channel. Default = 0.
CurrentTimeAsDouble [read only]
Returns the current music playback time (in milliseconds from start).
CYCLE_INDEFINITEAsInt
CycleCountAsInt
Gets or sets the number of times the music will be played when Play is called. Setting this to CYCLE_INDEFINITE will cause the music to repeat until Pause or Stop is called. Default = 1.
DurationAsDouble [read only]
Retrieves the duration in seconds of the music. This information is only available when the player is ready to play.
Initialize (DirAsString, FilenameAsString)
Creates a new music instance.
IsInitializedAsBoolean
IsPausedAsBoolean
Indicates whether the playback is paused.
IsPlayingAsBoolean
Indicates whether this music is playing.
IsReadyAsBoolean
Indicates whether the player is prepared to play.
Pause
Pauses the playback.
Play
Starts playing the music. If previously paused, then playback resumes where it was paused.
PlayFromStart
Starts playing the music from the beginning.
Seek (SeekTimeAsDouble)
Seeks the player to a new playback time (in milliseconds from start).
Stop
Stops playing the music.
VolumeAsDouble
Gets or sets the volume at which the music should be played. Valid range is 0 (inaudible) to 1 (full volume). Default = 1.
Divides the game world in square cells of the given size to create a navigation grid. The bigger are the cells, the faster is the pathfinding calculation, but also less accurate is the path. Each cell has a navigation cost (the cost to enter the cell), which allows to simulate varying terrain difficulties. WorldWidth,WorldHeight: The world size in pixels. CellSize: The size of each cell in pixels. CostsArray: An optional two-dimensional array (column, row) containing the navigation cost of each cell, which ranges from 1 (no obstacle, fast move) to 10 (impassable obstacle, impossible move). If CostsArray is Null, the default cost (1.0) is used. DiagonalMove: Whether each cell is connected to the 8 surrounding cells (allowing diagonal moves) or just 4 cells (allowing only orthogonal moves).
IsInitializedAsBoolean
MAX_COSTAsFloat
NbOfColsAsInt [read only]
Returns the number of columns of this grid.
NbOfRowsAsInt [read only]
Returns the number of rows of this grid.
NORMAL_COSTAsFloat
SetCost (ColAsInt, RowAsInt, CostAsFloat)
Sets the cost for the cell at the given coordinates. From 0 (no obstacle, fastest move) to 10 (impassable obstacle, impossible move).
SetTag (ColAsInt, RowAsInt, ValueAsObject)
Sets the Tag value for the cell at the given coordinates.
Heuristic(C As Int, R As Int, StartC As Int, StartR As Int, GoalC As Int, GoalR As Int) As Float Cost(C As Int, R As Int, NeighborC As Int, NeighborR As Int, Diagonal As Boolean, GridCost As Float) As Float Path(LWP As List, ExceptionMsg As String, Tag As Object)
Returns a list of waypoints defining the shortest path from the current position to a desired location, according to the specified A* heuristic. This function returns Null if no path was found. Grid: A navigation grid. Heuristic: One of the methods (HEURISTIC_...) to estimate the movement cost between the considered cell and the final cell to reach. Cost: One of the methods (COST_...) to compute the movement cost between two cells. EventPrefix: Prefix of events. This function will fire a Heuristic event if you set Heuristic to Custom, and a Cost event if you set Cost to Custom.
This function is identical to FindShortestPath except it runs on a background thread and fires a Path event when it ends. If an exception occurs, the LWP parameter is null and the ExceptionMsg parameter contains the exception message.
HEURISTIC_CHEBYSHEVAsByte
HEURISTIC_CUSTOMAsByte
HEURISTIC_DIAGONALAsByte
HEURISTIC_EUCLIDIANAsByte
HEURISTIC_MANHATTANAsByte
Should be used only when diagonal moves are not allowed.
HEURISTIC_NONEAsByte
Turns the A* algorithm into a Dijkstra algorithm.
TotalCostAsFloat [read only]
Returns the total cost of the last computed path, if a path was found. Should be read right after the call to FindShortestPath if the result is not Null.
Creates a new region. A region describes a rectangle inside an Image and is used for drawing only a portion of this image. A region is not a cropped copy; if the source image is modified, the region is modified too.
Gets or sets the effect applied to this actor. Note that effects are not cumulative. So any effect applied to a group will be ignored by an actor of this group having its own effect.
FlipXAsBoolean
Gets or sets whether this actor is flipped on the X axis.
FlipYAsBoolean
Gets or sets whether this actor is flipped on the Y axis.
HeightAsDouble [read only]
Gets the height of this group. This height is computed according to the group content.
IsInitializedAsBoolean
PerformAction (ElapsedInMillisAsLong)
Updates the data of the action assigned to this actor. Should be called in the Update event.
REPEAT_FOREVERAsInt
RotationAsDouble
Gets or sets the rotation angle in degrees.
ScaleXAsDouble
Gets or sets the scale of this actor in the horizontal direction relative to its width.
ScaleYAsDouble
Gets or sets the scale of this actor in the vertical direction relative to its height.
SetPosition (XAsDouble, YAsDouble)
Sets the global position of this actor. The X,Y coordinates are relative to the canvas origin.
SetRepeatedAction (ActionAssgeAction, CountAsInt)
Repeats the specified action the given number of times (or forever if Count is set to REPEAT_FOREVER). This action is repeated only after all actions linked with Then and With are finished.
SetScale (ScaleAsDouble)
Gets or sets the scale of this actor in both directions.
TagAsObject
VisibleAsBoolean
Gets or sets whether this actor is shown or hidden.
WidthAsDouble [read only]
Gets the width of this group. This width is computed according to the group content.
XAsDouble
Gets or sets the global X position. The X,Y coordinates are relative to the canvas origin.
YAsDouble
Gets or sets the global Y position. The X,Y coordinates are relative to the canvas origin.
Gets or sets the relative left and right volume levels of the clip. Valid range is -1 to 1 where -1 gives full volume to the left channel while muting the right channel, 0 gives full volume to both channels and 1 gives full volume to right channel and mutes the left channel. Default = 0.
CYCLE_INDEFINITEAsInt
CycleCountAsInt
Gets or sets the number of times the clip will be played when Play is called. Setting this to CYCLE_INDEFINITE will cause the clip to continue looping until Stop is called. Default = 1.
Initialize (DirAsString, FilenameAsString)
Creates a new audio clip loaded from the specified file.
IsInitializedAsBoolean
IsPlayingAsBoolean
Indicates whether this audio clip is playing.
PanAsDouble
Gets or sets the relative "center" of the clip. A Pan value of 0 plays the clip normally where -1 shifts the clip entirely to the left channel and 1 shifts entirely to the right channel. Unlike Balance this setting mixes both channels so neither channel loses data. Default = 0.
Play
Plays the audio clip.
Play2 (VolumeAsDouble)
Plays the audio clip with the specified volume. This function does not modify the value of the Volume property.
PriorityAsInt
Gets or sets the relative priority of the clip with respect to other clips. This value is used to determine which clips to remove when the maximum allowed number of clips is exceeded. Default = 0.
RateAsDouble
Gets or sets the relative rate at which the clip is played. Valid range is 0.125 (1/8 speed) to 8.0 (8x speed); values outside this range are clamped internally. Default = 1.
Stop
Immediately stops all playback of this audio clip.
VolumeAsDouble
Gets or sets the relative volume level at which the clip is played. Valid range is 0 (muted) to 1 (full volume). Default = 1.
Reduces the number of colors of the given image to 256. This operation may take several seconds depending on the image size and sampling value. Sampling: Sampling factor of the quantization algorithm. From 1 (slow, but good quality) to 30 (fast, but low quality).