Difference between revisions of "CS Functions"

Latest revision as of 14:39, 17 June 2011

This page lists all native CS scripting functions. For a more comprehensive list (including OBSE and OBSE plugin functions), see List of Functions.

Editors: Do not edit entries on this page. See Raw Function List for more info.

Contents
0–9 A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

A[edit | edit source]

Source	Function	Description - A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
CS	Activate	Activate object.
CS	AddAchievement	XBox only. Adds the said achievement to the player's profile.
CS	AddFlames	Add FlameNode to object.
CS	AddItem	Add item to actor.
CS	AddScriptPackage	Add script package to actor (not player)
CS	AddSpell	Add spell/ability/disease to actor.
CS	AddTopic	Add new topic to actor (not player).
CS	AdvancePCLevel	Increases player level.
CS	AdvancePCSkill	Increases player skill.
CS	Autosave	Saves game.

C[edit | edit source]

Source	Function	Description - A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
CS	CanHaveFlames	Returns 1 if the object can have flames.
CS	CanPayCrimeGold	Returns 1 if actor can pay crime gold, 0 if not.
CS	Cast	The optional object will cast the spell you specify on the object.
CS 1.2	ClearOwnership	Removes all ownership to the item in question.
CS	CloseCurrentOblivionGate	Resets current Oblivion gate
CS	CloseOblivionGate	Resets Oblivion gate.
CS	CompleteQuest	Completes quest.
CS	CreateFullActorCopy	Creates a copy of the specified actor with the actor's inventory and AI.

D[edit | edit source]

Source	Function	Description - A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
CS	DeleteFullActorCopy	Deletes a copy created via the CreateFullActorCopy function.
CS	Disable	Disables the specified reference.
CS	DisableLinkedPathPoints	Disables all path points linked to the reference.
CS	DisablePlayerControls	Disables player controls except looking around.
CS	Dispel	Removes the specified spell from the reference. It acts as a return in spell scripts.
CS	DispelAllSpells	Removes all current spells/magic that are effecting an actor.
CS	Drop
CS	DropMe
CS	DuplicateAllItems	Duplicates all items from the reference to the container specified.
CS	DuplicateNPCStats

E[edit | edit source]

Source	Function	Description - A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
CS	Enable
CS	EnableFastTravel
CS	EnableLinkedPathPoints
CS	EnablePlayerControls
CS	EquipItem
CS	EssentialDeathReload
CS	EvaluatePackage

F[edit | edit source]

Source	Function	Description - A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
CS	ForceActorValue
CS	ForceCloseOblivionGate
CS	ForceFlee
CS	ForceTakeCover
CS	ForceWeather

G[edit | edit source]

