Skip to main content
Version: bleeding-edge 🩸

Base Pickable

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

🧑‍💻API Source
This page is auto-generated! The Functions, Properties and Events described here are defined in our GitHub's API Repository! Feel free to commit suggestions and changes to the source .json API files!
👪Base Class
This is a Base Class. Base Classes are abstract definitions used to share common methods and events between related child classes, thus you cannot spawn it directly.

Classes that share methods and events from this Base Class: Grenade, Melee, Weapon.

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
table of stringGetAllSkeletalMeshAttachedGets all Skeletal Meshes attached to this entity
table of stringGetAllStaticMeshAttachedGets all Static Meshes attached to this entity
Character or nilGetHandlerGets the Character, if it exists, that's holding this Pickable
HandlingModeGetHandlingModeGets the Handling Mode of this Pickable
SkeletalMesh ReferenceGetMeshGets the name of the asset this Pickable uses
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)
RemoveAllSkeletalMeshesAttachedRemoves all SkeletalMeshes attached
RemoveAllStaticMeshesAttachedRemoves all StaticMeshes attached
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
SetStaticMeshAttachedTransformSets a Static Mesh Attached location and rotation

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/customizing it afterwards

my_pickable:AddSkeletalMeshAttached(id, skeletal_mesh_path, use_parent_bounds?)
TypeParameterDefaultDescription
stringid Required parameter Used further for removing or applying material settings on it
SkeletalMesh Referenceskeletal_mesh_path Required parameter Path to SkeletalMesh asset to attach
booleanuse_parent_bounds?trueIf true, this component uses its parents bounds when attached. This can be a significant optimization with many components attached together

See also RemoveSkeletalMeshAttached.


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/customizing it afterwards

my_pickable:AddStaticMeshAttached(id, static_mesh_path, socket?, relative_location?, relative_rotation?, use_parent_bounds?)
TypeParameterDefaultDescription
stringid Required parameter Unique ID to assign to the StaticMesh
StaticMesh Referencestatic_mesh_path Required parameter Path 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
booleanuse_parent_bounds?trueIf true, this component uses its parents bounds when attached. This can be a significant optimization with many components attached together

See also SetStaticMeshAttachedTransform, RemoveStaticMeshAttached.


GetAllSkeletalMeshAttached

Gets all Skeletal Meshes attached to this entity

— Returns table of string (the key as the Attached ID, and the value as the Asset Path).

local ret = my_pickable:GetAllSkeletalMeshAttached()

GetAllStaticMeshAttached

Gets all Static Meshes attached to this entity

— Returns table of string (the key as the Attached ID, and the value as the Asset Path).

local ret = my_pickable:GetAllStaticMeshAttached()

GetHandler

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

— Returns Character or nil.

local ret = my_pickable:GetHandler()

GetHandlingMode

Gets the Handling Mode of this Pickable

— Returns HandlingMode.

local ret = my_pickable:GetHandlingMode()

GetMesh

Gets the name of the asset this Pickable uses

— Returns SkeletalMesh Reference.

local ret = my_pickable:GetMesh()

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()

RemoveAllSkeletalMeshesAttached

Removes all SkeletalMeshes attached

my_pickable:RemoveAllSkeletalMeshesAttached()

RemoveAllStaticMeshesAttached

Removes all StaticMeshes attached

my_pickable:RemoveAllStaticMeshesAttached()

RemoveSkeletalMeshAttached

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

my_pickable:RemoveSkeletalMeshAttached(id)
TypeParameterDefaultDescription
stringid Required parameter Unique ID of the SkeletalMesh to remove

See also AddSkeletalMeshAttached.


RemoveStaticMeshAttached

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

my_pickable:RemoveStaticMeshAttached(id)
TypeParameterDefaultDescription
stringid Required parameter Unique ID of the StaticMesh to remove

See also AddStaticMeshAttached.


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_location Required parameter Location 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_asset Required parameter Asset 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 Required parameter No description provided

SetStaticMeshAttachedTransform

Sets a Static Mesh Attached location and rotation

my_pickable:SetStaticMeshAttachedTransform(id, relative_location, relative_rotation)
TypeParameterDefaultDescription
stringid Required parameter Unique ID of the StaticMesh set with AddStaticMeshAttached
Vectorrelative_location Required parameter New relative location
Rotatorrelative_rotation Required parameter New relative rotation

See also AddStaticMeshAttached.

🚀 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)
-- Drop was called
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)
-- Hit was called
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)
-- Interact was called
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)
-- PickUp was called
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)
-- PullUse was called
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)
-- ReleaseUse was called
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