GameSource

Defined in: core/source/game.ts:39

The GameSource class represents the sources of the game items that has been added to the stage. A single source could have multiple items linked into it and any changes to the source would affect all items linked to it.

Each item is represented by the GameItem class. See: #core/GameItem Core/GameItem

Inherits from: #core/Source Core/Source

Basic Usage

var xjs = require('xjs');

xjs.Scene.getActiveScene().then(function(scene) {
  scene.getSources().then(function(sources) {
  for (var i in sources) {
      if (sources[i] instanceof XJS.GameSource) {
        // Manipulate your audio device source here
        sources[i].setSilenceDetectionEnabled(true);
      }
    }
  })
})

All methods marked as Chainable resolve with the original GameSource instance.

Extends

• Source

Implements

• ISourceGame

Constructors

Constructor

new GameSource(props?): GameSource

Defined in: core/source/source.ts:75

Parameters

props?

Returns

GameSource

Inherited from

Source.constructor

Properties

getCustomName

getCustomName: () => Promise<string>

Defined in: core/source/source.ts:291

See: #core/ISource#getCustomName getCustomName

Returns

Promise<string>

Inherited from

Source.getCustomName

---

getGameFPSCap

getGameFPSCap: () => Promise<number>

Defined in: core/source/game.ts:67

See: #core/ISourceGame#getGameFPSCap getGameFPSCap

Returns

Promise<number>

Implementation of

ISourceGame.getGameFPSCap

---

getId

getId: () => Promise<string>

Defined in: core/source/source.ts:316

See: #core/ISource#getId getId

Returns

Promise<string>

Inherited from

Source.getId

---

getItemList

getItemList: () => Promise<Item[]>

Defined in: core/source/source.ts:321

See: #core/ISource#getItemList getItemList

Returns

Promise<Item[]>

Inherited from

Source.getItemList

---

getKeepLoaded

getKeepLoaded: () => Promise<boolean>

Defined in: core/source/source.ts:306

See: #core/ISource#getKeepLoaded getKeepLoaded

Returns

Promise<boolean>

Inherited from

Source.getKeepLoaded

---

getName

getName: () => Promise<string>

Defined in: core/source/source.ts:281

See: #core/ISource#getName getName

Returns

Promise<string>

Inherited from

Source.getName

---

getOfflineImage

getOfflineImage: () => Promise<string>

Defined in: core/source/game.ts:58

See: #core/ISourceGame#getOfflineImage getOfflineImage

Returns

Promise<string>

Implementation of

ISourceGame.getOfflineImage

---

getType

getType: () => Promise<ItemTypes>

Defined in: core/source/source.ts:331

See: #core/ISource#getType getType

Returns

Promise<ItemTypes>

Inherited from

Source.getType

---

getValue

getValue: () => Promise<string | XML>

Defined in: core/source/source.ts:296

See: #core/ISource#getValue getValue

Returns

Promise<string | XML>

Inherited from

Source.getValue

---

isShowMouseEnabled

isShowMouseEnabled: () => Promise<boolean>

Defined in: core/source/game.ts:49

See: #core/ISourceGame#isShowMouseEnabled isShowMouseEnabled

Returns

Promise<boolean>

Implementation of

ISourceGame.isShowMouseEnabled

---

isSpecialOptimizationEnabled

isSpecialOptimizationEnabled: () => Promise<boolean>

Defined in: core/source/game.ts:43

See: #core/ISourceGame#isSpecialOptimizationEnabled isSpecialOptimizationEnabled

Returns

Promise<boolean>

Implementation of

ISourceGame.isSpecialOptimizationEnabled

---

isTransparent

isTransparent: () => Promise<boolean>

Defined in: core/source/game.ts:61

See: #core/ISourceGame#isTransparent isTransparent

Returns

Promise<boolean>

Implementation of

ISourceGame.isTransparent

---

refresh

refresh: () => Promise<Source>

Defined in: core/source/source.ts:326

See: #core/ISource#refresh refresh

Returns

Promise<Source>

Inherited from

Source.refresh

---

setCustomName

setCustomName: () => Promise<Source>

Defined in: core/source/source.ts:286

See: #core/ISource#setCustomName setCustomName

Returns