Source	Function	Description - A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
CS	GetActionRef
CS	GetActorValue
CS	GetAlarmed
CS	GetAmountSoldStolen
CS	GetAngle
CS	GetArmorRating
CS	GetArmorRatingUpperBody
CS	GetAttacked
CS	GetBarterGold
CS	GetBaseActorValue
CS	GetButtonPressed
CS	GetClassDefaultMatch
CS	GetClothingValue
CS	GetCombatTarget
CS	GetContainer
CS	GetCrime
CS	GetCrimeGold
CS	GetCrimeKnown
CS	GetCurrentAIPackage
CS	GetCurrentAIProcedure
CS	GetCurrentTime
CS	GetCurrentWeatherPercent
CS	GetDayOfWeek
CS	GetDead
CS	GetDeadCount
CS	GetDestroyed
CS	GetDetected
CS	GetDetectionLevel
CS	GetDisabled
CS	GetDisposition
CS	GetDistance
CS	GetDoorDefaultOpen
CS	GetEquipped
CS	GetFactionRank
CS	GetFactionRankDifference
CS	GetFactionReaction
CS	GetFatiguePercentage
CS	GetForceRun
CS	GetForceSneak
CS	GetFriendHit
CS	GetFurnitureMarkerID
CS	GetGameSetting
CS	GetGlobalValue
CS	GetGold
CS	GetHeadingAngle
CS	GetIdleDoneOnce
CS	GetIgnoreFriendlyHits
CS	GetInCell
CS	GetInCellParam
CS	GetInFaction
CS	GetInSameCell
CS	GetInvestmentGold
CS	GetInWorldspace
CS	GetIsAlerted
CS	GetIsClass
CS	GetIsClassDefault
CS	GetIsCreature
CS	GetIsCurrentPackage
CS	GetIsCurrentWeather
CS	GetIsGhost
CS	GetIsID
CS	GetIsPlayableRace
CS	GetIsPlayerBirthsign
CS	GetIsRace
CS	GetIsReference
CS	GetIsSex
CS	GetIsUsedItem
CS	GetIsUsedItemType
CS	GetItemCount
CS	GetKnockedState
CS	GetLevel
CS	GetLocked
CS	GetLockLevel
CS	GetLOS
CS	GetNoRumors
CS	GetOffersServicesNow
CS	GetOpenState
CS	GetPackageTarget
CS	GetParentRef
CS	GetPCExpelled
CS	GetPCFactionAttack
CS	GetPCFactionMurder
CS	GetPCFactionSteal
CS	GetPCFactionSubmitAuthority
CS	GetPCFame
CS	GetPCInFaction
CS	GetPCInfamy
CS	GetPCIsClass
CS	GetPCIsRace
CS	GetPCIsSex
CS	GetPCMiscStat
CS	GetPCSleepHours
CS	GetPersuasionNumber
CS	GetPlayerControlsDisabled
CS	GetPlayerHasLastRiddenHorse
CS 1.2	GetPlayerInSEWorld	Should be 1 if player is in Shivering Isles.
CS	GetPos
CS	GetQuestRunning
CS	GetQuestVariable
CS	GetRandomPercent
CS	GetRestrained
CS	GetScale
CS	GetScriptVariable
CS	GetSecondsPassed
CS	GetSelf
CS	GetShouldAttack
CS	GetSitting
CS	GetSleeping
CS	GetStage
CS	GetStageDone
CS	GetStartingAngle
CS	GetStartingPos
CS	GetTalkedToPC
CS	GetTalkedToPCParam
CS	GetTimeDead
CS	GetTotalPersuasionNumber
CS	GetTrespassWarningLevel
CS	GetUnconscious
CS	GetUsedItemActivate
CS	GetUsedItemLevel
CS	GetVampire
CS	GetWalkSpeed
CS	GetWeaponAnimType
CS	GetWeaponSkillType
CS	GetWindSpeed
CS	GoToJail

H[edit | edit source]

Source	Function	Description - A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
CS	HasFlames
CS	HasMagicEffect
CS	HasVampireFed

I[edit | edit source]

Source	Function	Description - A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
CS	IsActionRef
CS	IsActor
CS	IsActorAVictim
CS	IsActorDetected
CS	IsActorEvil
CS	IsActorsAIOff
CS	IsActorUsingATorch
CS	IsAnimPlaying
CS	IsCellOwner
CS	IsCloudy
CS	IsContinuingPackagePCNear
CS	IsCurrentFurnitureObj
CS	IsCurrentFurnitureRef
CS	IsEssential
CS	IsFacingUp
CS	IsGuard
CS	IsHorseStolen
CS	IsIdlePlaying
CS	IsInCombat
CS	IsInDangerousWater
CS	IsInInterior
CS	IsInMyOwnedCell
CS	IsLeftUp
CS	IsOwner
CS	IsPCAMurderer
CS	IsPCSleeping
CS	IsPlayerInJail
CS	IsPlayerMovingIntoNewSpace
CS	IsPlayersLastRiddenHorse
CS	IsPleasant
CS	IsRaining
CS	IsRidingHorse
CS	IsRunning
CS	IsShieldOut
CS	IsSneaking
CS	IsSnowing
CS	IsSpellTarget
CS	IsSwimming
CS	IsTalking
CS	IsTimePassing
CS	IsTorchOut
CS	IsTrespassing
CS	IsTurnArrest
CS	IsWaiting
CS	IsWeaponOut
CS	IsXBox
CS	IsYielding

