GameFeaturesToolset.GameFeaturesToolset

Provides tools for listing, activating, and deactivating Game Feature Plugins.

7 tool(s).

GameFeaturesToolset.GameFeaturesToolset.GetGameFeatureState

Gets the current state of a Game Feature Plugin.

Input schema

{
  "properties": {
    "pluginName": {
      "description": "Name of the Game Feature Plugin.",
      "type": "string"
    }
  },
  "required": [
    "pluginName"
  ],
  "type": "object"
}

Output schema

{
  "properties": {
    "returnValue": {
      "description": "Simplified state enum. Raises an error if the subsystem is unavailable or the plugin is not found.",
      "enum": [
        "Uninitialized",
        "Installed",
        "Registered",
        "Loaded",
        "Active",
        "Unknown"
      ],
      "title": "EPluginToolsetGFPState",
      "type": "string"
    }
  },
  "required": [
    "returnValue"
  ],
  "type": "object"
}

GameFeaturesToolset.GameFeaturesToolset.IsGameFeatureActive

Checks whether a Game Feature Plugin is active. Raises an error if the subsystem is unavailable or the plugin is not found. Use GetGameFeatureState if you need the current state when the plugin is not active.

Input schema

{
  "properties": {
    "pluginName": {
      "description": "Name of the Game Feature Plugin.",
      "type": "string"
    }
  },
  "required": [
    "pluginName"
  ],
  "type": "object"
}

Output schema

{
  "properties": {
    "returnValue": {
      "description": "True if the Game Feature Plugin is active.",
      "type": "boolean"
    }
  },
  "required": [
    "returnValue"
  ],
  "type": "object"
}

GameFeaturesToolset.GameFeaturesToolset.IsGameFeaturePlugin

Return whether or not a plugin is a Game Feature Plugin. Will error if no plugin of this name can be found by the Plugin Manager.

Input schema

{
  "properties": {
    "pluginName": {
      "description": "Name of the plugin",
      "type": "string"
    }
  },
  "required": [
    "pluginName"
  ],
  "type": "object"
}

Output schema

{
  "properties": {
    "returnValue": {
      "description": "True if the plugin is a Game Feature Plugin",
      "type": "boolean"
    }
  },
  "required": [
    "returnValue"
  ],
  "type": "object"
}

GameFeaturesToolset.GameFeaturesToolset.ListDiscoveredGameFeaturePlugins

Lists all discovered Game Feature Plugins sorted by name. This includes enabled and disabled plugins. Only enabled plugins are known by the Game Features system beyond identifying if a plugin is a Game Feature Plugin. Use the Plugins toolset to do general plugin enable/disable tasks.

Input schema

{
  "type": "object"
}

Output schema

{
  "properties": {
    "returnValue": {
      "description": "Sorted names of all discovered Game Feature Plugins.",
      "items": {
        "type": "string"
      },
      "type": "array"
    }
  },
  "required": [
    "returnValue"
  ],
  "type": "object"
}

GameFeaturesToolset.GameFeaturesToolset.ListEnabledGameFeaturePlugins

Lists all enabled Game Feature Plugins sorted by name. Enabled plugins are the only plugins known by the Game Features system beyond identifying if a plugin is a Game Feature Plugin. Use the Plugins toolset to do general plugin enable/disable tasks.

Input schema

{
  "type": "object"
}

Output schema

{
  "properties": {
    "returnValue": {
      "description": "Sorted names of all enabled Game Feature Plugins.",
      "items": {
        "type": "string"
      },
      "type": "array"
    }
  },
  "required": [
    "returnValue"
  ],
  "type": "object"
}

GameFeaturesToolset.GameFeaturesToolset.RequestActivateGameFeature

Requests activation of a Game Feature Plugin. Returns true if the activation request was submitted successfully. The actual activation happens asynchronously -- poll GetGameFeatureState() or IsGameFeatureActive() to confirm completion. Raises an error if the subsystem is unavailable or the plugin is not found.

Input schema

{
  "properties": {
    "pluginName": {
      "description": "Name of the GFP.",
      "type": "string"
    }
  },
  "required": [
    "pluginName"
  ],
  "type": "object"
}

Output schema

{
  "properties": {
    "returnValue": {
      "description": "True if the request was submitted.",
      "type": "boolean"
    }
  },
  "required": [
    "returnValue"
  ],
  "type": "object"
}

GameFeaturesToolset.GameFeaturesToolset.RequestDeactivateGameFeature

Requests deactivation of a Game Feature Plugin. Returns true if the deactivation request was submitted successfully. The actual deactivation happens asynchronously -- poll GetGameFeatureState() to confirm completion. Raises an error if the subsystem is unavailable or the plugin is not found.

Input schema

{
  "properties": {
    "pluginName": {
      "description": "Name of the GFP.",
      "type": "string"
    }
  },
  "required": [
    "pluginName"
  ],
  "type": "object"
}

Output schema

{
  "properties": {
    "returnValue": {
      "description": "True if the request was submitted.",
      "type": "boolean"
    }
  },
  "required": [
    "returnValue"
  ],
  "type": "object"
}