Wwise SDK 2018.1.11

Set the position of a game object. See AK::SoundEngine::SetPosition.

Supported by

Graphical User Interface.

Arguments

Name	Type	Description
gameObject *	integer	Game Object identifier.
position *	object	The 3D position to set for the game object.

(Required *)

Arguments Details

gameObject

description : Game Object identifier.
type : integer
minimum : 0
maximum : 18446744073709551615

position

type : object
description : The 3D position to set for the game object.

Name	Type	Description
orientationFront *	object	Orientation of the listener.
orientationTop *	object	Top orientation of the listener.
position *	object	Position of the listener

(Required *)

argsSchema / position / ...

orientationFront

type : object
description : Orientation of the listener.

Name	Type	Description
x *	number	X Position.
y *	number	Y Position.
z *	number	Z Position.

(Required *)

argsSchema / position / ...

orientationTop

type : object
description : Top orientation of the listener.

Name	Type	Description
x *	number	X Position.
y *	number	Y Position.
z *	number	Z Position.

(Required *)

argsSchema / position / ...

position

type : object
description : Position of the listener

Name	Type	Description
x *	number	X Position.
y *	number	Y Position.
z *	number	Z Position.

(Required *)

Examples :

Setting the position of a game object

Sets the position of "gameObject" to "position/position" with the provided orientation.

Arguments:

{
    "gameObject": 1122334, 
    "position": {
        "orientationFront": {
            "x": 100, 
            "y": 200, 
            "z": 0
        }, 
        "orientationTop": {
            "x": 0, 
            "y": 0, 
            "z": 200
        }, 
        "position": {
            "x": 5, 
            "y": 10, 
            "z": 100
        }
    }
}

Detailed JSON Schema

Arguments :

{
    "type": "object", 
    "properties": {
        "gameObject": {
            "description": "Game Object identifier.", 
            "type": "integer", 
            "minimum": 0, 
            "maximum": 18446744073709551615
        }, 
        "position": {
            "type": "object", 
            "description": "The 3D position to set for the game object.", 
            "properties": {
                "orientationFront": {
                    "type": "object", 
                    "description": "Orientation of the listener.", 
                    "properties": {
                        "x": {
                            "type": "number", 
                            "description": "X Position."
                        }, 
                        "y": {
                            "type": "number", 
                            "description": "Y Position."
                        }, 
                        "z": {
                            "type": "number", 
                            "description": "Z Position."
                        }
                    }, 
                    "required": [
                        "x", 
                        "y", 
                        "z"
                    ], 
                    "additionalProperties": false
                }, 
                "orientationTop": {
                    "type": "object", 
                    "description": "Top orientation of the listener.", 
                    "properties": {
                        "x": {
                            "type": "number", 
                            "description": "X Position."
                        }, 
                        "y": {
                            "type": "number", 
                            "description": "Y Position."
                        }, 
                        "z": {
                            "type": "number", 
                            "description": "Z Position."
                        }
                    }, 
                    "required": [
                        "x", 
                        "y", 
                        "z"
                    ], 
                    "additionalProperties": false
                }, 
                "position": {
                    "type": "object", 
                    "description": "Position of the listener", 
                    "properties": {
                        "x": {
                            "type": "number", 
                            "description": "X Position."
                        }, 
                        "y": {
                            "type": "number", 
                            "description": "Y Position."
                        }, 
                        "z": {
                            "type": "number", 
                            "description": "Z Position."
                        }
                    }, 
                    "required": [
                        "x", 
                        "y", 
                        "z"
                    ], 
                    "additionalProperties": false
                }
            }, 
            "required": [
                "orientationFront", 
                "orientationTop", 
                "position"
            ], 
            "additionalProperties": false
        }
    }, 
    "required": [
        "gameObject", 
        "position"
    ], 
    "additionalProperties": false
}

Options :

{
    "type": "object", 
    "properties": {}, 
    "additionalProperties": false
}

Response :

{
    "type": "object", 
    "properties": {}, 
    "additionalProperties": false
}

Document version : 1

このページはお役に立ちましたか？

サポートは必要ですか？

ご質問や問題、ご不明点はございますか？お気軽にお問い合わせください。

サポートページをご確認ください

あなたのプロジェクトについて教えてください。ご不明な点はありませんか。

プロジェクトを登録していただくことで、ご利用開始のサポートをいたします。

Wwiseからはじめよう

Arguments Details

Wwise SDK 2018.1.11

ak.soundengine.setPosition

Supported by

Arguments

Arguments Details

gameObject

position

orientationFront

orientationTop

position

Examples :

Setting the position of a game object

Arguments:

Detailed JSON Schema

Arguments :

Options :

Response :

このページはお役に立ちましたか？

サポートは必要ですか？

あなたのプロジェクトについて教えてください。ご不明な点はありませんか。