Xordac: 1 revision imported

2017-10-23T23:23:26Z

1 revision imported

New page

=PC Only Function Category=

Functions that affect a PC only.

<br /><br />

====Functions====

{| border="1" cellpadding="5"
! Name
! Brief Description
|-
|
[[ActionExamine | ActionExamine ]]
| Examine an object
|-
|
[[ActivatePortal | ActivatePortal ]]
| Send a player's client to a new server, where the player's character will log in.
|-
|
[[ApplyPenalty | ApplyPenalty ]]
| Applies the penalty for respawn for the resurrecting PC.
|-
|
[[BootPC | BootPC ]]
| Abruptly kicks a player off a multi-player server.
|-
|
[[DayToNight | DayToNight ]]
| Changes the current Day/Night cycle for this player to night
|-
|
[[DoSinglePlayerAutoSave | DoSinglePlayerAutoSave ]]
| Saves a single player game.
|-
|
[[FadeFromBlack | FadeFromBlack ]]
| Fades the screen from black into normal view.
|-
|
[[FadeToBlack | FadeToBlack ]]
| Fades the screen for a given player to black.
|-
|
[[FloatingTextStringOnCreature | FloatingTextStringOnCreature ]]
| Briefly displays ambient text above targets head.
|-
|
[[FloatingTextStrRefOnCreature | FloatingTextStrRefOnCreature ]]
| Briefly displays a string ref as ambient text above targets head.
|-
|
[[GetIsPC | GetIsPC ]]
| Check whether a creature is player controlled.
|-
|
[[GetIsPlayerCharacter | GetIsPlayerCharacter ]]
| Check to see if target is PC and not DM.
|-
|
[[GetJournalQuestExperience | GetJournalQuestExperience ]]
| Returns the amount of experience set for a journal category.
|-
|
[[GetLastPCRested | GetLastPCRested ]]
| Returns the last PC that rested.
|-
|
[[GetLastPCToCancelCutscene | GetLastPCToCancelCutscene ]]
| Retrieves the last player to leave a cut-scene.
|-
|
[[GetLastPlayerDied | GetLastPlayerDied ]]
| Determines the last PC that died.
|-
|
[[GetLastPlayerDying | GetLastPlayerDying ]]
| Retrieves the last player that is currently dying.
|-
|
[[GetLastRespawnButtonPresser | GetLastRespawnButtonPresser ]]
| Gets the last PC that clicked the Respawn button.
|-
|
[[GetLastRestEventType | GetLastRestEventType ]]
| Determines the status of the last PC rest.
|-
|
[[GetPCChatMessage | GetPCChatMessage ]]
| Retrieves the last player chat message that was sent.
|-
|
[[GetPCChatSpeaker | GetPCChatSpeaker ]]
| Retrieves the PC that sent the last player chat message.
|-
|
[[GetPCChatVolume | GetPCChatVolume ]]
| Retrieves the volume of the last player chat message that was sent.
|-
|
[[GetPCIPAddress | GetPCIPAddress ]]
| Retrieves the IP address of a PC.
|-
|
[[GetPCLevellingUp | GetPCLevellingUp ]]
| Retrieves reference to the last PC that levelled up.
|-
|
[[GetPCPlayerName | GetPCPlayerName ]]
| Retrieves the login name of the player of a PC.
|-
|
[[GetPCPublicCDKey | GetPCPublicCDKey ]]
| Retrieves the public version of the PC's CD key.
|-
|
[[GetPCSpeaker | GetPCSpeaker ]]
| Retrieves the PC that is currently in a conversation with an NPC.
|-
|
[[NightToDay | NightToDay ]]
| Changes the current Day/Night cycle for this player to daylight
|-
|
[[LockCameraDirection | LockCameraDirection ]]
| Locks the player's camera direction to its current direction, or unlocks the player's camera direction to enable it to move freely again.
|-
|
[[LockCameraDistance | LockCameraDistance ]]
| Locks the player's camera distance to its current distance setting, or unlocks the player's camera distance.
|-
|
[[LockCameraPitch | LockCameraPitch ]]
| Locks the player's camera pitch to its current pitch setting, or unlocks the player's camera pitch. Stops the player from tilting their camera angle.
|-
|
[[PopUpDeathGUIPanel | PopUpDeathGUIPanel ]]
| Displays a customizable death panel.
|-
|
[[Raise | Raise ]]
| Raises a PC from death.
|-
|
[[RemoveEffects | RemoveEffects ]]
| Removes all negative effects from a creature.
|-
|
[[RestoreCameraFacing | RestoreCameraFacing ]]
| Restores the camera mode and facing.
|-
|
[[RewardPartyXP | RewardPartyXP ]]
| Gives experience to a PC and (optionally) all party members.
|-
|
[[SendMessageToPC | SendMessageToPC ]]
| Sends a message to the PC.
|-
|
[[SendMessageToPCByStrRef | SendMessageToPCByStrRef ]]
| Send a message to a player
|-
|
[[SetCameraFacing | SetCameraFacing ]]
| Changes the direction the player's camera is facing.
|-
|
[[SetCameraHeight | SetCameraHeight ]]
| Sets the camera to a certain height
|-
|
[[SetCutsceneMode | SetCutsceneMode ]]
| Sets the cut-scene mode.
|-
|
[[SetPCChatMessage | SetPCChatMessage ]]
| Sets the last player chat message before it gets sent to other players.
|-
|
[[SetPCChatVolume | SetPCChatVolume ]]
| Sets the last player chat volume before it gets sent to other players.
|-
|
[[StringToRGBString | StringToRGBString ]]
| Given a string and an RGB color encoded string, this function returns an equivalent string that will display in the specified color.
|-
|
[[StoreCameraFacing | StoreCameraFacing ]]
| Stores the camera facing and position so it can be restored later.
|}

----
[[Category:Functions]]
[[Category:Function_Categories]]

Category:PC Only Functions - Revision history

Xordac: 1 revision imported