Sleepy E: Added reference number attribute

2018-07-31T23:15:10Z

Added reference number attribute

← Older revision		Revision as of 23:15, 31 July 2018
Line 2:		Line 2:
	\|parameters=		\|parameters=
	\|attributes=		\|attributes=
			{{sdk attribute row\|int \|reference_number \|Is passed to the callback to identify for which method call it is fired}}
	{{sdk attribute row\|int \|object_time \|Creation time to put on object (in unix time, seconds since UTC 00:00:00, 1 January 1970)}}		{{sdk attribute row\|int \|object_time \|Creation time to put on object (in unix time, seconds since UTC 00:00:00, 1 January 1970)}}
	{{sdk attribute row\|int \|object_user_id \|User id to put on object}}		{{sdk attribute row\|int \|object_user_id \|User id to put on object}}

Sleepy E: Copying over most of vp_object_add

2016-12-25T10:27:43Z

Copying over most of vp_object_add

New page

{{sdk method page|object_load|Load a new object, overriding user id and timestamp.
|parameters=
|attributes=
{{sdk attribute row|int |object_time |Creation time to put on object (in unix time, seconds since UTC 00:00:00, 1 January 1970)}}
{{sdk attribute row|int |object_user_id |User id to put on object}}
{{sdk attribute row|int |object_type |Type of object (0 - 3D Model, 2 - Particle emitter, 3 - Path object) }}
{{sdk attribute row|float |object_x |X coordinate}}
{{sdk attribute row|float |object_y |Y coordinate}}
{{sdk attribute row|float |object_z |Z coordinate}}
{{sdk attribute row|float |object_rotation_x |Rotation X axis}}
{{sdk attribute row|float |object_rotation_y |Rotation Y axis}}
{{sdk attribute row|float |object_rotation_z |Rotation Z axis}}
{{sdk attribute row|float |object_rotation_angle |Rotation angle in radians}}
{{sdk attribute row|float |object_yaw |Yaw angle in degrees (these are used instead of X,Y,Z axis when rotation angle is set to INFINITY)}}
{{sdk attribute row|float |object_pitch |Pitch angle in degrees}}
{{sdk attribute row|float |object_roll |Roll angle in degrees}}
{{sdk attribute row|string |object_model |Model}}
{{sdk attribute row|string |object_action |Action}}
{{sdk attribute row|string |object_description |Description}}
{{sdk attribute row|data |object_data |Data}}
|returncodes=
{{sdk return code row|not_in_world|Bot is not currently in a world}}
{{sdk return code row|not_allowed|Instance does not have the permission to load objects.}}
{{sdk return code row|database_error|Unspecified database error}}
|returnattributes=
{{sdk attribute row|int|object_id|Object id that was assigned to the new object}}
|behavior=
* Upon successful creation of an object, {{sdk event|OBJECT}} is triggered for those who have subscribed to it. See {{sdk method|event_set}}.
* If {{sdk attribute|object_rotation_angle}} is set to INFINITY then it will be stored as that in world. The euler angles will be not be converted to an equivalent axis-angle representation. See examples in {{sdk method|object_add}} for euler to axis-angle conversion code.
|caveats=
* Setting {{sdk attribute|object_user_id}} to 0 will not default it to the owner of the bot (it will be set to user id #0).
* Setting {{sdk attribute|object_time}} to 0 will not default it to current time (it will be set to unix time 0, that is 00:00:00, 1 January 1970).
|examples=
Load a street1.rwx object at 0X 0Y 0Z.
<syntaxhighlight lang="c">
void handle_object_load(VPInstance sdk, int rc, int ref)
{
if (rc)
printf("Couldn't load object (reason %d)\n", rc);
else
printf("Object loaded successfully!\n");
}

int main(int argc, const char* argv[])
{
//...

vp_callback_set(sdk, VP_CALLBACK_OBJECT_LOAD, handle_object_load);

vp_int_set(sdk, VP_OBJECT_TYPE, 0); // 3D Model
vp_int_set(sdk, VP_OBJECT_USER_ID, 1234); // Owner #1234
vp_int_set(sdk, VP_OBJECT_TIME, time(NULL) - 3600); // One hour ago
vp_float_set(sdk, VP_OBJECT_X, 0.0);
vp_float_set(sdk, VP_OBJECT_Y, 0.0);
vp_float_set(sdk, VP_OBJECT_Z, 0.0);
vp_float_set(sdk, VP_OBJECT_ROTATION_X, 0.0);
vp_float_set(sdk, VP_OBJECT_ROTATION_Y, 0.0);
vp_float_set(sdk, VP_OBJECT_ROTATION_Z, 0.0);
vp_float_set(sdk, VP_OBJECT_ROTATION_ANGLE, 0.0);
vp_string_set(sdk, VP_OBJECT_MODEL, "street1.rwx");
vp_string_set(sdk, VP_OBJECT_ACTION, "");
vp_string_set(sdk, VP_OBJECT_DESCRIPTION, "");

rc = vp_object_load(sdk);
if (rc)
printf("Couldn't load object (reason %d)\n", rc);

//...
}
</syntaxhighlight>
|seealso=
* {{sdk method|object_add}}
* {{sdk method|object_change}}
* {{sdk method|object_delete}}
* {{sdk callback|object_load}}
}}

Vp object load - Revision history

Sleepy E: Added reference number attribute

Sleepy E: Copying over most of vp_object_add