Edit

Edit an existing player plugin.

You can only edit player plugins in actors on the same level or lower than your actor.

Tokens

This action requires the following tokens:

  • playerplugin-write

Arguments

Required arguments are marked in bold, and optional arguments are marked in italics.

Argument Type Default Description
playerplugin Hash   The ID of the player plugin to edit
jsurl String   The new URL of the javascript of the player plugin
cssurl String  

The new URL of the CSS of the player plugin

This argument can be unset by providing an empty string

name String   The new name of the plugin
description String   The new description of the plugin

Output

This action produces the following output on success:

An object containing the following fields:

Name Type Description
id Hash Player plugin ID
jsurl String Player plugin javascript URL
cssurl String Player plugin CSS URL
name String Player plugin name
description String Player plugin description
datecreated DateTime When the player plugin was created
datemodified DateTime When the player plugin was last modified
account

Account for this player plugin

The value of this field is an object containing the following fields:

Name Type Description
id Hash Account ID
name String Account name
customer

Customer for this player plugin

The value of this field is an object containing the following fields:

Name Type Description
id Hash Customer ID
name String The name of this customer
datecreated DateTime When this customer was created
datemodified DateTime When this customer was last modified

Errors

This action can return one of the default status codes, or one of the following status codes on error:

STATUS_PLAYER_PLUGIN_NOT_FOUND (480)
If the player plugin specified by “playerplugin” can not be found