CreateObject: Difference between revisions

From Onset Developer Wiki
No edit summary
No edit summary
Line 7: Line 7:
{{FuncParameters}}
{{FuncParameters}}
{{FuncParam|modelid|The [[Objects|model identifier]] for which object to spawn.}}
{{FuncParam|modelid|The [[Objects|model identifier]] for which object to spawn.}}
{{FuncParam|x|__EDIT_ME__}}
{{FuncParam|x|X coordinate}}
{{FuncParam|y|__EDIT_ME__}}
{{FuncParam|y|Y coordinate}}
{{FuncParam|z |__EDIT_ME__}}
{{FuncParam|z|Z coordinate}}
{{FuncParam|rx|__EDIT_ME__}}
{{FuncParamOptional|rx|Roll}}
{{FuncParam|ry|__EDIT_ME__}}
{{FuncParamOptional|ry|Pitch}}
{{FuncParam|rz|__EDIT_ME__}}
{{FuncParamOptional|rz|Yaw}}
{{FuncParam|sx|__EDIT_ME__}}
{{FuncParamOptional|sx|X scale}}
{{FuncParam|sy|__EDIT_ME__}}
{{FuncParamOptional|sy|Y scale}}
{{FuncParamOptional|sz|__EDIT_ME__}}
{{FuncParamOptional|sz|Z scale}}


{{FuncReturnValue|Returns an identifier to the new object. '''false''' on error.}}
{{FuncReturnValue|Returns an identifier to the new object. '''false''' on error.}}

Revision as of 13:55, 22 March 2019

CreateObject

Type: Function
Context: Server
Introduced: v1.0

Description

This function creates an object at a desired location. See Objects for a list of models.

Syntax

CreateObject(modelid, x, y, z [, rx, ry, rz, sx, sy, sz])

Parameters

  • modelid
    The model identifier for which object to spawn.
  • x
    X coordinate
  • y
    Y coordinate
  • z
    Z coordinate
  • rx (optional)
    Roll
  • ry (optional)
    Pitch
  • rz (optional)
    Yaw
  • sx (optional)
    X scale
  • sy (optional)
    Y scale
  • sz (optional)
    Z scale

Return Value

  • Returns an identifier to the new object. false on error.

Example

__EDIT_ME__

See also