iSourceGame
Defined in: core/source/igame.ts:100
Implements
Section titled “Implements”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new iSourceGame():
iSourceGame
Returns
Section titled “Returns”iSourceGame
Properties
Section titled “Properties”getValue
Section titled “getValue”getValue: () =>
Promise<string|XML>
Defined in: core/source/igame.ts:339
Returns
Section titled “Returns”Promise<string | XML>
setValue
Section titled “setValue”setValue: (
value) =>Promise<iSourceGame>
Defined in: core/source/igame.ts:341
Parameters
Section titled “Parameters”string | XML
Returns
Section titled “Returns”Promise<iSourceGame>
Methods
Section titled “Methods”getGameFPSCap()
Section titled “getGameFPSCap()”getGameFPSCap():
Promise<number>
Defined in: core/source/igame.ts:282
return: Promise
Get the maximum number of frames per second the game is being limited to by XBC
Returns
Section titled “Returns”Promise<number>
Implementation of
Section titled “Implementation of”getOfflineImage()
Section titled “getOfflineImage()”getOfflineImage():
Promise<string>
Defined in: core/source/igame.ts:227
return: Promise
Get the offline image of a game item
Returns
Section titled “Returns”Promise<string>
Implementation of
Section titled “Implementation of”isShowMouseEnabled()
Section titled “isShowMouseEnabled()”isShowMouseEnabled():
Promise<boolean>
Defined in: core/source/igame.ts:154
return: Promise
Check if Show Mouse is currently enabled or not
Returns
Section titled “Returns”Promise<boolean>
Implementation of
Section titled “Implementation of”ISourceGame.isShowMouseEnabled
isSpecialOptimizationEnabled()
Section titled “isSpecialOptimizationEnabled()”isSpecialOptimizationEnabled():
Promise<boolean>
Defined in: core/source/igame.ts:114
return: Promise
Check if Game Special Optimization is currently enabled or not
Returns
Section titled “Returns”Promise<boolean>
Implementation of
Section titled “Implementation of”ISourceGame.isSpecialOptimizationEnabled
isTransparent()
Section titled “isTransparent()”isTransparent():
Promise<boolean>
Defined in: core/source/igame.ts:243
return: Promise
Get the transparency of a game item. Please note that game source transparency only works if Game Special Optimization is also enabled.
Returns
Section titled “Returns”Promise<boolean>
Implementation of
Section titled “Implementation of”setGameFPSCap()
Section titled “setGameFPSCap()”setGameFPSCap(
value):Promise<iSourceGame>
Defined in: core/source/igame.ts:307
param: path
Set the maximum number of frames per second the game is being limited to by XBC. Accepter values are either 0 (disable capping) or within the range of 24 to 300 fps
Chainable.
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”Promise<iSourceGame>
Implementation of
Section titled “Implementation of”setOfflineImage()
Section titled “setOfflineImage()”setOfflineImage(
path):Promise<iSourceGame>
Defined in: core/source/igame.ts:194
param: path
Set the offline image of a game item
Chainable.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<iSourceGame>
Implementation of
Section titled “Implementation of”setShowMouseEnabled()
Section titled “setShowMouseEnabled()”setShowMouseEnabled(
value):Promise<iSourceGame>
Defined in: core/source/igame.ts:171
param: (value: boolean)
Set Show Mouse in game to on or off
Chainable.
Parameters
Section titled “Parameters”boolean
Returns
Section titled “Returns”Promise<iSourceGame>
Implementation of
Section titled “Implementation of”ISourceGame.setShowMouseEnabled
setSpecialOptimizationEnabled()
Section titled “setSpecialOptimizationEnabled()”setSpecialOptimizationEnabled(
value):Promise<iSourceGame>
Defined in: core/source/igame.ts:131
param: Promise
Set Game Special Optimization to on or off
Chainable.
Parameters
Section titled “Parameters”boolean
Returns
Section titled “Returns”Promise<iSourceGame>
Implementation of
Section titled “Implementation of”ISourceGame.setSpecialOptimizationEnabled
setTransparent()
Section titled “setTransparent()”setTransparent(
value):Promise<iSourceGame>
Defined in: core/source/igame.ts:262
param: value
Set the transparency of a game source Please note that game transparency only works if Game Special Optimization is also enabled.
Chainable.
Parameters
Section titled “Parameters”boolean
Returns
Section titled “Returns”Promise<iSourceGame>