View source for Making your own console functions

Being able to call functions/commands from the console can be useful, there are a few ways to go about it.

== Global ==

By assigning a function to global, it is possible to access the function from everywhere in your script including console.  This does however, mean that the name you choose may cause conflicts down the line if you plan on trying to use it in another part of your script, so choose carefully.

<code>global.someFunctionName(someVarName) = { someCode };</code> then simply call it in console with <code>someFunctionName(someVarName)</code>.

global will persist between ticks, however it will go away on a global reset, which normally happens when uploading new code or during server side resets / issues.  Its up to you to keep it refreshed if you want it presistent.

You can learn more about global here: https://docs.screeps.com/contributed/caching-overview.html#Global

== Prototype ==

By setting a prototype of an existing object in game (that can take it) you can call the prototype from console off the object.  

<code>GameObject.prototype.functionName = function(someVarName){ someCode};</code> and then you can call it with console <code>GameObject.functionName(someVarName)</code>  For a more specific example, you could prototype room, then call off a room.

<code>Room.prototype.functionName = function(varName){ someCode };</code> and in console <code>Game.rooms['roomNameHere'].functionName(varName)</code>

You can learn more about prototyping in screeps here: https://docs.screeps.com/contributed/modifying-prototypes.html
[[Category:Development]]