Ratchet

Appearance

Objects ​

This is a list of object structures (types), their member values and member functions.

Character ​

WARNING

This object cannot be directly constructed! Use references obtained from events or functions.

CharacterSheet ​

  • .name
  • .skills
  • .skillsAllocated
  • .skillsTotal
  • .stats
  • .statsCurrent
  • .statsMax
  • .perksActive
  • .perksCategories
  • .perksAssigned
  • .statuses
  • .buffs
  • .zones
  • .runes

WARNING

This object cannot be directly constructed! Use RPR.GetSheet to retrieve a valid instance.

ReduxAbility ​

  • .id
  • .name
  • .category
  • .range

WARNING

This object cannot be directly constructed! Use RPR.GetAbilities to retrieve a valid instance.

GUID ​

  • .A
  • .B
  • .C
  • .D

TIP

This object can be directly constructed using GUID() for a new random GUID.

Specific GUID can also be re-created using GUID(guidString) (A-B-C-D format) or using GUID(A,B,C,D) with all parts being integers. Try to prefer the former over the latter.

To convert GUID into a string format accepted by the constructor, use tostring(myGuid)

Color ​

  • .R
  • .G
  • .B
  • .A

TIP

This object can be directly constructed using Color(R,G,B,A) or Color(R,G,B) (non-transparent), all values have to be either 0-255 (int) or 0-1 (float).

You can also use single argument Lua hex integer like this: Color(0xFFCC00)

Vector ​

TIP

This object can be directly constructed using Vector() for an empty vector, or Vector(x,y,z) for an actual representation of position in 3D space. It can also be returned by various functions.

Rotator ​

  • .pitch
  • .yaw
  • .roll

TIP

Rotators can be constructed in the same way as Vectors.

Actor ​

Inventory ​

Item ​

Guild ​

BuildingPiece Actor Experimental ​

  • :GetLocation
  • :GetRotation
  • :GetTemplateID
  • :GetOwnerID
  • :GetOwnerName
  • :IsBuilding
  • :IsDoor
  • :IsHatch
  • :IsGate
  • :IsPortcullis
  • :SetOwner
  • :SetOwnerGuild
  • :IsOwner
  • :DropInventory
  • :GetMaster
  • :GetRoot
  • :IsLocked
  • :SetLocked
  • :IsRPLocked
  • :SetRPLocked
  • :GetRPKey
  • :SetRPKey
  • :IsOpen
  • :SetOpen
  • :HasAutoClose
  • :SetAutoClose
  • :GetAutoCloseTime
  • :SetAutoCloseTime
  • :Move
  • :MoveBuilding
  • :SerializeBuilding

DANGER

This functionality is unfinished, experimental, and dangerous. Only use it at your own risk and never on actual builds as it can easily destroy what you've built.

HitResult ​

  • .actor
  • .distance
  • .location
  • .normal

DatabaseConnection ​

WARNING

This object cannot be directly constructed! Use dbConnect to retrieve a valid instance.

TotZone Actor ​

TIP

This object can be directly constructed using TotZone constructor.

TotBasicNPC BuildingPiece Experimental ​

TIP

This object can be directly constructed using TotBasicNPC constructor.

TotPuppet Actor ​

TIP

This object can be directly constructed using TotPuppet constructor.

TotPuppetTag ​

  • .guid
  • .name
  • .color

TIP

This object can be directly constructed using TotPuppetTag( string name [, Color color ] ) with GUID being randomly generated. It can also be retrieved from GetTags method of a TotPuppet.

TotMapMarker ​

  • .guid
  • .name
  • .x
  • .y
  • .icon
  • .iconName

TotLight Actor Experimental ​

TotPoint Actor Experimental ​

TotPortal Actor Experimental ​

TotScriptContainer Actor Experimental ​

TotSpawner Actor Experimental ​

RPNoticeBoard BuildingPiece Experimental ​

  • :GetMessages
  • :AddMessage
  • :DeleteMessage
  • :ToggleSticky
  • :GetMaxMessages
  • :SetMaxMessages
  • :GetForceCharacterName
  • :SetForceCharacterName

RPPOI BuildingPiece Experimental ​

  • :ResetInspections
  • :AddEditor
  • :GetEditors
  • :IsHidden
  • :GetInspectResults
  • :GetDescription
  • :SetDescription
  • :GetIcon
  • :SetIcon
  • :GetInspectionDistance
  • :SetInspectionDistance
  • :GetSpotDistance
  • :SetSpotDistance
  • :GetCanAnyoneRemove
  • :SetCanAnyoneRemove
  • :GetIsDateHidden
  • :SetIsDateHidden
  • :GetCleanupDuration
  • :SetCleanupDuration
  • :GetRolls
  • :SetRolls

RPWaypoint BuildingPiece Experimental ​

  • :GetID
  • :GetName
  • :SetName
  • :GetWaypointLocation
  • :GetWaypointRotation
  • :IsEnabled
  • :SetEnabled
  • :IsHidden
  • :SetHidden
  • :IsShowOnMap
  • :SetShowOnMap
  • :IsClanHome
  • :IsCustomWormhole
  • :GetCategory
  • :SetCategory
  • :GetColor
  • :SetColor
  • :GetWormholeID
  • :SetWormholeID
  • :GetPreventCarry
  • :SetPreventCarry
  • :Save

KSVolume Actor ​

TIP

This object can be directly constructed using KSVolume constructor.