SetObjectAttached: Difference between revisions

From Onset Developer Wiki
No edit summary
No edit summary
Line 6: Line 6:


{{FuncParameters}}
{{FuncParameters}}
{{FuncParam|object|__EDIT_ME__}}
{{FuncParam|object|The object identifier from [[CreateObject]].}}
{{FuncParam|attachtype|__EDIT_ME__}}
{{FuncParam|attachtype|[[AttachType]]}}
{{FuncParam|attachid|__EDIT_ME__}}
{{FuncParam|attachid|The identifier of the other entity you want to attach to.}}
{{FuncParam|x|__EDIT_ME__}}
{{FuncParam|x|Relative X location.}}
{{FuncParam|y|__EDIT_ME__}}
{{FuncParam|y|Relative Y location.}}
{{FuncParam|z |__EDIT_ME__}}
{{FuncParam|z|Relative Z location.}}
{{FuncParamOptional|rx|__EDIT_ME__}}
{{FuncParamOptional|rx|Relative pitch rotation.}}
{{FuncParamOptional|ry|__EDIT_ME__}}
{{FuncParamOptional|ry|Relative yaw rotation.}}
{{FuncParamOptional|rz|__EDIT_ME__}}
{{FuncParamOptional|rz|Relative roll rotation.}}
{{FuncParamOptional|SocketName|__EDIT_ME__}}
{{FuncParamOptional|SocketName|Socket where to attach to ([[PlayerBones]]). Can be empty.}}


{{FuncReturnValue|__EDIT_ME__}}
{{FuncReturnValue|Returns '''true''' on success.}}


== Example ==
== Example ==

Revision as of 18:24, 13 October 2019

SetObjectAttached

Type: Function
Context: Server
Introduced: v1.0

Description

__EDIT_ME__

Syntax

SetObjectAttached(object, attachtype, attachid, x, y, z [, rx, ry, rz, SocketName])

Parameters

  • object
    The object identifier from CreateObject.
  • attachtype
    AttachType
  • attachid
    The identifier of the other entity you want to attach to.
  • x
    Relative X location.
  • y
    Relative Y location.
  • z
    Relative Z location.
  • rx (optional)
    Relative pitch rotation.
  • ry (optional)
    Relative yaw rotation.
  • rz (optional)
    Relative roll rotation.
  • SocketName (optional)
    Socket where to attach to (PlayerBones). Can be empty.

Return Value

  • Returns true on success.

Example

__EDIT_ME__

See also

__EDIT_ME__