ISourceGame
Defined in: core/source/igame.ts:15
Methods
Section titled “Methods”getGameFPSCap()
Section titled “getGameFPSCap()”getGameFPSCap():
Promise<number>
Defined in: core/source/igame.ts:87
return: Promise
Get the maximum number of frames per second the game is being limited to by XBC
Returns
Section titled “Returns”Promise<number>
getOfflineImage()
Section titled “getOfflineImage()”getOfflineImage():
Promise<string>
Defined in: core/source/igame.ts:62
return: Promise
Get the offline image of a game item
Returns
Section titled “Returns”Promise<string>
isShowMouseEnabled()
Section titled “isShowMouseEnabled()”isShowMouseEnabled():
Promise<boolean>
Defined in: core/source/igame.ts:37
return: Promise
Check if Show Mouse is currently enabled or not
Returns
Section titled “Returns”Promise<boolean>
isSpecialOptimizationEnabled()
Section titled “isSpecialOptimizationEnabled()”isSpecialOptimizationEnabled():
Promise<boolean>
Defined in: core/source/igame.ts:21
return: Promise
Check if Game Special Optimization is currently enabled or not
Returns
Section titled “Returns”Promise<boolean>
isTransparent()
Section titled “isTransparent()”isTransparent():
Promise<boolean>
Defined in: core/source/igame.ts:70
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>
setGameFPSCap()
Section titled “setGameFPSCap()”setGameFPSCap(
fps):Promise<ISourceGame>
Defined in: core/source/igame.ts:97
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>
setOfflineImage()
Section titled “setOfflineImage()”setOfflineImage(
path):Promise<ISourceGame>
Defined in: core/source/igame.ts:55
param: path
Set the offline image of a game item
Chainable.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<ISourceGame>
setShowMouseEnabled()
Section titled “setShowMouseEnabled()”setShowMouseEnabled(
value):Promise<ISourceGame>
Defined in: core/source/igame.ts:46
param: (value: boolean)
Set Show Mouse in game to on or off
Chainable.
Parameters
Section titled “Parameters”boolean
Returns
Section titled “Returns”Promise<ISourceGame>
setSpecialOptimizationEnabled()
Section titled “setSpecialOptimizationEnabled()”setSpecialOptimizationEnabled(
value):Promise<ISourceGame>
Defined in: core/source/igame.ts:30
param: Promise
Set Game Special Optimization to on or off
Chainable.
Parameters
Section titled “Parameters”boolean
Returns
Section titled “Returns”Promise<ISourceGame>
setTransparent()
Section titled “setTransparent()”setTransparent(
value):Promise<ISourceGame>
Defined in: core/source/igame.ts:80
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>