View source for Server Admin Remote Scriptlet

Jump to: navigation, search
You do not have permission to edit this page, for the following reason:
The action you have requested is limited to users in the group: Users.
You can view and copy the source of this page.
'''Server Admin Remote Scripelets''' are tools to access [http://en.wikipedia.org/wiki/PowerShell PowerShell], [[NWScript]], and other useful tools.

Only those who have server admin access, as defined in SQL, may use the following commands. 

== General Commands ==
{| class="wikitable_standard leftLastColumn"
! Command
! Example
! Description
|-
| <code>#sa '''rs [scriptlet]'''</code>
| <code>#sa rs $s.GetTag( $OBJECT_TARGET );</code>
| Run a PowerShell/NWScript scriptlet.  The $s object can be used to access NWScript functions, like $s.SendMessageToPC($OBJECT_SELF, 'Message');.  The $sql object (an ALFA.Database) can be used to make database accesses.  The $CreatureAI object can be used to interface with the creature AI system. See ''Remote Scriptlets'' below.
|-
| <code>#sa '''runscript [scriptname]'''</code>
| <code>#sa runscript 010_kill_all_pcs</code>
| Run a script by name.
|-
| <code>#sa '''getglobalint [var]'''</code>
| <code>#sa getglobalint ACR_IMPORTANT_VARIABLE</code>
| Read a variable. <code>'''getglobalint'''</code> may be replaced by getglobalfloat, getglobalstring, getmoduleint, getmodulefloat, getmodulestring, or getmoduleobject.
|-
| <code>#sa '''loadscript [C# Script DLL Path]'''</code>
| 
| Load a C# script assembly and call its main function.
|-
| <code>#sa '''boot [accountname]'''</code>
| <code>#sa boot FoamBats4All</code>
| Boot a PC by account name (insensitive).
|-
| <code>#sa '''dumpvars [object]'''</code>
| <code>#sa dumpvars #module</code>
| Dump variables on an object (by hex object id, tag, #module, #self, or #area).
|-
| <code>#sa '''dumpareas'''</code>
| <code>#sa dumpareas</code>
| Dump a list of areas in the module.
|-
| <code>#sa '''dumpareaobjects [area]'''</code>
| <code>#sa dumpareaobjects  #area</code>
| Dump objects in an area (area specified by hex object id, tag, #module, #self, or #area).
|-
| <code>#sa '''runupdater'''</code>
| <code>#sa runupdater</code>
| Run the ACR_UpdaterScript.cmd batch file in the NWNX4 installation directory (if it exists).
|-
| <code>#sa '''jump [object]'''</code>
| <code>#sa jump 010_wp_bg_docks_start</code>
| Jump to an object (by hex object id or tag).
|-
| <code>#sa '''compilerlog'''</code>
| <code>#sa compilerlog</code>
| Show last module recompilation log file.
|}


== Remote Scriptlets ==
The <code>#sa rs</code> command is rather powerful, able to accomplishing anything on a server, with enough technical knowledge. [[NWScript]] functions can be called by using <code>$s.'''[FunctionName]'''( '''[Parameters]''' );</code>.

=== Special Words ===
Placing these in your scriptlet will provide a special target or value.
{| class="wikitable_standard leftLastColumn"
! Command
! Description
|-
| <code>$CreatureAI</code>
| Refers to the AIServer object.
|-
| <code>$OBJECT_SELF</code>
| Refers to you, or what you are currently controlling.
|-
| <code>$OBJECT_TARGET</code>
| Refers to the currently selected target. A target can be defined by right clicking them, as you would as a player.
|-
| <code>$OBJECT_INVALID</code>
| An invalid object.
|-
| <code>$s</code>
| The scripting environment. This can be used to reference NWScript constants and functions.
|-
| <code>$sql</code>
| References the SQL database object, for calling queries. 
|}

=== Useful Commands ===
Below are some commands used by HDMs, as well as a description of what they do.
{| class="wikitable_standard leftLastColumn"
! Command
! Description
|-
| <code>#sa rs $s.ClearScriptParams(); $s.AddScriptParameterObject( $OBJECT_TARGET ); $s.AddScriptParameterInt( 0 ); $s.AddScriptParameterInt( '''[X]''' ); $s.AddScriptParameterInt( 0 ); $s.ExecuteScriptEnhanced( "ACR_Items", $OBJECT_SELF, 1 );</code>
| Alters an item's price by '''[X]'''. For instance, a value of -1283 would adjust the item's value by negative 1283 gold.
|-
| <code>#sa rs $s.ApplyEffectToObject( $s.DURATION_TYPE_INSTANT, $s.EffectDamage( '''[DAMAGE]''', $s.DAMAGE_TYPE_MAGICAL, $s.DAMAGE_POWER_NORMAL, $s.TRUE ), $OBJECT_TARGET, 0.0 );</code>
| Deals '''[DAMAGE]''' damage to the currently selected object.
|-
| <code>#sa rs $s.CreateItemOnObject( "'''[ITEM_RESREF]'''", $OBJECT_SELF, 1, "", 1 );</code>
| Creates a single item with ResRef '''[ITEM_RESREF]''' on the currently controlled character.
|-
| <code>#sa rs $s.GetResRef( $OBJECT_TARGET );</code>
| Returns the ResRef of the currently selected object.
|-
| <code>#sa rs $s.NWNXSetString( "OBJECTATTRIBUTES","SetWingVariation","",$s.ObjectToInt($OBJECT_TARGET), 16 );</code>
| As an example, this would provide wings of ID 16 to the currently selected object. With tweaking, this command could set a hair style, or head variation.
|-
| <code>#sa rs $s.SetCollision( $OBJECT_TARGET, 0 );</code>
| Turns collision off on the currently selected targets.
|-
| <code>#sa rs $s.SetWeather( $s.GetArea( $OBJECT_SELF ), 0, 0 );</code>
| Make it stop raining in the current area. Change the last parameter to 0-15 to indicate the strength of rain, with 0 being none and 15 being stormy.
|-
| <code>#sa rs foreach( $object in $s.GetItemPropertiesOnItem( $s.GetPlayerCurrentTarget( $OBJECT_SELF ) ) ) { if( $s.GetItemPropertyType( $object ) -eq 21 ) { $s.RemoveItemProperty( $s.GetPlayerCurrentTarget( $OBJECT_SELF ), $object); } } $s.DeleteLocalInt( $OBJECT_TARGET, "ACR_NLD_DAMAGE_PENALTY" );</code>
| Strip the damage penalty properties from a targeted item.
|-
| <code>#sa rs foreach( $object in $s.GetItemPropertiesOnItem( $s.GetPlayerCurrentTarget( $OBJECT_SELF ) ) ) { if( $s.GetItemPropertyType( $object ) -eq 82 ) { $s.RemoveItemProperty( $s.GetPlayerCurrentTarget( $OBJECT_SELF ), $object ); } }</code>
| Strip on hit cast spell (like, say, a subdual item's unique power) from a targeted item.
|-
|<code>#sa rs $s.ClearScriptParams(); $s.AddScriptParameterObject($OBJECT_TARGET); $s.AddScriptParameterInt(0); $s.AddScriptParameterInt(-2); $s.AddScriptParameterInt(0); $s.ExecuteScriptEnhanced("ACR_Items", $OBJECT_SELF, 1);</code>
| Reduce the price of a targeted item by 2 gold. The -2 in the second SetScriptParameterInt can be changed to any 32 bit integer (-2,147,483,648 to 2,147,483,647) to make the price adjust by that much. However, the total price must also be a 32 bit integer (so adding 2,147,843,647 to any positive integer will cause a memory overflow and corrupt the item).
|}
Return to Server Admin Remote Scriptlet.
Retrieved from "https://www.alandfaraway.info/wiki/Server_Admin_Remote_Scriptlet"
View source for Server Admin Remote Scriptlet

Navigation menu

Personal tools

Namespaces

Variants

Views

More

Search

Navigation

Tools
