Skip to main content
Version: latest - a1.37.x โš–๏ธ

Base Pickable

Pickables are special Actors which can be grabbed, held and used by Characters.

info

This is a base class. You cannot spawn it directly.

Examples of Pickable Actors are: Weapon, Melee and Grenade.

They have special methods and events and are highlighted when looked at by a Character.

๐Ÿฆ ย Functionsโ€‹

ReturnsNameDescription
AddSkeletalMeshAttachedAttaches a Skeletal Mesh as master pose to this entity
AddStaticMeshAttachedAttaches a Static Mesh to this entity
PullUsePulls the usage of this Pickable (will start firing if this is a weapon)
ReleaseUseReleases the usage of this Pickable (will stop firing if this is a weapon)
RemoveSkeletalMeshAttachedRemoves, if it exists, a SkeletalMesh from this Pickable given its custom ID
RemoveStaticMeshAttachedRemoves, if it exists, a StaticMesh from this Pickable given its custom ID
SetAttachmentSettingsSets the Attachment Settings for this Pickable (how it attaches to the Character when Picking up)
SetCrosshairMaterialSets the crosshair material for this Pickable
SetPickableSets if this Pickable can be picked up from ground by the player
SkeletalMesh ReferenceGetMeshGets the name of the asset this Pickable uses
Character or nilGetHandlerGets the Character, if it exists, that's holding this Pickable

AddSkeletalMeshAttachedโ€‹

Spawns and attaches a SkeletalMesh to this Pickable, the SkeletalMesh must have the same skeleton used by this Actor's mesh, and will follow all animations from it. Uses a custom ID to be used for removing it later.

For customizing the Materials specific to a mesh attached with this function, use the following syntax as the parameter_name in the Base Paintable methods: attachable///[ATTACHABLE_ID]/[PARAMETER_NAME], where [ATTACHABLE_ID] is the ID of the Attachable, and [PARAMETER_NAME] is the name of the parameter you want to change.

my_pickable:AddSkeletalMeshAttached(id, skeletal_mesh_path)
TypeParameterDefaultDescription
stringidUnique ID to assign to the SkeletalMesh
SkeletalMesh Referenceskeletal_mesh_pathPath to SkeletalMesh asset to attach

AddStaticMeshAttachedโ€‹

Spawns and attaches a StaticMesh to this Pickable in a Socket with a relative location and rotation. Uses a custom ID to be used for removing it later

For customizing the Materials specific to a mesh attached with this function, use the following syntax as the parameter_name in the Base Paintable methods: attachable///[ATTACHABLE_ID]/[PARAMETER_NAME], where [ATTACHABLE_ID] is the ID of the Attachable, and [PARAMETER_NAME] is the name of the parameter you want to change.

my_pickable:AddStaticMeshAttached(id, static_mesh_path, socket?, relative_location?, relative_rotation?)
TypeParameterDefaultDescription
stringidUnique ID to assign to the StaticMesh
StaticMesh Referencestatic_mesh_pathPath to StaticMesh asset to attach
stringsocket?Bone socket to attach to
Vectorrelative_location?Vector(0, 0, 0)Relative location
Rotatorrelative_rotation?Rotator(0, 0, 0)Relative rotation

PullUseโ€‹

Pulls the usage of this Pickable (will start firing if this is a weapon)

my_pickable:PullUse(release_use_after?)
TypeParameterDefaultDescription
floatrelease_use_after?-1Time in seconds to automatically release the usage (-1 will not release, 0 will release one tick after)

ReleaseUseโ€‹

Releases the usage of this Pickable (will stop firing if this is a weapon)

my_pickable:ReleaseUse()

RemoveSkeletalMeshAttachedโ€‹

Removes, if it exists, a SkeletalMesh from this Pickable given its custom ID

my_pickable:RemoveSkeletalMeshAttached(id)
TypeParameterDefaultDescription
stringidUnique ID of the SkeletalMesh to remove

RemoveStaticMeshAttachedโ€‹

Removes, if it exists, a StaticMesh from this Pickable given its custom ID

my_pickable:RemoveStaticMeshAttached(id)
TypeParameterDefaultDescription
stringidUnique ID of the StaticMesh to remove

SetAttachmentSettingsโ€‹

Sets the Attachment Settings for this Pickable (how it attaches to the Character when Picking up)

my_pickable:SetAttachmentSettings(relative_location, relative_rotation?, socket?)
TypeParameterDefaultDescription
Vectorrelative_locationLocation relative to the Socket
Rotatorrelative_rotation?Rotator(0, 0, 0)Rotation relative to the Socket
stringsocket?hand_r_socketCharacter Socket to attach to when picked up