K[edit | edit source]

Source	Function	Description - A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
CS	Kill
CS	KillAllActors

L[edit | edit source]

Source	Function	Description - A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
CS	Lock
CS	Look
CS	LoopGroup

M[edit | edit source]

Source	Function	Description - A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
CS	MenuMode (Function)
CS	Message
CS	MessageBox
CS	ModActorValue
CS	ModAmountSoldStolen
CS	ModBarterGold
CS	ModCrimeGold
CS	ModDisposition
CS	ModFactionRank
CS	ModFactionReaction
CS	ModPCAttribute
CS	ModPCFame
CS	ModPCInfamy
CS	ModPCMiscStat
CS	ModPCSkill
CS	ModScale
CS	MoveTo
CS	MoveToMarker

P[edit | edit source]

Source	Function	Description - A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
CS	PayFine
CS	PayFineThief
CS	PickIdle
CS	PlaceAtMe
CS	PlayBink
CS	PlayGroup
CS	PlayMagicEffectVisuals
CS	PlayMagicShaderVisuals
CS	PlaySound
CS	PlaySound3D
CS	PositionCell
CS	PositionWorld
CS	PreloadMagicEffect
CS 1.2	PurgeCellBuffers
CS 1.2	PushActorAway	Pushes a target actor away from the caller.

R[edit | edit source]

Source	Function	Description - A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
CS	RefreshTopicList
CS	ReleaseWeatherOverride
CS	RemoveAllItems
CS	RemoveFlames
CS	RemoveItem
CS	RemoveMe
CS	RemoveScriptPackage
CS	RemoveSpell
CS	Reset3DState
CS	ResetFallDamageTimer
CS	ResetHealth
CS	ResetInterior
CS	Resurrect
CS	Rotate

S[edit | edit source]

Source	Function	Description - A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
CS	SameFaction
CS	SameFactionAsPC
CS	SameRace
CS	SameRaceAsPC
CS	SameSex
CS	SameSexAsPC
CS	Say
CS	SayTo
CS	ScriptEffectElapsedSeconds
CS	SelectPlayerSpell
CS	SendTrespassAlarm
CS	SetActorAlpha
CS	SetActorFullName
CS	SetActorRefraction
CS 1.2	SetActorsAI	Activates/de-activates actor's AI.
CS	SetActorValue
CS	SetAlert
CS	SetAllReachable
CS	SetAllVisible
CS	SetAngle
CS	SetAtStart
CS	SetBarterGold
CS	SetCellFullName
CS	SetCellOwnership
CS	SetCellPublicFlag
CS	SetClass
CS	SetCombatStyle
CS	SetCrimeGold
CS	SetDestroyed
CS	SetDoorDefaultOpen
CS	SetEssential
CS	SetFactionRank
CS	SetFactionReaction
CS	SetForceRun
CS	SetForceSneak
CS	SetGhost
CS	SetIgnoreFriendlyHits
CS	SetInCharGen
CS	SetInvestmentGold
CS	SetItemValue
CS	SetLevel
CS	SetNoAvoidance
CS	SetNoRumors
CS	SetOpenState
CS	SetOwnership
CS	SetPackDuration
CS	SetPCExpelled
CS	SetPCFactionAttack
CS	SetPCFactionMurder
CS	SetPCFactionSteal
CS	SetPCFactionSubmitAuthority
CS	SetPCFame
CS	SetPCInfamy
CS	SetPCSleepHours
CS 1.2	SetPlayerInSEWorld	Should be 1 if player is in Shivering Isles.
CS	SetPos
CS	SetQuestObject
CS	SetRestrained
CS	SetRigidBodyMass
CS	SetScale
CS	SetSceneIsComplex
CS	SetShowQuestItems
CS	SetSize
CS	SetStage
CS	SetUnconscious
CS	SetWeather
CS	ShowBirthsignMenu
CS	ShowClassMenu
CS	ShowDialogSubtitles
CS	ShowEnchantment
CS	ShowMap
CS	ShowRaceMenu
CS	ShowSpellMaking
CS	SkipAnim
CS	StartCombat
CS	StartConversation
CS	StartQuest
CS	StopCombat
CS	StopCombatAlarmOnActor
CS	StopLook
CS	StopMagicEffectVisuals
CS	StopMagicShaderVisuals
CS	StopQuest
CS	StopWaiting
CS	StreamMusic

