Page tree
Skip to end of metadata
Go to start of metadata



This command / function is broken and / or unreliable in VBS4.

Introduced in

Version:1.54

Description

Description:Sets the object on whatever surface is directly below it. The object is placed in such a way that the bottom of the object is resting on the surface at the object initial [x, y] position, and the object is aligned with the surface it is rests on.

Syntax

Syntax:object call fn_vbs_placeOnSurface
Parameters:
  • object: Object - Object to place on the surface.
Return Value:Nothing

Warning

When using functions in VBS versions older than 3.4, certain limitations and requirements should be kept in mind - the main ones being that capitalization of the function name is crucial, and that #include "\vbs2\headers\function_library.hpp" has to be included in every script that utilizes it. More Category VBS Scripting Functions.

Examples

Examples:Place the object on the surface beneath the player:
#include "\vbs2\headers\function_library.hpp"
_obj setPos (getPos player);
_obj call fn_vbs_placeOnSurface;

Additional Information

See also:fn vbs underlyingSurface, placeOnSurface
Multiplayer:
Problems:

Notes






This function makes a call to fn_underlyingSurface and is essentially an extension of that function with additional code for setting the placement of the object.