Promise<Source>

Inherited from

Source.setCustomName

---

setGameFPSCap

setGameFPSCap: (fps) => Promise<GameSource>

Defined in: core/source/game.ts:70

See: #core/ISourceGame#setGameFPSCap setGameFPSCap

Parameters

fps

number

Returns

Promise<GameSource>

Implementation of

ISourceGame.setGameFPSCap

---

setKeepLoaded

setKeepLoaded: (value) => Promise<Source>

Defined in: core/source/source.ts:311

See: #core/ISource#setKeepLoaded setKeepLoaded

Parameters

value

boolean

Returns

Promise<Source>

Inherited from

Source.setKeepLoaded

---

setName

setName: (value) => Promise<Source>

Defined in: core/source/source.ts:276

See: #core/ISource#setName setName

Parameters

value

string

Returns

Promise<Source>

Inherited from

Source.setName

---

setOfflineImage

setOfflineImage: (path) => Promise<GameSource>

Defined in: core/source/game.ts:55

See: #core/ISourceGame#setOfflineImage setOfflineImage

Parameters

path

string

Returns

Promise<GameSource>

Implementation of

ISourceGame.setOfflineImage

---

setShowMouseEnabled

setShowMouseEnabled: (value) => Promise<GameSource>

Defined in: core/source/game.ts:52

See: #core/ISourceGame#setShowMouseEnabled setShowMouseEnabled

Parameters

value

boolean

Returns

Promise<GameSource>

Implementation of

ISourceGame.setShowMouseEnabled

---

setSpecialOptimizationEnabled

setSpecialOptimizationEnabled: (value) => Promise<GameSource>

Defined in: core/source/game.ts:46

See: #core/ISourceGame#setSpecialOptimizationEnabled setSpecialOptimizationEnabled

Parameters

value

boolean

Returns

Promise<GameSource>

Implementation of

ISourceGame.setSpecialOptimizationEnabled

---

setTransparent

setTransparent: (value) => Promise<GameSource>

Defined in: core/source/game.ts:64

See: #core/ISourceGame#setTransparent setTransparent

Parameters

value

boolean

Returns

Promise<GameSource>

Implementation of

ISourceGame.setTransparent

---

setValue

setValue: (value) => Promise<Source>

Defined in: core/source/source.ts:301

See: #core/ISource#setValue setValue

Parameters

value

string | XML

Returns

Promise<Source>

Inherited from

Source.setValue

Methods

getAllSources()

static getAllSources(): Promise<Source[]>

Defined in: core/source/source.ts:220

return: Promise<Source[]>

Get all unique Source from every scene. Total number of Sources returned may be less than total number of items on all the scenes due to Linked items only having a single Source.

Usage

xjs.Source.getAllSources().then(function(sources) {
  for(var i = 0 ; i < sources.length ; i++) {
     if(sources[i] instanceof xjs.HtmlSource) {
       // Manipulate HTML Source here
     }
   }
})

Returns

Promise<Source[]>

Inherited from

Source.getAllSources

---

getCurrentSource()

static getCurrentSource(): Promise<Source>

Defined in: core/source/source.ts:108

return: Promise

Get the current source (when function is called by sources), or the source that was right-clicked to open the source properties window (when function is called from the source properties window)

Usage

xjs.Source.getCurrentSource().then(function(source) {
  // This will fetch the current source (the plugin)
}).catch(function(err) {
  // Handle the error here. Errors would only occur
  // if we try to execute this method on Extension plugins
});

Returns

Promise<Source>

Inherited from

Source.getCurrentSource

---

getItemList()

static getItemList(): Promise<Item[]>

Defined in: core/source/source.ts:167

return: Promise<Item[]>

Get the item List of the current Source. The item list is a list of items linked to a single Source.

Usage

xjs.Source.getItemList()
.then(function(items) {
  // This will fetch the item list of the current Source
  for (var i = 0 ; i < items.length ; i++) {
    // Manipulate each item here
  }
});

This is just the shorter way of getting items that are linked to a single source. See the long version below:

xjs.Source.getCurrentSource()
.then(source.getItemList)
.then(function(items) {
// Manipulate the items here
})

Returns

Promise<Item[]>

Inherited from

Source.getItemList