T[edit | edit source]

Source	Function	Description - A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
CS	This
CS	ToggleActorsAI
CS	TrapUpdate
CS	TriggerHitShader

U[edit | edit source]

Source	Function	Description - A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
CS	UnequipItem
CS	Unlock

V[edit | edit source]

Source	Function	Description - A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
CS	VampireFeed

W[edit | edit source]

Source	Function	Description - A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
CS	Wait
CS	WakeUpPC
CS	WhichServiceMenu

Y[edit | edit source]

Source	Function	Description - A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
CS	Yield	Forces the actor to yield to its current target. If their disposition towards the enemy is lower than the actor's aggression they will start combat again.

@@ Line 14: / Line 14: @@
 |CS || [[Activate]] || Activate object.
 |-
-|CS || [[AddAchievement]] ||
+|CS || [[AddAchievement]] || XBox only. Adds the said achievement to the player's profile.
 |-
-|CS || [[AddFlames]] ||
+|CS || [[AddFlames]] || Add FlameNode to object.
 |-
-|CS || [[AddItem]] ||
+|CS || [[AddItem]] || Add item to actor.
 |-
-|CS || [[AddScriptPackage]] ||
+|CS || [[AddScriptPackage]] || Add script package to actor (not player)
 |-
 |CS || [[AddSpell]] || Add spell/ability/disease to actor.
 |-
-|CS || [[AddTopic]] ||
+|CS || [[AddTopic]] || Add new topic to actor (not player).
 |-
-|CS || [[AdvancePCLevel]] ||
+|CS || [[AdvancePCLevel]] || Increases player level.
 |-
-|CS || [[AdvancePCSkill]] ||
+|CS || [[AdvancePCSkill]] || Increases player skill.
 |-
-|CS || [[Autosave]] ||
+|CS || [[Autosave]] || Saves game.
 |}
