Difference between revisions of "Category:Console Functions"

From the Oblivion ConstructionSet Wiki
Jump to navigation Jump to search
imported>Dysesothymteric
m (linked to page Debug_Text)
imported>8asrun6aer
 
(24 intermediate revisions by 15 users not shown)
Line 1: Line 1:
These functions are only available for use in the in-game console. They cannot be compiled into scripts in the editor. You can scroll the console output by using PageUp and PageDown.
The functions included in this Category should be only available for use in the in-game [[Glossary#C|console]] -- that is, functions that cannot be compiled into scripts in the editor (unless you are using the [[:Category:Oblivion Script Extender|Oblivion Script Extender]], which allows [[:Category:Console Functions (OBSE)|some of these]] to be used in scripts).
 
However, some Console commands listed in the following '''table''' may be available for use both as functions and commands. For additional context, see the article [[Console Commands]].
 
==Notes==
*The console is invoked by pressing the "~" key. This is the key below "Esc", to the left of the "1" key. Different keyboard configurations may have different symbols on that key. Windows Vista users may not be able to invoke the console this way - see the Discussion page for possible solutions instead.
*You can scroll the console output by using the [Page Up] and [Page Down] keys.
*Batch files can be used for console commands by creating a basic .txt file containing the commands you want to call in-game. Save this file in your main Oblivion directory with a meaningful name and when in-game bring up the console and type "Bat filename.txt" to call the commands. Especially useful for playtesting mods when toggling functions on or off rather than inputting the console commands one at a time.
 


{| style="width: 100%; border-collapse: collapse" border="1"
{| style="width: 100%; border-collapse: collapse" border="1"
Line 22: Line 30:
| BeginTrace
| BeginTrace
| bt
| bt
| Creates a trace file (xbox only)
| Creates a trace file (Xbox version only).
| False
| False
|  
|  
Line 29: Line 37:
| BC
| BC
| Add comment to <nowiki>[General]</nowiki> 'sBetaCommentFile' file.
| Add comment to <nowiki>[General]</nowiki> 'sBetaCommentFile' file.
NOTE: select object first.
NOTE: select object first. Oblivion will crash if comment entered with no object selected.


'''bc &quot;This rock is too high.&quot;'''
'''bc &quot;This rock is too high.&quot;'''
Line 49: Line 57:
| CenterOnCell
| CenterOnCell
| COC
| COC
|  
| Move player to specified interior cell
| False
| False
| CellName
| CellName
Line 55: Line 63:
| CenterOnExterior
| CenterOnExterior
| COE
| COE
|  
| Move player to specified exterior cell coordinates
| False
| False
| x, y
| x, y
Line 61: Line 69:
| CenterOnWorld
| CenterOnWorld
| COW
| COW
| [COW worldname -10 5]
| Move player to specified cell in specified worldspace [COW worldname -10 5]
| False
| False
| WorldspaceName, CellCoordX, CellCoordY
| WorldspaceName, CellCoordX, CellCoordY
Line 103: Line 111:
| GetINISetting
| GetINISetting
| GetINI
| GetINI
|  
| Retrieves a setting from the Oblivion.ini file. ''c.f.'' [SetINI]
| False
| False
| SettingName
| SettingName
Line 115: Line 123:
| Help
| Help
|  
|  
| Show this help.
| Displays a selected list of console commands. ''c.f.'' [tfh] (toggleFullHelp).
| False
| False
|  
|  
Line 191: Line 199:
|  
|  
|-
|-
| PurgeCellBuffers
| [[PurgeCellBuffers]]
| pcb
| pcb
| Forcibly unloads all unattached cells in cell buffers.
| Forcibly unloads all unattached cells in cell buffers.
Line 214: Line 222:
| False
| False
|  
|  
|-
| Reload
|
| Reload &lt;MenuName&gt; Uses the MenuName tag found in the .xml file (i.e., InventoryMenu) Loads the menu. May close the menu if it's already open (i.e., LockPickMenu). Some menus don't seem to work (i.e., OptionsMenu) and odd results may occur (InventoryMenu doesn't work right until you press a button, menus overlap, etc.)
| False
| MenuName
|-
|-
| ReloadCurrentClimate
| ReloadCurrentClimate
Line 253: Line 267:
| SaveGame
| SaveGame
| save
| save
| SaveGame &lt;filename&gt;
| SaveGame &lt;filename&gt; Be aware that any existing savegame with the same name will be overwritten without confirmation.
| False
| False
| SaveName
| SaveName
Line 281: Line 295:
| fClipDistance
| fClipDistance
|-
|-
| SetDebugText
| [[Debug Text|SetDebugText]]
| sdt
| sdt
| Sets which debug text is shown.
| Sets which debug text is shown.
Line 319: Line 333:
| SetINISetting
| SetINISetting
| SetINI
| SetINI
|  
| Sets the desired setting in Oblivion.ini to the desired value while in-game. See [[Con_SetINISetting]] for syntax and details.
| False
| False
| sININame, sINIValue
| sININame, sINIValue
Line 325: Line 339:
| SetLightingPasses
| SetLightingPasses
| SLP
| SLP
| 4 (0/1) values. amb|diff|tex|spec ex: 1010
| 4 (0/1) values. <nowiki>amb|diff|tex|spec</nowiki> ex: 1010
| False
| False
| sBitFlag
| sBitFlag
Line 421: Line 435:
| ShowQuestVars
| ShowQuestVars
| SQV
| SQV
| Show quest variables. [svq QuestID]
| Show quest variables. [sqv QuestID]
| False
| False
| QuestID
| QuestID
Line 451: Line 465:
| ShowVars
| ShowVars
| SV
| SV
| Show variables on object. [player-&gt;sv]
| Show variables on object. Doesn't support [[reference variables]].[player-&gt;sv]
| True
| True
|  
|  
Line 764: Line 778:
| TWF
| TWF
| Show the world as wireframe.
| Show the world as wireframe.
| False
|
|-
| UseWorkbook
| UseWorkbook
| When you open any book in the world then use this command it will replace the text with what is in data\menus\workbook.html
| False
| False
|  
|  

Latest revision as of 18:22, 5 January 2012

The functions included in this Category should be only available for use in the in-game console -- that is, functions that cannot be compiled into scripts in the editor (unless you are using the Oblivion Script Extender, which allows some of these to be used in scripts).

However, some Console commands listed in the following table may be available for use both as functions and commands. For additional context, see the article Console Commands.

Notes[edit | edit source]

  • The console is invoked by pressing the "~" key. This is the key below "Esc", to the left of the "1" key. Different keyboard configurations may have different symbols on that key. Windows Vista users may not be able to invoke the console this way - see the Discussion page for possible solutions instead.
  • You can scroll the console output by using the [Page Up] and [Page Down] keys.
  • Batch files can be used for console commands by creating a basic .txt file containing the commands you want to call in-game. Save this file in your main Oblivion directory with a meaningful name and when in-game bring up the console and type "Bat filename.txt" to call the commands. Especially useful for playtesting mods when toggling functions on or off rather than inputting the console commands one at a time.


Function Name Short Name Description Reference Function Parameters
AddDecal False
AddFaceAnimNote AFAN True sString
BeginTrace bt Creates a trace file (Xbox version only). False
BetaComment BC Add comment to [General] 'sBetaCommentFile' file.

NOTE: select object first. Oblivion will crash if comment entered with no object selected.

bc "This rock is too high."

False sString
CalcLowPathToPoint LP2P ignore locks, allow disabled doors, ignore min use True bIgnoreLocks, bAllowDisabledDoors, bIgnoreMinUse
CalcPathToPoint P2P True
CenterOnCell COC Move player to specified interior cell False CellName
CenterOnExterior COE Move player to specified exterior cell coordinates False x, y
CenterOnWorld COW Move player to specified cell in specified worldspace [COW worldname -10 5] False WorldspaceName, CellCoordX, CellCoordY
ClearAdaptedLight cal Clears the HDR adapted light texture False
CloseFile False Filename
CompleteAllQuestStages caqs Sets all quest stages False
DumpTexturePalette DTP Dump texture palette contents to warning file (param is sort type: f-filename,s-size,c-count) False SortType (optional)
FlushNonPersistActors Flush Deletes all the actors in High who are not persistant False iCount
FreezeRenderAccumulation fra only re-render geometry visible during this frame False
GetINISetting GetINI Retrieves a setting from the Oblivion.ini file. c.f. [SetINI] False SettingName
HairTint 3 ints,RGB False iRed, iGreen, iBlue
Help Displays a selected list of console commands. c.f. [tfh] (toggleFullHelp). False
LoadGame load LoadGame <filename> False SaveName
ModWaterShader mws Modifies water shader settings False String, Float (optional)
MoveToQuestTarget movetoqt Move player to current quest target (optional param: target number, 1 to N). False QuestTargetNumber (optional)
OutputArchiveProfile oap Output Archive profile info to a file False String (optional)
OutputLocalMapPictures OLMP Writes out the current local map. False
OutputMemContexts omc Output Mem Context info to a file False Filename (optional)
OutputMemStats oms Output Mem Stats info to a file False Filename (optional)
PickRefByID PRID Select a reference by id for the console. False ObjectRefID
PlayerSpellBook psb Add all spells to player. False
PrintAiList pai Printed Ai Lists. False
PrintHDRParam PHP Prints current HDR settings. False
PrintNPCDialog pdialog Prints NPC dialog False
PurgeCellBuffers pcb Forcibly unloads all unattached cells in cell buffers. False
QuitGame qqq Exit game without going through menus. False
RefreshINI REFINI Refresh INI settings from file. False
RefreshShaders Reload HLSL shaders from disk False
Reload Reload <MenuName> Uses the MenuName tag found in the .xml file (i.e., InventoryMenu) Loads the menu. May close the menu if it's already open (i.e., LockPickMenu). Some menus don't seem to work (i.e., OptionsMenu) and odd results may occur (InventoryMenu doesn't work right until you press a button, menus overlap, etc.) False MenuName
ReloadCurrentClimate rcc Reloads values from the current climate False
ReloadCurrentWeather rcw Reloads values from the current weather False
ResetMemContexts rmc Reset Max Mem Contexts False
RevertWorld rw Revert the world False
RunCellTest rct Runs a cell test False iFlag (optional)
RunMemoryPass rmp Runs a cleanup memory pass False iFlag
SaveGame save SaveGame <filename> Be aware that any existing savegame with the same name will be overwritten without confirmation. False SaveName
SaveIniFiles saveini Writes all the .ini files. False
SaveWorld Save hkWorld <filename> False Filename
SetCameraFOV FOV Change the camera's field of view (in deg): default 75 False iDegrees
SetClipDist float,new clip distance False fClipDistance
SetDebugText sdt Sets which debug text is shown. False iDebugPage
SetFog 2 floats,start and end depths False fStartDepth, fEndDepth
SetGameSetting SetGS False sGSName, sGSValue
SetGamma sg Sets new gamma ramp. False fValue
SetHDRParam SHP Sets various values for the HDR shader False fEyeAdaptSpeed, fEmissiveHDRMult, fTreeDimmer, fGrassDimmer, fValue5, fValue6
SetImageSpaceGlow SISG False iValue1, fValue2, fValue3, fValue4
SetINISetting SetINI Sets the desired setting in Oblivion.ini to the desired value while in-game. See Con_SetINISetting for syntax and details. False sININame, sINIValue
SetLightingPasses SLP 4 (0/1) values. amb|diff|tex|spec ex: 1010 False sBitFlag
SetSkyParam SSP Sets various values for the sky False fValue1, fValue2
SetSTBBColorConstants sscc Show speedtree billboard color tweak constants. False fValue1, fValue2, fValue3, fValue4
SetTargetRefraction str Sets the refractive value of the target False fValue
SetTargetRefractionFire strf Sets the refractive fire value of the target False fValue1, iValue2
SetTreeMipmapBias stmb Set mipmap LOD bias values for tree billboards. False fValue1, fValue2
SexChange Selected npc male become female or female becomes male. False
Show TST Show values of script variables: show gamedayspassed False VarName
Show1stPerson S1ST Show the 1st person Model from the 3rd person camera. If in 3rd person mode it will show both. False
ShowAnim SA Show Animation and Actor status. True
ShowFullQuestLog SFQL Show all log entries for a single quest False QuestID
ShowHeadTrackTarget SHeadT Show the head track target if set from look function True
ShowPivot SP Puts a temporary yellow plus at the pivot point of the selected reference. True
ShowQuestLog SQL Show Quest Log. Optional flag: 0=current quests, 1=completed quests False bShowCompleted
ShowQuests SQ List quests. False
ShowQuestTargets SQT Show current quest targets False
ShowQuestVars SQV Show quest variables. [sqv QuestID] False QuestID
ShowRenderPasses srp display render passes for the next frame False
ShowScenegraph SSG Create a window with the full game scene graph. False
ShowSubSpaces sss Temporarily displays subspaces. False
ShowSubtitle show all dialog subtitles (1 shows always,0 hides always) False bFlag
ShowVars SV Show variables on object. Doesn't support reference variables.[player->sv] True
ShowWhoDetectsPlayer SWDP Show who detects the player False
SpeakSound True Filename, iEmotion, iEmotionValue
StartAllQuests saq Starts all quests False
TestAllCells TAC Test All Cells (0 - stop, 1 - start, 2 - interiors, 3 - current world) False iValue
TestCode False
TestLocalMap tlm Simulates the local map. (1 or 0 for FOW on or off) False iValue
TestSeenData tsd Visually displays the current seen data False
ToggleAI TAI False
ToggleAiSchedules TAIS False
ToggleBorders TB Show border lines for each cell. False
ToggleCastShadows tsh False iShadowType
ToggleCellNode TCN Toggle 3D for a Cell child node: 0-Actor, 1-Marker, 2-Land, 3-Water, 4-Static, 5-Active False iValue
ToggleCharControllerShape TCCS Toggle char controller shape type. False
ToggleCollision TCL False
ToggleCollisionGeometry TCG Show collision geometry. False
ToggleCombatAI tcai Toggles ALL Combat AI False
ToggleCombatStats TCS False
ToggleConversations TCONV Toggle conversation stats False
ToggleDebugText TDT Shows framerate(FPS) and debug numbers on the screen. False
ToggleDetection TDETECT False
ToggleDetectionStats tds Show the detection stats of the current seletected Ref. False
ToggleEmotions temo Toggle NPC facial emotions. False
ToggleFlyCam tfc Toggles the Free Fly camera (UFO cam). False
ToggleFogOfWar TFOW Turns fog of war on or off. False
ToggleFullHelp TFH Toggle Full Help False
ToggleGodMode TGM Toggle God mode False
ToggleGrass TG Toggle grass display. False
ToggleGrassUpdate TGU False
ToggleHDRDebug THD Toggles HDR debug textures. False
ToggleHighProcess THIGHPROCESS False
ToggleLeaves TLV False
ToggleLiteBrite tlb Toggles lite brite render mode. False
ToggleLODLand TLL False
ToggleLowProcess TLOWPROCESS False
ToggleMagicStats TMS False
ToggleMapMarkers tmm Toggle map markers (1 shows all, 0 hides all). False iValue
ToggleMaterialGeometry TMG Show material geometry. False
ToggleMenus TM Hide all the menus. Used for taking screen shots. False
ToggleMiddleHighProcess TMHIGHPROCESS False
ToggleMiddleLowProcess TMLOWPROCESS False
ToggleOcclusion tocc toggle occlusion query for geometry False
TogglePathGrid TPG Toggle blocked display. False
TogglePathLine TPL Toggle path display. False
ToggleRefractionDebug trd Toggles refraction debug render texture False
ToggleSafeZone TSZ Display the television 85% safe zone False
ToggleScripts TSCR Turn Script processing on/off False
ToggleShadowVolumes TSV False
ToggleSky TS False
ToggleTrees TT Turn trees on/off False
ToggleWaterRadius TWR False
ToggleWaterSystem TWS Toggles the water system False
ToggleWireframe TWF Show the world as wireframe. False
UseWorkbook UseWorkbook When you open any book in the world then use this command it will replace the text with what is in data\menus\workbook.html False
Verbose VERBOSE Toggle verbose combat/AI messages False
WaterDeepColor deep Modifies water deep color False iValue1, iValue2, iValue3
WaterReflectionColor refl Modifies water reflection color False iValue1, iValue2, iValue3
WaterShallowColor shallow Modifies water shallow color False iValue1, iValue2, iValue3

Subcategories

This category has only the following subcategory.

C

Pages in category "Console Functions"

The following 3 pages are in this category, out of 3 total.

D

H

P

Retrieved from "https://cs.uesp.net/w/index.php?title=Category:Console_Functions&oldid=2451"