From b3d4024f21915be0ca89e28b099f783dfe1fe75e Mon Sep 17 00:00:00 2001 From: Applevangelist Date: Thu, 28 Apr 2022 17:10:26 +0200 Subject: [PATCH] Nicefy docs --- Moose Development/Moose/Core/Message.lua | 3 +++ Moose Development/Moose/Sound/UserSound.lua | 2 +- Moose Development/Moose/Wrapper/Positionable.lua | 2 +- 3 files changed, 5 insertions(+), 2 deletions(-) diff --git a/Moose Development/Moose/Core/Message.lua b/Moose Development/Moose/Core/Message.lua index 3e4731831..662a3926c 100644 --- a/Moose Development/Moose/Core/Message.lua +++ b/Moose Development/Moose/Core/Message.lua @@ -10,6 +10,8 @@ -- * Send message to all players. -- * Send messages to a coalition. -- * Send messages to a specific group. +-- * Send messages to a specific unit or client. +-- -- -- === -- @@ -35,6 +37,7 @@ -- -- * To a @{Client} using @{#MESSAGE.ToClient}(). -- * To a @{Wrapper.Group} using @{#MESSAGE.ToGroup}() +-- * To a @{Wrapper.Unit} using @{#MESSAGE.ToUnit}() -- * To a coalition using @{#MESSAGE.ToCoalition}(). -- * To the red coalition using @{#MESSAGE.ToRed}(). -- * To the blue coalition using @{#MESSAGE.ToBlue}(). diff --git a/Moose Development/Moose/Sound/UserSound.lua b/Moose Development/Moose/Sound/UserSound.lua index ecc437c34..b5669770d 100644 --- a/Moose Development/Moose/Sound/UserSound.lua +++ b/Moose Development/Moose/Sound/UserSound.lua @@ -144,7 +144,7 @@ do -- UserSound -- @return #USERSOUND The usersound instance. -- @usage -- local BlueVictory = USERSOUND:New( "BlueVictory.ogg" ) - -- local PlayerUnit = UNIT:FindByName( "PlayerUnit" ) -- Search for the active group named "PlayerUnit", that contains a human player. + -- local PlayerUnit = UNIT:FindByName( "PlayerUnit" ) -- Search for the active group named "PlayerUnit", a human player. -- BlueVictory:ToUnit( PlayerUnit ) -- Play the victory sound to the player unit. -- function USERSOUND:ToUnit( Unit, Delay ) diff --git a/Moose Development/Moose/Wrapper/Positionable.lua b/Moose Development/Moose/Wrapper/Positionable.lua index 8af77e1ac..8b37556e6 100644 --- a/Moose Development/Moose/Wrapper/Positionable.lua +++ b/Moose Development/Moose/Wrapper/Positionable.lua @@ -1279,7 +1279,7 @@ end -- @param #POSITIONABLE self -- @param #string Message The message text -- @param DCS#Duration Duration The duration of the message. --- @param Core.Set#SET_UNIT MessageSetGroup The SET_UNIT collection receiving the message. +-- @param Core.Set#SET_UNIT MessageSetUnit The SET_UNIT collection receiving the message. -- @param #string Name (optional) The Name of the sender. If not provided, the Name is the type of the Positionable. function POSITIONABLE:MessageToSetUnit( Message, Duration, MessageSetUnit, Name ) self:F2( { Message, Duration } )