Xordac: 1 revision imported

2017-10-23T23:23:24Z

1 revision imported

New page

=Miscellaneous Function Category=

Functions that don't fit into any other category.

<br /><br />

====Functions====

{| border="1" cellpadding="5"
! Name
! Brief Description
|-
|
[[ActionExamine | ActionExamine ]]
| Examine an object
|-
|
[[ActionWait | ActionWait ]]
| Adds a wait action to an objects queue.
|-
|
[[BootPC | BootPC ]]
| Abruptly kicks a player off a multi-player server.
|-
|
[[CopyObject | CopyObject ]]
| Duplicates the object specified.
|-
|
[[d2 | d2 ]]
| Rolls a 2-sided die (or flips a coin).
|-
|
[[d3 | d3 ]]
| Rolls a 3-sided die.
|-
|
[[d4 | d4 ]]
| Rolls a 4-sided die.
|-
|
[[d6 | d6 ]]
| Rolls a 6-sided die.
|-
|
[[d8 | d8 ]]
| Rolls an 8-sided die.
|-
|
[[d10 | d10 ]]
| Rolls a 10-sided die.
|-
|
[[d12 | d12 ]]
| Rolls a 12-sided die.
|-
|
[[d20 | d20 ]]
| Rolls a 20-sided die.
|-
|
[[d100 | d100 ]]
| Rolls a 100-sided die.
|-
|
[[DrinkIt | DrinkIt ]]
| Makes a creature speak a string that signifies they drank alcohol.
|-
|
[[ExecuteScript | ExecuteScript ]]
| Cause a script to execute.
|-
|
[[ExportSingleCharacter | ExportSingleCharacter ]]
| Force the character of the player specified to be exported to its respective directory, i.e. LocalVault/ServerVault/ etc.
|-
|
[[GetActionMode | GetActionMode ]]
| Check if a creature is using a given action mode
|-
|
[[GetAngleBetweenLocations | GetAngleBetweenLocations ]]
| Returns a float representing the angle between Location One and Location Two
|-
|
[[GetAssassinHead | GetAssassinHead ]]
| Gets the tag of the Assassins head object used in a plot in the official release game.
|-
|
[[GetChangedPosition | GetChangedPosition ]]
| Convenience function that returns a vector that is fDistance away in fAngle direction
|-
|
[[GetChangeInX | GetChangeInX ]]
| Convenience function to calculate the change in the X axis
|-
|
[[GetChangeInY | GetChangeInY ]]
| Convenience function that calculates the change in the Y axis to the target
|-
|
[[GetCustomLeftDirection | GetCustomLeftDirection ]]
| This function returns a normalized number that is the sum of the current facing and the angle to target
|-
|
[[GetCustomRightDirection | GetCustomRightDirection ]]
| This returns a float that is a normalized remainder of fDirection - fAngle
|-
|
[[GetFarLeftDirection | GetFarLeftDirection ]]
| This function returns a normalized number that is +135 from the current facing
|-
|
[[GetFarRightDirection | GetFarRightDirection ]]
| Returns a normalized number that is -135 from the current facing
|-
|
[[GetFirstInPersistentObject | GetFirstInPersistentObject ]]
| Determines the first object of a specific type that is inside a persistent object.
|-
|
[[GetFirstObjectInShape | GetFirstObjectInShape ]]
| Determines the first object of a specific type (creature, door etc.) in shape.
|-
|
[[GetGameDifficulty | GetGameDifficulty ]]
| Determines the game difficulty setting.
|-
|
[[GetHalfLeftDirection | GetHalfLeftDirection ]]
| This function returns a number that is +45 degrees from the current facing
|-
|
[[GetHalfRightDirection | GetHalfRightDirection ]]
| Returns a normalized value that is -45 from fDirection
|-
|
[[GetIsDead | GetIsDead ]]
| Determines if a creature is dead or dying.
|-
|
[[GetIsEnemy | GetIsEnemy ]]
| Determines whether a creature considers another creature an enemy.
|-
|
[[GetIsImmune | GetIsImmune ]]
| Determines whether a creature has a specific immunity.
|-
|
[[GetIsNeutral | GetIsNeutral ]]
| Check whether a creature considers another creature to be neutral to them.
|-
|
[[GetItemCursedFlag | GetItemCursedFlag ]]
| Checks if an item is cursed
|-
|
[[GetLastPCRested | GetLastPCRested ]]
| Returns the last PC that rested.
|-
|
[[GetLastRespawnButtonPresser | GetLastRespawnButtonPresser ]]
| Gets the last PC that clicked the Respawn button.
|-
|
[[GetLeftDirection | GetLeftDirection ]]
| This function returns a float representing a direction +90 degrees
|-
|
[[GetMyMaster | GetMyMaster ]]
| Gets the nearest Player Character to the calling object.
|-
|
[[GetNextInPersistentObject | GetNextInPersistentObject ]]
| Determines the nextobject of a specific type that is inside a persistent object.
|-
|
[[GetNextObjectInShape | GetNextObjectInShape ]]
| Determines the next object of a specific type (creature, door etc) in shape.
|-
|
[[GetNormalizedDirection | GetNormalizedDirection ]]
| This function returns a float that is constrained from 0 - 360
|-
|
[[GetOppositeDirection | GetOppositeDirection ]]
| Returns a normalized direction that is -180 from fDirection
|-
|
[[GetPositionFromLocation | GetPositionFromLocation ]]
| Returns the vector part of a location.
|-
|
[[GetRightDirection | GetRightDirection ]]
| Returns a normalized float that is -90 from the facing passed in
|-
|
[[GetUserDefinedEventNumber | GetUserDefinedEventNumber ]]
| Determines the specific user-defined number that has been sent to it.
|-
|
[[GiveRingToPlayer | GiveRingToPlayer ]]
| Creates a plot ring and places it in a player's inventory.
|-
|
[[PopUpGUIPanel | PopUpGUIPanel ]]
| Displays a GUI panel to a player.
|-
|
[[PrintString | PrintString ]]
| Records a message to the log file.
|-
|
[[RandomName | RandomName ]]
| Generates a random name.
|-
|
[[RestoreCameraFacing | RestoreCameraFacing ]]
| Restores the camera mode and facing.
|-
|
[[SetActionMode | SetActionMode ]]
| Sets the status of an action mode on a creature
|-
|
[[SetAreaTransitionBMP | SetAreaTransitionBMP ]]
| Sets the graphic shown when a PC moves between two different areas in a module.
|-
|
[[SetCameraFacing | SetCameraFacing ]]
| Changes the direction the player's camera is facing.
|-
|
[[SetCameraHeight | SetCameraHeight ]]
| Sets the camera to a certain height
|-
|
[[SetCameraMode | SetCameraMode ]]
| Changes the perspective view of the player on the screen.
|-
|
[[SetCommandable | SetCommandable ]]
| Makes NPC available for new instructions.
|-
|
[[SetCustomToken | SetCustomToken ]]
| Sets the value for a custom token.
|-
|
[[SetDeity | SetDeity ]]
| Set the deity of a creature or PC
|-
|
[[SetDroppableFlag | SetDroppableFlag ]]
| Marks an item as droppable or undroppable.
|-
|
[[SetImmortal | SetImmortal ]]
| Sets a creature as immortal.
|-
|
[[SetItemCursedFlag | SetItemCursedFlag ]]
| Sets whether an item is cursed or not
|-
|
[[SetMapPinEnabled | SetMapPinEnabled ]]
| Enable a map pin.
|-
|
[[SetPhenoType | SetPhenoType ]]
| Sets the creature's PhenoType (body type) to the type specified.
|-
|
[[SetPlotFlag | SetPlotFlag ]]
| Sets an object's plot status.
|-
|
[[SetSubRace | SetSubRace ]]
| Sets or changes a creature's or PC's subrace
|-
|
[[SignalEvent | SignalEvent ]]
| Causes an object to fire a specified event.
|-
|
[[StoreCameraFacing | StoreCameraFacing ]]
| Stores the camera facing and position so it can be restored later.
|-
|
[[TakeArtifactItem | TakeArtifactItem ]]
|
Removes the item returned by [[GetArtifactItem | GetArtifactItem ]] from the player's inventory.
|-
|
[[TakeFetchItem | TakeFetchItem ]]
| Removes the plot related item from a player's inventory.
|}

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

Category:Miscellaneous Functions - Revision history

Xordac: 1 revision imported