SetCrosshairMaterialโ€‹

Sets the crosshair material for this Pickable

my_pickable:SetCrosshairMaterial(material_asset)
TypeParameterDefaultDescription
Material Referencematerial_assetAsset path to the crosshair material

SetPickableโ€‹

Sets if this Pickable can be picked up from ground by the player

my_pickable:SetPickable(is_pickable)
TypeParameterDefaultDescription
booleanis_pickable

GetMeshโ€‹

Gets the name of the asset this Pickable uses

โ€” Returns SkeletalMesh Reference.

local ret = my_pickable:GetMesh()

GetHandlerโ€‹

Gets the Character, if it exists, that's holding this Pickable

โ€” Returns Character or nil.

local ret = my_pickable:GetHandler()

๐Ÿš€ย Eventsโ€‹

NameDescription
DropWhen a Character drops this Pickable
HitWhen this Pickable hits something
InteractTriggered when a Character interacts with this Pickable (i.e. tries to pick it up)
PickUpTriggered When a Character picks this up
PullUseTriggered when a Character presses the use button for this Pickable (i.e. clicks left mouse button with this equipped)
ReleaseUseTriggered when a Character releases the use button for this Pickable (i.e. releases left mouse button with this equipped)

Dropโ€‹

When a Character drops this Pickable
Pickable.Subscribe("Drop", function(self, character, was_triggered_by_player)

end)
TypeArgumentDescription
Base PickableselfThe Pickable which has been dropped
CharactercharacterThe Character that dropped it
booleanwas_triggered_by_playerIf the Player actively pressed the Drop binding to drop

Hitโ€‹

When this Pickable hits something
Pickable.Subscribe("Hit", function(self, impact_force, normal_impulse, impact_location, velocity)

end)
TypeArgumentDescription
Base PickableselfThe Actor that was hit
floatimpact_forceThe intensity of the hit normalized by the Pickable's weight
Vectornormal_impulseThe impulse direction of the hit
Vectorimpact_locationThe world space location of the impact
VectorvelocityThe Pickable's velocity at the moment it hit

Interactโ€‹

Triggered when a Character interacts with this Pickable (i.e. tries to pick it up)

Return false to prevent the interaction
Pickable.Subscribe("Interact", function(self, character)

end)
TypeArgumentDescription
Base PickableselfThe Pickable that just got interacted with
CharactercharacterThe Character that interacted with it

PickUpโ€‹

Triggered When a Character picks this up
Pickable.Subscribe("PickUp", function(self, character)

end)
TypeArgumentDescription
Base PickableselfThe Pickable that just got picked up
CharactercharacterThe Character that picked it up

PullUseโ€‹

Triggered when a Character presses the use button for this Pickable (i.e. clicks left mouse button with this equipped)
Pickable.Subscribe("PullUse", function(self, character)

end)
TypeArgumentDescription
Base PickableselfThe Pickable which has just been used
CharactercharacterThe Character that used it

ReleaseUseโ€‹

Triggered when a Character releases the use button for this Pickable (i.e. releases left mouse button with this equipped)
Pickable.Subscribe("ReleaseUse", function(self, character)

end)
TypeArgumentDescription
Base PickableselfThe Pickable which has just stopped being used
CharactercharacterThe Character that stopped using it

โž• Available Crosshairsโ€‹

nanos world provides a bunch of crosshair materials which can be used in Weapons/Pickables. You can of course create your own crosshair materialr and use those instead!

All available CrosshairsAll available Crosshairs

List of crosshair materials included in the default asset packโ€‹

  • nanos-world::MI_Crosshair_Circle
  • nanos-world::MI_Crosshair_Crossbow
  • nanos-world::MI_Crosshair_Dot
  • nanos-world::MI_Crosshair_Holo
  • nanos-world::MI_Crosshair_Launcher
  • nanos-world::MI_Crosshair_Regular
  • nanos-world::MI_Crosshair_Regular_X
  • nanos-world::MI_Crosshair_Rocket
  • nanos-world::MI_Crosshair_Separated_Triangle
  • nanos-world::MI_Crosshair_Shotgun
  • nanos-world::MI_Crosshair_Square
  • nanos-world::MI_Crosshair_Submachine
  • nanos-world::MI_Crosshair_Tee
  • nanos-world::MI_Crosshair_ThreeDots
  • nanos-world::MI_Crosshair_Triangle
  • nanos-world::MI_Crosshair_Vee