@@ Line 40: / Line 40: @@
 !align=left|Description - [[#A|A]][[#B|B]][[#C|C]][[#D|D]][[#E|E]][[#F|F]][[#G|G]][[#H|H]][[#I|I]][[#J|J]][[#K|K]][[#L|L]][[#M|M]][[#N|N]][[#O|O]][[#P|P]][[#Q|Q]][[#R|R]][[#S|S]][[#T|T]][[#U|U]][[#V|V]][[#W|W]][[#X|X]][[#Y|Y]][[#Z|Z]]
 |-
-|CS || [[CanHaveFlames]] ||
+|CS || [[CanHaveFlames]] || Returns 1 if the object can have flames.
 |-
-|CS || [[CanPayCrimeGold]] ||
+|CS || [[CanPayCrimeGold]] || Returns 1 if actor can pay crime gold, 0 if not.
 |-
-|CS || [[Cast]] ||
+|CS || [[Cast]] || The optional object will cast the spell you specify on the object.
 |-
 |CS 1.2 || [[ClearOwnership]] || Removes all ownership to the item in question.
 |-
-|CS || [[CloseCurrentOblivionGate]] ||
+|CS || [[CloseCurrentOblivionGate]] || Resets current Oblivion gate
 |-
-|CS || [[CloseOblivionGate]] ||
+|CS || [[CloseOblivionGate]] || Resets Oblivion gate.
 |-
-|CS || [[CompleteQuest]] ||
+|CS || [[CompleteQuest]] || Completes quest.
 |-
-|CS || [[CreateFullActorCopy]] ||
+|CS || [[CreateFullActorCopy]] || Creates a copy of the specified actor with the actor's inventory and AI.
 |}
@@ Line 64: / Line 64: @@
 !align=left|Description - [[#A|A]][[#B|B]][[#C|C]][[#D|D]][[#E|E]][[#F|F]][[#G|G]][[#H|H]][[#I|I]][[#J|J]][[#K|K]][[#L|L]][[#M|M]][[#N|N]][[#O|O]][[#P|P]][[#Q|Q]][[#R|R]][[#S|S]][[#T|T]][[#U|U]][[#V|V]][[#W|W]][[#X|X]][[#Y|Y]][[#Z|Z]]
 |-
-|CS || [[DeleteFullActorCopy]] ||
+|CS || [[DeleteFullActorCopy]] || Deletes a copy created via the [[CreateFullActorCopy]] function.
 |-
-|CS || [[Disable]] ||
+|CS || [[Disable]] || Disables the specified reference.
 |-
-|CS || [[DisableLinkedPathPoints]] ||
+|CS || [[DisableLinkedPathPoints]] || Disables all path points linked to the reference.
 |-
-|CS || [[DisablePlayerControls]] ||
+|CS || [[DisablePlayerControls]] || Disables player controls except looking around.
 |-
-|CS || [[Dispel]] ||
+|CS || [[Dispel]] || Removes the specified spell from the reference. It acts as a return in spell scripts.
 |-
-|CS || [[DispelAllSpells]] ||
+|CS || [[DispelAllSpells]] || Removes all current spells/magic that are effecting an actor.
 |-
 |CS || [[Drop]] ||
@@ Line 80: / Line 80: @@
 |CS || [[DropMe]] ||
 |-
-|CS || [[DuplicateAllItems]] ||
+|CS || [[DuplicateAllItems]] || Duplicates all items from the reference to the container specified.
 |-
 |CS || [[DuplicateNPCStats]] ||
@@ Line 569: / Line 569: @@
 |-
 |CS || [[MoveToMarker]] ||
-|}
-===N===
-{| width=100% class=functionTable
-|-
-!align=left width=10%|Source
-!align=left width=35%|Function
-!align=left|Description - [[#A|A]][[#B|B]][[#C|C]][[#D|D]][[#E|E]][[#F|F]][[#G|G]][[#H|H]][[#I|I]][[#J|J]][[#K|K]][[#L|L]][[#M|M]][[#N|N]][[#O|O]][[#P|P]][[#Q|Q]][[#R|R]][[#S|S]][[#T|T]][[#U|U]][[#V|V]][[#W|W]][[#X|X]][[#Y|Y]][[#Z|Z]]
-|-
-|CS || [[NameIncludes]] ||
 |}
@@ Line 892: / Line 882: @@
 !align=left|Description - [[#A|A]][[#B|B]][[#C|C]][[#D|D]][[#E|E]][[#F|F]][[#G|G]][[#H|H]][[#I|I]][[#J|J]][[#K|K]][[#L|L]][[#M|M]][[#N|N]][[#O|O]][[#P|P]][[#Q|Q]][[#R|R]][[#S|S]][[#T|T]][[#U|U]][[#V|V]][[#W|W]][[#X|X]][[#Y|Y]][[#Z|Z]]
 |-
-|CS || [[Yield]] ||
+|CS || [[Yield]] || Forces the actor to yield to its current target. If their disposition towards the enemy is lower than the actor's aggression they will start combat again.
 |}
 [[Category:Scripting]]